tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

AssociateSecurityGroups

Last updated: 2024-12-04 11:18:55

    1. API Description

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

    This API is used to bind a security group to one or more database instances. When you create an instance without configuring a security group, it is recommended to bind a security group through this API.

    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: AssociateSecurityGroups.
    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.
    SecurityGroupId Yes String ID of the security group to be bound. Obtain it on the security group page of the console.
    InstanceIds.N Yes Array of String ID of the bound instance. Log in to the Redis console and copy it in the instance list. You can specify multiple instance IDs.

    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 request

    Input Example

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

{
    "Product": "redis",
    "SecurityGroupId": "sg-ajr1jzgj",
    "InstanceIds": [
        "crs-eb2w7dto"
    ]
}

    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.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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy