AssociateSecurityGroups

Last updated: 2021-10-12 17:20:36

1. API Description

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

This API (AssociateSecurityGroups) is used to bind security groups to instances in batches.

A maximum of 100 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-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
SecurityGroupId Yes String Security group ID.
InstanceIds.N Yes Array of String List of instance IDs, which is an array of one or more instance IDs.
ForReadonlyInstance No Boolean This parameter takes effect only when the IDs of read-only replicas are passed in. If this parameter is set to False or left empty, the security group will be bound to the RO groups of these read-only replicas. If this parameter is set to True, the security group will be bound to the read-only replicas themselves.

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 Binding security groups in batches

Input Example

https://cdb.tencentcloudapi.com/?Action=AssociateSecurityGroups
&SecurityGroupId=sg-ajr1jzgj
&InstanceIds.0=cdb-eb2w7dto
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "1a42feb9-82087f71-6a0031ac-699a92a8"
  }
}

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

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
AuthFailure CAM signature/authentication error.
InternalError.DatabaseAccessError Internal database error.
InternalError.DfwError Security group operation error.
InternalError.ResourceNotMatch The resource does not match.
InternalError.SecurityGroupError Security group error
InvalidParameter Parameter error.
OperationDenied Operation denied.