tencent cloud

DescribeCloudDedicatedZoneResourceSummary
最后更新时间:2025-10-30 21:32:55
DescribeCloudDedicatedZoneResourceSummary
最后更新时间: 2025-10-30 21:32:55

1. API Description

Domain name for API request: cdz.intl.tencentcloudapi.com.

This API is used to query resource usage of each vertical product in Cloud Dedicated Zone.

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: DescribeCloudDedicatedZoneResourceSummary.
Version Yes String Common Params. The value used for this API: 2022-11-23.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
CdzId Yes String Unique id of the cloud dedicated zone.

3. Output Parameters

Parameter Name Type Description
ResourceSummarySet Array of CloudDedicatedZoneResourceSummaryInfo Resource utilization.
ExtraInfo ExtraInfo Extended information of resource utilization.
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 Resource utilization in Cloud Dedicated Zone

Input Example

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

{
    "CdzId": "cdz-mgk971xw"
}

Output Example

{
    "Response": {
        "ResourceSummarySet": [
            {
"ProductName": "Cloud Virtual Machine"
"SubProductName": "Standard S5",
                "Statistics": [
                    {
                        "Item": "CPU",
                        "Unit": "Core",
                        "Total": "41996",
                        "Usage": "32875",
                        "UsageRate": "78.28%",
                        "Remain": "9121",
                        "RemainRate": "21.72%",
                        "ThisMondayUsageRate": "78.33%",
                        "ThisMondayUsageGrowthRate": "-0.05%",
                        "LastMondayUsageGrowthRate": "-4.41%"
                    },
                    {
                        "Item": "Memory",
                        "Unit": "GB",
                        "Total": "135520",
                        "Usage": "101202",
                        "UsageRate": "74.68%",
                        "Remain": "34318",
                        "RemainRate": "25.32%",
                        "ThisMondayUsageRate": "74.72%",
                        "ThisMondayUsageGrowthRate": "-0.05%",
                        "LastMondayUsageGrowthRate": "-6.19%"
                    }
                ]
            },
            {
                "ProductName": "Cloud Block Storage"
                "SubProductName": "SSD Cloud Disk"
                "Statistics": [
                    {
                        "Item": "Disk",
                        "Unit": "TB",
                        "Total": "64",
                        "Usage": "53.34",
                        "UsageRate": "83.34%",
                        "Remain": "10.66",
                        "RemainRate": "16.66%",
                        "ThisMondayUsageRate": "83.34%",
                        "ThisMondayUsageGrowthRate": "0.00%",
                        "LastMondayUsageGrowthRate": "4.58%"
                    }
                ]
            },
            {
                "ProductName": "Cloud Block Storage"
                "SubProductName": "High-performance CBS"
                "Statistics": [
                    {
                        "Item": "Disk",
                        "Unit": "TB",
                        "Total": "1392",
                        "Usage": "1157.32",
                        "UsageRate": "83.14%",
                        "Remain": "234.68",
                        "RemainRate": "16.86%",
                        "ThisMondayUsageRate": "82.03%",
                        "ThisMondayUsageGrowthRate": "1.11%",
                        "LastMondayUsageGrowthRate": "6.08%"
                    }
                ]
            },
            {
                "ProductName": "TencentDB for MySQL"
                "SubProductName": "TencentDB for MySQL"
                "Statistics": [
                    {
                        "Item": "Memory",
                        "Unit": "GB",
                        "Total": "3600",
                        "Usage": "2031",
                        "UsageRate": "56.42%",
                        "Remain": "1569",
                        "RemainRate": "43.58%",
                        "ThisMondayUsageRate": "0.00%",
                        "ThisMondayUsageGrowthRate": "56.42%",
                        "LastMondayUsageGrowthRate": "-56.42%"
                    },
                    {
                        "Item": "Disk",
                        "Unit": "TB",
                        "Total": "180",
                        "Usage": "82.12",
                        "UsageRate": "45.62%",
                        "Remain": "97.88",
                        "RemainRate": "54.38%",
                        "ThisMondayUsageRate": "0.00%",
                        "ThisMondayUsageGrowthRate": "45.62%",
                        "LastMondayUsageGrowthRate": "-45.62%"
                    }
                ]
            },
            {
                "ProductName": "TencentDB for PostgreSQL"
                "SubProductName": "TencentDB for PostgreSQL"
                "Statistics": [
                    {
                        "Item": "Memory",
                        "Unit": "GB",
                        "Total": "22320",
                        "Usage": "14559",
                        "UsageRate": "65.23%",
                        "Remain": "7761",
                        "RemainRate": "34.77%",
                        "ThisMondayUsageRate": "65.23%",
                        "ThisMondayUsageGrowthRate": "0.00%",
                        "LastMondayUsageGrowthRate": "0.50%"
                    },
                    {
                        "Item": "Disk",
                        "Unit": "TB",
                        "Total": "470",
                        "Usage": "304.68",
                        "UsageRate": "64.83%",
                        "Remain": "165.32",
                        "RemainRate": "35.17%",
                        "ThisMondayUsageRate": "64.83%",
                        "ThisMondayUsageGrowthRate": "0.00%",
                        "LastMondayUsageGrowthRate": "0.31%"
                    }
                ]
            },
            {
                "ProductName": "TencentDB for Redis"
                "SubProductName": "TencentDB for Redis"
                "Statistics": [
                    {
                        "Item": "Memory",
                        "Unit": "GB",
                        "Total": "2400",
                        "Usage": "0",
                        "UsageRate": "0.00%",
                        "Remain": "2400",
                        "RemainRate": "100.00%",
                        "ThisMondayUsageRate": "0.00%",
                        "ThisMondayUsageGrowthRate": "0.00%",
                        "LastMondayUsageGrowthRate": "0.00%"
                    }
                ]
            }
        ],
        "RequestId": "0b2b5dda-8245-4a5a-b0ac-cbf2e7e47bca"
    }
}

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
ResourceNotFound.CdzIdNotFound The cloud dedicated zone does not exist.
本页内容是否解决了您的问题?
您也可以 联系销售 提交工单 以寻求帮助。

文档反馈