DeleteSecurityGroup

DeleteSecurityGroup

1. API Description

This API is used to delete a security group.

Note

  • Operations on security groups with instances in it are not supported. You can use DescribeSecurityGroups to query the status of the security group.

  • Only operations on security groups in the status of AVAILABLE or FAIL are supported.

  • Deleting is not supported for default security group.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

securityGroupId

Yes

String

Security group 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

Delete a security group.

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

Request:
{
  "securityGroupId": "your-security-group-id"
}

Response:
{
  "requestId": "T980F9D21-D7E4-4C6D-8B79-91A15861FB05",
  "response": {
    "requestId": "T980F9D21-D7E4-4C6D-8B79-91A15861FB05"
  }
}

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_SUPPORT

Operations on the security group with current status are not supported.

403

OPERATION_DENIED_SECURITY_GROUP_EXIST_INSTANCE

Operations on security groups with instances in it are not supported.

403

OPERATION_DENIED_SECURITY_GROUP_EXIST_PRE_PRODUCT_INSTANCE

Instance is being created.

403

OPERATION_DENIED_DEFAULT_SECURITY_GROUP_NOT_SUPPORT

Operations on the default security groups are not supported.

Last updated