DescribeDBSecurityGroups

Last updated: 2021-07-28 16:46:45

1. API Description

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

This API is used to query the security group details of an instance.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: redis.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: DescribeDBSecurityGroups.
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. For this API, its value is redis.
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
Groups Array of SecurityGroup Security group rules.
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=DescribeDBSecurityGroups
&InstanceId=crs-eb2w7dto
&Product=redis
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A1",
    "Groups": [
      {
        "Outbound": [],
        "SecurityGroupName": "CDB",
        "Inbound": [],
        "ProjectId": 0,
        "SecurityGroupId": "sg-ajr1jzgj",
        "SecurityGroupRemark": "",
        "CreateTime": "2017-04-13 15:00:06"
      }
    ]
  }
}

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.
InternalError.ExecHttpRequestError Failed to execute the HTTP request. Please try again later.
InternalError.ListInstancesError An error occurred while obtaining the instance list. Please try again later.
InternalError.NetWorkErr Network error
InvalidParameter.IllegalParameterError Invalid parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
ResourceNotFound.InstanceNotFound Instance not found.