tencent cloud

PrevNext

피드백

키워드를 검색하세요

Recent Pages

문서
문서

DescribeDBSecurityGroups

마지막 업데이트 시간:2024-07-19 14:30:51

    1. API Description

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

    This API is used to query the security group information of 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.

    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-11.
    Region No String Common Params. This parameter is not required for this API.
    Product Yes String Database engine name. Valid value: dcdb.
    InstanceId Yes String Instance ID

    3. Output Parameters

    Parameter Name Type Description
    Groups Array of SecurityGroup Security group details
    VIP String Instance VIP
    Note: This field may return null, indicating that no valid values can be obtained.
    VPort String Instance Port
    Note: This field may return null, indicating that no valid value can be obtained.
    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 Example 1. Querying the security group information of an instance

    Input Example

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

{
    "InstanceId": "tdsqlshard-eb2w7dto",
    "Product": "dcdb"
}

    Output Example

    {
    "Response": {
        "VIP": "10.0.0.7",
        "VPort": 3306,
        "RequestId": "31a60135-7057-47ae-8fd3-7a0617deca38",
        "Groups": [
            {
                "ProjectId": 0,
                "CreateTime": "",
                "Inbound": [
                    {
                        "Action": "",
                        "CidrIp": "",
                        "PortRange": "",
                        "IpProtocol": ""
                    }
                ],
                "Outbound": [
                    {
                        "Action": "",
                        "CidrIp": "",
                        "PortRange": "",
                        "IpProtocol": ""
                    }
                ],
                "SecurityGroupId": "",
                "SecurityGroupName": "",
                "SecurityGroupRemark": "dcdb"
            }
        ]
    }
}

    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
    AuthFailure CAM signature/authentication error
    FailedOperation.AuthNoStrategy Authentication failed.
    FailedOperation.GetSecurityGroupDetailFailed Failed to query the security group details
    InternalError.GetSecurityGroupDetailFailed Failed to query security group details.
    InternalError.InstanceOperatePermissionError You have no permission to operate this instance.
    InternalError.ListInstanceRespResourceCountNotMatchError The number of resources returned is inconsistent with the number specified in the request of querying instance information.
    InternalError.ListInstancesError An error occurred when querying instance information.
    InternalError.QueryDatabaseFailed An error occurred when reading data from the database.
    InternalError.ReadDatabaseFailed An error occurred when reading data from the database.
    InternalError.RouteNotFound Route not found.
    InvalidParameter Parameter error.
    InvalidParameter.IllegalParameterError Invalid parameters.
    InvalidParameter.InstanceNotFound Failed to find the requested instance.
    InvalidParameter.PermissionDenied You have no permission to manipulate this API or resource.
    InvalidParameterValue.InvalidParameterValueError Parameter input error
    ResourceNotFound.InstanceNotFound The instance doesn’t exist.
    ResourceNotFound.ProductConfigNotExistedError Failed to find the configuration of the product associated with the security group.
    ResourceUnavailable.InstanceStatusAbnormal Incorrect database instance status. Operations are not allowed.
    UnauthorizedOperation.PermissionDenied You have no permission to manipulate this API or resource.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    개인정보 처리방침서비스 약관쿠키 정책