tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for MySQLSecurity APIsModifyDBInstanceSecurityGroups
ModifyDBInstanceSecurityGroups
Last updated: 2024-11-20 11:12:20
ModifyDBInstanceSecurityGroups
Last updated: 2024-11-20 11:12:20

1. API Description

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

This API (ModifyDBInstanceSecurityGroups) is used to modify the security groups bound to a TencentDB 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: 2017-03-20.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page.
SecurityGroupIds.N Yes Array of String List of IDs of security groups to be modified, which is an array of one or more security group IDs.
ForReadonlyInstance No Boolean This parameter takes effect only when the ID of read-only replica is passed in. If this parameter is set to False or left empty, the security groups bound with the RO group of the read-only replicas will be modified. If this parameter is set to True, the security groups bound with the read-only replica itself will be modified.

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 Modifying the security groups bound to a TencentDB instance

Input Example

https://cdb.intl.tencentcloudapi.com/?Action=ModifyDBInstanceSecurityGroups
&InstanceId=cdb-eb2w7dto
&SecurityGroupIds.0=sg-ajr1jzgj
&<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.DfwError Security group operation error.
InternalError.ResourceNotUnique The resource is not unique.
InternalError.SecurityGroupError Security group error
InvalidParameter Parameter error.
InvalidParameter.ControllerNotFoundError This API was not found.
InvalidParameter.InstanceNotFound The instance does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support