tencent cloud

All product documents
APIs
DocumentationAPIsTencentDB for Redis®Other APIsModifyDBInstanceSecurityGroups
ModifyDBInstanceSecurityGroups
Last updated: 2024-12-04 11:18:52
ModifyDBInstanceSecurityGroups
Last updated: 2024-12-04 11:18:52

1. API Description

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

This API is used to modify the original security group list of an 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: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
Product Yes String Database engine name, which is redis for this API.
SecurityGroupIds.N Yes Array of String Security group ID list. Replace it with a new one, which is an array of one or more security group IDs.
- To configure a security group for an instance for the first time, bind the security group through the API AssociateSecurityGroups first.
- To replace the security group, obtain the security group ID on the security group page of the console.
InstanceId Yes String Instance ID. Log in to the Redis console and copy it in the instance list.

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 Sample

Input Example

POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDBInstanceSecurityGroups
<Common request parameters>

{
    "InstanceId": "crs-eb2w7dto",
    "Product": "redis",
    "SecurityGroupIds": [
        "sg-ajr1jzgj"
    ]
}

Output Example

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

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.AddInstanceInfoFailed Failed to add the security group information of the instance.
FailedOperation.AssociateSecurityGroupsFailed Failed to associate the security group.
FailedOperation.ClearInstanceInfoFailed Failed to clear the security group information of the instance.
FailedOperation.DisassociateSecurityGroupsFailed Failed to unbind the security group.
FailedOperation.GetSecurityGroupDetailFailed Failed to query the security group details. Try again later.
FailedOperation.SetRuleLocationFailed Failed to set the rule.
FailedOperation.UpdateInstanceInfoFailed Failed to update the security group information of the instance.
FailedOperation.UpdateSecurityGroupsFailed Failed to update the security group.
InternalError.InstanceOperatePermissionError You do not have the operation permission.
InternalError.ListInstancesError An error occurred while obtaining the list of instances. Try again later.
InvalidParameter.InstanceSGOverLimitError The security groups of the instance exceeds the limit.
InvalidParameter.NotSupported The operation is unsupported due to incorrect parameters.
InvalidParameter.PermissionDenied The API has no CAM permissions.
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