ModifySecurityGroupsAttribute

ModifySecurityGroupsAttribute

1. API Description

The API is used to modify the attributes of one or more security groups. Only the security group name to be displayed can be modified for now.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
securityGroupIds	Yes	Array of String	Security group ID(s). To obtain the security group IDs, you can call DescribeSecurityGroups and look for securityGroupId in the response. The maximum number of security groups in each request is 100.
securityGroupName	Yes	String	Security group name to be displayed. This parameter can contain up to 64 characters. Only letters, numbers, - and periods (.) are supported.
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.

4. Code Example

Example

Modify security group names in batches.

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

Request:
{
  "securityGroupIds": [
    "791721259766392536"
  ],
  "securityGroupName": "abc12345",
  "description": "123456"
}

Response:
{
  "requestId": "T27931ABC-1856-4928-9B82-D80C56DD4DBA",
  "response": {
    "requestId": "T27931ABC-1856-4928-9B82-D80C56DD4DBA"
  }
}

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
403	OPERATION_DENIED_SECURITY_GROUP_STATUS_NOT_AVAILABLE	Operations on the security group with current status are not supported.
404	INVALID_SECURITY_GROUP_NOT_FOUND	Security group not found.
403	OPERATION_DENIED_DEFAULT_SECURITY_GROUP_NOT_SUPPORT	Operations on the default security groups are not supported.