tencent cloud

文档反馈

DescribeDBSecurityGroups

最后更新时间:2022-11-01 10:38:13

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.

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: DescribeDBSecurityGroups.
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.
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
VIP String Private IP for which the security group takes effect
VPort String Private port for which the security group takes effect
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

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

{
    "InstanceId": "crs-eb2w7dto",
    "Product": "redis"
}

Output Example

{
    "Response": {
        "VIP": "10.10.0.1",
        "VPort": 6379,
        "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A1",
        "Groups": [
            {
                "Outbound": [],
                "SecurityGroupName": "Redis security group",
                "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 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.
InternalError.CamAuthOssResponseReturnCodeError A CAM authentication error occurred.
InternalError.ExecHttpRequestError Failed to execute the HTTP request. Try again later.
InternalError.ListInstancesError An error occurred while obtaining the list of instances. Try again later.
InternalError.NetWorkErr A network error occurred.
InvalidParameter.ActionNotFound The corresponding API was not found.
InvalidParameter.IllegalParameterError Invalid parameter.
InvalidParameter.PermissionDenied The API has no CAM permissions.
ResourceNotFound.InstanceNotFound The instance was not found.
联系我们

联系我们,为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持