DescribeResources

Download PDF

Last updated: 2025-11-25 10:11:05

DescribeResources

Last updated: 2025-11-25 10:11:05

Download PDF

1. API Description

Domain name for API request: clb.intl.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	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
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	Specifies the conditions for querying the availability zone resource list. detailed filter criteria are as follows:. - master-zone Filters by regional availability zone, for example: ap-guangzhou-2. Type: String. Required: No - ip-version Filter by [IP type], such as IPv4. Type: String. Required: No Valid values: IPv4, IPv6, IPv6_Nat. - isp Filters by [ISP type], for example: BGP. Type: String. Required: No Optional. valid values: BGP, CMCC (china mobile), CUCC (china unicom), CTCC (china telecom), BGP_PRO, INTERNAL (private network).

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.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResources
<Common request parameters>

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

Output Example

{
    "Response": {
        "ZoneResourceSet": [
            {
                "MasterZone": "ap-guangzhou",
                "SlaveZone": null,
                "IPVersion": "IPv6",
                "ResourceSet": [
                    {
                        "Isp": "BGP",
                        "Type": [
                            "BGP"
                        ],
                        "TypeSet": [],
                        "AvailabilitySet": []
                    }
                ],
                "ZoneRegion": "ap-guangzhou",
                "LocalZone": false,
                "EdgeZone": false,
                "ZoneResourceType": "SHARED",
                "Egress": "center_egress1"
            },
            {
                "MasterZone": "ap-guangzhou",
                "SlaveZone": null,
                "IPVersion": "IPv6_Nat",
                "ResourceSet": [
                    {
                        "Isp": "BGP",
                        "Type": [
                            "BGP"
                        ],
                        "TypeSet": [],
                        "AvailabilitySet": []
                    }
                ],
                "ZoneRegion": "ap-guangzhou",
                "LocalZone": false,
                "EdgeZone": false,
                "ZoneResourceType": "SHARED",
                "Egress": "center_egress1"
            },
            {
                "MasterZone": "ap-guangzhou-2",
                "SlaveZone": null,
                "IPVersion": "IPv4",
                "ResourceSet": [
                    {
                        "Isp": "BGP",
                        "Type": [
                            "BGP"
                        ],
                        "TypeSet": [],
                        "AvailabilitySet": []
                    },
                    {
                        "Isp": "INTERNAL",
                        "Type": [
                            "INTERNAL"
                        ],
                        "TypeSet": [],
                        "AvailabilitySet": []
                    }
                ],
                "ZoneRegion": "ap-guangzhou",
                "LocalZone": false,
                "EdgeZone": false,
                "ZoneResourceType": "SHARED",
                "Egress": "center_egress1"
            }
        ],
        "TotalCount": 3,
        "RequestId": "e0d11bcf-c3fa-45b8-b438-a4b642dbaad6"
    }
}

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

Tencent Cloud CLI 3.0

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.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud