tencent cloud

APIs

문서APIsTDSQL-C for MySQLOther APIsModifyDBInstanceSecurityGroups

ModifyDBInstanceSecurityGroups

다운로드
포커스 모드
폰트 크기
마지막 업데이트 시간: 2026-05-29 10:55:07

1. API Description

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.

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 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 (cynosdbmysql-grp- prefix at the beginning) or Cluster id (such as cynosdbmysql-xxxxxxxx prefix). When configuring security group with instance IP address triplet (UniqVpcId, Vip, Vport), this field must be set to Cluster id (such as 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.
Note: This input will perform a full replacement of the existing collection, not an incremental update. The modification requires the expected full collection.

Zone No String

AZ.

UniqVpcId No String

ID of the VPC network for instance ownership. (UniqVpcId, Vip, and Vport must be specified simultaneously to uniquely identify the network instance)

Vip No String

Instance IP address, instance IP address triplet (UniqVpcId, Vip, and Vport). These three parameters must be specified simultaneously for unique identification of network instances.

Vport No Integer

Instance port, instance IP address triplet (UniqVpcId, Vip, and Vport). These three parameters must be specified simultaneously for unique identification of network instances.

3. Output Parameters

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.

4. Example

Example1 Modify the Security Groups Bound to an Instance

This example shows you how to modify the security group that an instance is bound to.

Input Example

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"
}

Output Example

{
    "Response": {
        "RequestId": "48fa5cf5-77db-4e32-90ef-22c71ed95f51"
    }
}

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
FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
InternalError.ListInstanceFailed Failed to query instances by security group.
InternalError.QueryDatabaseFailed Failed to query the database.
InvalidParameterValue.InstanceNotFound The instance does not exist.
InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
UnauthorizedOperation.PermissionDenied CAM authentication failed.

도움말 및 지원

문제 해결에 도움이 되었나요?

피드백