Domain name for API request: cynosdb.intl.tencentcloudapi.com.
This API is used to modify the security group bound to the instance.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: ModifyDBInstanceSecurityGroups. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-07. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo. |
| InstanceId | Yes | String | Network Group id (starting with cynosdbmysql-grp- prefix) or Cluster id (for example, starting with cynosdbmysql-xxxxxxxx prefix). When configuring a security group using the instance IP address 3-tuple (UniqVpcId, Vip, Vport), this field must be set to the Cluster id (for example, starting with cynosdbmysql-xxxxxxxx prefix). |
| SecurityGroupIds.N | Yes | Array of String | List of security group IDs to modify, an array of one or more security group IDs. |
| Zone | No | String | AZ. |
| UniqVpcId | No | String | VPC network ID of the instance (UniqVpcId, Vip, and Vport must be specified simultaneously to uniquely identify the network instance) |
| Vip | No | String | Instance IP address. The 3-tuple of instance IP address (UniqVpcId, Vip, and Vport) must be specified simultaneously to uniquely identify the network instance |
| Vport | No | Integer | Instance port, instance IP address 3-tuple (UniqVpcId, Vip, and Vport) must be specified simultaneously to uniquely identify a network instance |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Modify the security group bound to an instance
POST / HTTP/1.1
Host: cynosdb.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceSecurityGroups
<Common request parameters>
{
"InstanceId": "cynosdbmysql-j8ynfcpgj",
"SecurityGroupIds": [
"sg-mnbv"
],
"Zone": "ap-guangzhou-3"
}{
"Response": {
"RequestId": "48fa5cf5-77db-4e32-90ef-22c71ed95f51"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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.OperationFailedError | Operation failed. Try again later. If the issue persists, contact customer service. |
| InternalError.ListInstanceFailed | Failed to query the instance in the security group. |
| InternalError.QueryDatabaseFailed | Query database failed. |
| InvalidParameterValue.InstanceNotFound | The instance does not exist. |
| InvalidParameterValue.InvalidParameterValueError | Parameter value is invalid. |
| UnauthorizedOperation.PermissionDenied | CAM authentication failed. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback