PrevNext
search by keyword

Recent Pages

Documentation
TencentDB for Redis
    Documentation
    Download PDF

    ModifyDBInstanceSecurityGroups

    Last updated: 2022-01-23 11:20:05
    Download PDF

    1. API Description

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

    This API is used to modify the security groups associated with 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.
    This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: ModifyDBInstanceSecurityGroups.
    Version Yes String Common parameter. The value used for this API: 2018-04-12.
    Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
    Product Yes String Database engine name: mariadb, cdb, cynosdb, dcdb, redis, mongodb, etc.
    SecurityGroupIds.N Yes Array of String The ID list of the security groups to be modified, which is an array of one or more security group IDs.
    InstanceId Yes String Instance ID in the format of cdb-c1nl9rpv or cdbro-c1nl9rpv. It is the same as the instance ID displayed in the TencentDB Console.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Sample

    Input Example

    https://redis.tencentcloudapi.com/?Action=ModifyDBInstanceSecurityGroups
&InstanceId=crs-eb2w7dto
&SecurityGroupIds.0=sg-ajr1jzgj
&Product=redis
&<Common request parameters>

    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 an instance.
    FailedOperation.AssociateSecurityGroupsFailed Failed to associate the security group.
    FailedOperation.ClearInstanceInfoFailed Failed to clear the security group information of an instance.
    FailedOperation.DisassociateSecurityGroupsFailed Failed to unassociate the security group.
    FailedOperation.GetSecurityGroupDetailFailed Failed to query the security group details. Please try again later.
    FailedOperation.SetRuleLocationFailed Failed to set a rule.
    FailedOperation.UpdateInstanceInfoFailed Failed to update the security group information of an instance.
    InternalError.ListInstancesError An error occurred while obtaining the instance list. Please try again later.
    tencent
    Copyright © 2013-2022 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy