AssociateSecurityGroups

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-10-27 15:54:22

Download PDF

1. API Description

Domain name for API request: cvm.tencentcloudapi.com.

This API is used to associate security groups with specified instances.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: AssociateSecurityGroups.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
SecurityGroupIds.N	Yes	Array of String	ID of the security group to be associated, such as `sg-efil73jd`. Only one security group can be associated.
InstanceIds.N	Yes	Array of String	ID of the instance bound in the format of ins-lesecurk. You can specify up to 100 instances in each request.

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. Example

Example1 Associating multiple instances with one security group

Input Example

GET https://cvm.tencentcloudapi.com/?Action=AssociateSecurityGroups
&InstanceIds.0=ins-2zvpghhc
&InstanceIds.1=ins-915zrb0p
&SecurityGroupIds.0=sg-9id3l839
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "3385dcf2-e1f0-4ed8-a924-c296721ab65f"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

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

Error Code	Description
FailedOperation.SecurityGroupActionFailed	Security group operation failed.
InvalidInstanceId.Malformed	Invalid instance `ID`. The specified instance `ID` has an invalid format. For example, `ins-1122` has an invalid `ID` length.
InvalidInstanceId.NotFound	No instance found.
InvalidParameterValue.LimitExceeded	The number of parameter values exceeds the limit.
InvalidSecurityGroupId.NotFound	The specified `security group ID` does not exist.
InvalidSgId.Malformed	The specified `security group ID` is in the wrong format. For example, `sg-ide32` has an invalid `instance ID` length.
LimitExceeded.AssociateUSGLimitExceeded	An instance can be bound with up to 5 security groups.
LimitExceeded.CvmsVifsPerSecGroupLimitExceeded	The CVM ENIs associated with the security group has exceeded the limit.
LimitExceeded.SingleUSGQuota	The number of security groups exceeds the quota limit.
MutexOperation.TaskRunning	An identical job is running.
OperationDenied.InstanceOperationInProgress	The instance has an operation in progress. Please try again later.
SecGroupActionFailure	A general error occurred during the security group service API call.
UnsupportedOperation.InstanceStateIsolating	Unable to isolate: the instance is isolated

Recent Pages