tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeResources

Last updated: 2024-09-05 19:29:30

    1. API Description

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

    This API is used to query the list of AZs and resources supported for the user in the current region.

    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: DescribeResources.
    Version Yes String Common Params. The value used for this API: 2018-03-17.
    Region No String Common Params. This parameter is not required for this API.
    Limit No Integer Number of returned AZ resources. Default value: 20. Maximum value: 100.
    Offset No Integer Starting offset of the returned AZ resource list. Default value: 0.
    Filters.N No Array of Filter Conditions for querying the list of availability zone resources. Detailed filter criteria are as follows:
  • master-zone -- String - Required: No - (Filter criterion) Filter by region type, such as ap-guangzhou-2.
  • ip-version -- String - Required: No - (Filter criterion) Filter by IP type. Valid values: IPv4, IPv6, IPv6_Nat.
  • isp -- String - Required: No - (Filter criterion) Filter by ISP type, such as BGP, CMCC, CUCC, and CTCC.
    		•

    3. Output Parameters

    Parameter Name Type Description
    ZoneResourceSet Array of ZoneResource List of resources supported by the AZ
    TotalCount Integer Number of entries in the AZ resource list.
    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 Querying the List of Supported Availability Zones and Resources in the Current Region for Users

    This example shows you how to query the list of supported availability zones and resources in the current region for users.

    Input Example

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



{
    "Limit": "20",
    "Offset": "0"
}

    Output Example

    {
    "Response": {
        "TotalCount": 3,
        "ZoneResourceSet": [
            {
                "LocalZone": false,
                "EdgeZone": false,
                "SlaveZone": null,
                "MasterZone": "ap-guangzhou-1",
                "IPVersion": "IPv4",
                "ZoneRegion": "ap-guangzhou",
                "ResourceSet": [
                    {
                        "Isp": "BGP",
                        "Type": [
                            "BGP"
                        ]
                    },
                    {
                        "Isp": "CMCC",
                        "Type": [
                            "CMCC"
                        ]
                    }
                ],
                "ZoneResourceType": "SHARED"
            }
        ],
        "RequestId": "d09b91ba-a81e-4ca3-b423-c64e60127c64"
    }
}

    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 Operation failed.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Duplicate Duplicate parameter value.
    InvalidParameterValue.InvalidFilter Incorrect Filter parameter.
    InvalidParameterValue.Length Wrong parameter length.
    InvalidParameterValue.Range Wrong parameter value range.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy