tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeDBSecurityGroups

Last updated: 2024-04-03 11:32:47

    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 No String Common Params. This parameter is not required for this API.
    Product Yes String Database engine name, which is redis for this API.
    InstanceId Yes String ID of the specified instance, such as "crs-xjhsdj****" Log in to the Redis console and copy the instance ID in the instance list.

    3. Output Parameters

    Parameter Name Type Description
    Groups Array of SecurityGroup Security group rules
    VIP String Private IPv4 address of an instance
    VPort String Private network port
    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

    This example shows you how to query the security group information of a specified instance.

    Input Example

    POST / HTTP/1.1Host: redis.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeDBSecurityGroups<Common request parameters>{    "Product": "redis",    "InstanceId": "crs-m1kxvlkf"}

    Output Example

    {
    "Response": {
        "Groups": [
            {
                "CreateTime": "2023-04-26 17:40:29",
                "Inbound": [
                    {
                        "Action": "ACCEPT",
                        "AddressModule": "",
                        "CidrIp": "106.55.103.75",
                        "Desc": "",
                        "Id": "",
                        "IpProtocol": "tcp",
                        "PortRange": "8000",
                        "ServiceModule": ""
                    },
                    {
                        "Action": "ACCEPT",
                        "AddressModule": "",
                        "CidrIp": "119.147.10.191",
                        "Desc": "bro-local public network IP",
                        "Id": "",
                        "IpProtocol": "tcp",
                        "PortRange": "8000",
                        "ServiceModule": ""
                    },
                    {
                        "Action": "ACCEPT",
                        "AddressModule": "",
                        "CidrIp": "43.136.90.27",
                        "Desc": "CVM-public network",
                        "Id": "",
                        "IpProtocol": "tcp",
                        "PortRange": "8000",
                        "ServiceModule": ""
                    }
                ],
                "Outbound": [],
                "ProjectId": 0,
                "SecurityGroupId": "sg-7y0pa6nf",
                "SecurityGroupName": "test_lb",
                "SecurityGroupRemark": "custom"
            }
        ],
        "RequestId": "d6b8d050-f113-4db3-a85e-ca8122deddce",
        "VIP": "10.0.4.13",
        "VPort": "6379"
    }
}

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