AssociateSecurityGroupInstance

AssociateSecurityGroupInstance

1. API Description

This API is used to apply a security group on an instance.

Note

• Status of security group should be Available.

• Status of instance should be RUNNING or STOPPED.

• You can apply at most 2 security groups on an instance.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
securityGroupId	Yes	String	Security group ID.
instanceId	Yes	String	Instance ID.

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.

4. Code Example

Example

Apply a security group on an instance.

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

Request:
{
  "securityGroupId": "your-security-group-id",
  "instanceId": "your-instance-id"
}

Response:
{
  "requestId": "T1B80EBC3-7C55-48CC-910C-345D79B795DB",
  "response": {
    "requestId": "T1B80EBC3-7C55-48CC-910C-345D79B795DB"
  }
}

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
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.
404	INVALID_INSTANCE_NOT_FOUND	Instance does not exist.
403	OPERATION_DENIED_INSTANCE_STATUS	Operations on the instance with current status are not supported.
403	OPERATION_DENIED_INSTANCE_SECURITY_GROUP_EXCEED_LIMIT	Quantity of security groups applied in an instance exceeds the limit.
403	OPERATION_DENIED_INSTANCE_NOT_SUPPORT_SECURITY_GROUP	Instance not support security groups.