AuthorizeSecurityGroupRules

AuthorizeSecurityGroupRules

1. API Description

This API is used to add security group rules.

Note

  • Status of security group should be Available.

  • Rules cannot be duplicated in one rule direction.

  • The upper limit of quantity of security group rules is 40, including 20 inbound rules and 20 outbound rules.

  • Editing is not supported for default security group.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter NameRequiredTypeDescription

securityGroupId

Yes

String

Security group ID.

ruleInfos

Yes

Array of RuleInfo

Security group rules.

3. Output Parameters

Parameter NameTypeDescription

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Add security group rules.

POST /api/v2/vm HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: AuthorizeSecurityGroupRules
<Common Request Params>

Request:
{
  "securityGroupId": "your-security-group-id",
  "ruleInfos": [
    {
      "direction": "ingress",
      "policy": "accept",
      "priority": 3,
      "ipProtocol": "tcp",
      "portRange": "22/22",
      "cidrIp": "0.0.0.0/0"
    }
  ]
}

Response:
{
  "requestId": "T193B3359-B718-4BA4-A633-5865A2C63ABA",
  "response": {
    "requestId": "T193B3359-B718-4BA4-A633-5865A2C63ABA"
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status CodeError CodeDescription

400

INVALID_PARAMETER_SECURITY_GROUP_RULE_ID_NOT_ALLOW

Security group rule ID is not allowed to be passed in.

400

INVALID_PARAMETER_SECURITY_GROUP_POLICY

Invalid value of policy.

400

INVALID_PARAMETER_SECURITY_GROUP_PORT_RANGE

Invalid value of portRange.

400

INVALID_PARAMETER_SECURITY_GROUP_PRIORITY

Invalid value of priority.

400

INVALID_PARAMETER_SECURITY_GROUP_SOURCE_CIDR_IP

Invalid value of source cidrIp.

403

OPERATION_DENIED_SECURITY_GROUP_EXIST_REPEAT_RULE

Duplicated security group rules.

404

INVALID_SECURITY_GROUP_NOT_FOUND

Security group does not exist.

403

OPERATION_DENIED_SECURITY_GROUP_STATUS_NOT_AVAILABLE

Status of security group should be Available.

403

OPERATION_DENIED_SECURITY_GROUP_RULE_EXCEED_LIMIT

Rule quantity exceeds limit.

403

OPERATION_DENIED_DEFAULT_SECURITY_GROUP_NOT_SUPPORT

Operations on the default security groups are not supported.

Last updated