tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeProxyCustomConf

Last updated: 2024-01-30 10:26:15

    1. API Description

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

    This API is used to query the proxy configuration.

    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: DescribeProxyCustomConf.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID
    Offset No Integer Paginated query offset
    Limit No Integer Maximum entries returned per page

    3. Output Parameters

    Parameter Name Type Description
    Count Integer Number of queried proxy configurations
    Note: this field may return null, indicating that no valid value can be found.
    CustomConf CustomConfig Proxy configuration details
    Note: this field may return null, indicating that no valid value can be found.
    WeightRule Rule Weight rule
    Note: this field may return null, indicating that no valid value can be found.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the configuration of database proxy

    Input Example

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

{
    "InstanceId": "xx",
    "Limit": 1,
    "Offset": 0
}

    Output Example

    {
    "Response": {
        "Count": 3,
        "CustomConf": [
            {
                "Cpu": 2,
                "Device": "Z3",
                "DeviceType": "custom",
                "Memory": 4000,
                "Type": "High-Availability Edition"
            },
            {
                "Cpu": 4,
                "Device": "Z3",
                "DeviceType": "custom",
                "Memory": 8000,
                "Type": "High-Availability Edition"
            },
            {
                "Cpu": 8,
                "Device": "Z3",
                "DeviceType": "custom",
                "Memory": 16000,
                "Type": "High-Availability Edition"
            }
        ],
        "RequestId": "9bd2a785-2dc0-47dc-b285-2b154a218ea1",
        "WeightRule": [
            {
                "LessThan": 2000,
                "Weight": 1
            },
            {
                "LessThan": 8000,
                "Weight": 2
            },
            {
                "LessThan": 16000,
                "Weight": 4
            },
            {
                "LessThan": 32000,
                "Weight": 8
            },
            {
                "LessThan": 48000,
                "Weight": 10
            },
            {
                "LessThan": 64000,
                "Weight": 12
            },
            {
                "LessThan": 96000,
                "Weight": 14
            },
            {
                "LessThan": 128000,
                "Weight": 16
            },
            {
                "LessThan": 192000,
                "Weight": 24
            },
            {
                "LessThan": 256000,
                "Weight": 30
            },
            {
                "LessThan": 488000,
                "Weight": 50
            },
            {
                "LessThan": 690000,
                "Weight": 75
            },
            {
                "LessThan": -1,
                "Weight": 100
            }
        ]
    }
}

    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
    InternalError.UnknownError Unknown error
    ResourceNotFound.InstanceNotFundError The instance does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy