Last updated: 2022-01-19 11:36:17

1. API Description

Domain name for API request:

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

A maximum of 100 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: DescribeDBSecurityGroups.
Version Yes String Common parameter. The value used for this API: 2017-03-20.
Region Yes String Common parameter. 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.
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 replica will be queried. If this parameter is set to True, the security groups bound with the read-only replica itself will be queried.

3. Output Parameters

Parameter Name Type Description
Groups Array of SecurityGroup Security group details.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying the security group information of an instance

Input Example
&<Common request parameters>

Output Example

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

5. Developer Resources


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.
CdbError Backend or process error.
InternalError.DBOperationError Database operation failed.
InternalError.DatabaseAccessError Internal database error.
InternalError.DfwError Security group operation error.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InternalError.InternalServiceErrorErr An error occurred while accessing internal service.
InternalError.ResourceNotUnique The resource is not unique.
InternalError.SecurityGroupError Security group error
InternalError.UnknownError Unknown error
InvalidParameter Parameter error.
OperationDenied Operation denied.