CreateSecurityGroup

CreateSecurityGroup

1. API Description

This API is used to create a security group.

Note

• Security group quota is limited. If you need more, please contact Zenlayer Support.

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

• Rules cannot be duplicated in one rule direction.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
securityGroupName	Yes	String	Security group name to be displayed. This parameter can contain up to 64 characters. Only letters, numbers, - and periods (.) are supported.
ruleInfos	No	Array of RuleInfo	Security group rules.
description	No	String	Security group description. This parameter must contain 2 to 255 characters.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
securityGroupId	String	Security group ID.

4. Code Example

Example

Create a security group.

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

Request:
{
  "securityGroupName": "test123",
  "ruleInfos": [
    {
      "direction": "ingress",
      "policy": "accept",
      "priority": 2,
      "ipProtocol": "tcp",
      "portRange": "22/22",
      "cidrIp": "0.0.0.0/0"
    }
  ],
  "description": "123456"
}

Response:
{
  "requestId": "TA851AB85-577F-41BE-8E76-68171F021E36",
  "response": {
    "requestId": "TA851AB85-577F-41BE-8E76-68171F021E36",
    "securityGroupId": "your-security-group-id"
  }
}

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 Code	Error Code	Description
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.
403	OPERATION_DENIED_SECURITY_GROUP_RULE_EXCEED_LIMIT	Rule quantity exceeds limit.
403	OPERATION_DENIED_SECURITY_GROUP_TEAM_EXCEED_LIMIT	Security group quantity exceeds limit.