1. 接口描述
接口请求域名: cdz.tencentcloudapi.com 。
查询专属可用区各个垂直产品的资源使用情况
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeCloudDedicatedZoneResourceSummary。 |
Version | 是 | String | 公共参数,本接口取值:2022-11-23。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
CdzId | 是 | String | 专属可用区唯一标识 示例值:cdz-8wbc41r9 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ResourceSummarySet | Array of CloudDedicatedZoneResourceSummaryInfo | 资源水位详情 注意:此字段可能返回 null,表示取不到有效值。 示例值:[ { "ProductName": "云服务器", "SubProductName": "标准型S5", "Statistics": [ { "Item": "CPU", "Unit": "核", "Total": "41996", "Usage": "32875", "UsageRate": "78.28%", "Remain": "9121", "RemainRate": "21.72%", "ThisMondayUsageRate": "78.33%", "ThisMondayUsageGrowthRate": "-0.05%", "LastMondayUsageGrowthRate": "-4.41%" } ] } ] |
ExtraInfo | ExtraInfo | 资源水位扩展信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "ThisMondayLocalDate": "2024-11-11", "LastMondayLocalDate": "2024-11-04" } |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询专属可用区资源水位
输入示例
POST / HTTP/1.1
Host: cdz.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeCloudDedicatedZoneResourceSummary
<公共请求参数>
{
"CdzId": "cdz-mgk971xw"
}
输出示例
{
"Response": {
"ResourceSummarySet": [
{
"ProductName": "云服务器",
"SubProductName": "标准型S5",
"Statistics": [
{
"Item": "CPU",
"Unit": "核",
"Total": "41996",
"Usage": "32875",
"UsageRate": "78.28%",
"Remain": "9121",
"RemainRate": "21.72%",
"ThisMondayUsageRate": "78.33%",
"ThisMondayUsageGrowthRate": "-0.05%",
"LastMondayUsageGrowthRate": "-4.41%"
},
{
"Item": "内存",
"Unit": "GB",
"Total": "135520",
"Usage": "101202",
"UsageRate": "74.68%",
"Remain": "34318",
"RemainRate": "25.32%",
"ThisMondayUsageRate": "74.72%",
"ThisMondayUsageGrowthRate": "-0.05%",
"LastMondayUsageGrowthRate": "-6.19%"
}
]
},
{
"ProductName": "云硬盘",
"SubProductName": "SSD云硬盘",
"Statistics": [
{
"Item": "磁盘",
"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": "云硬盘",
"SubProductName": "高性能云硬盘",
"Statistics": [
{
"Item": "磁盘",
"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": "云数据库 MySQL",
"SubProductName": "云数据库 MySQL",
"Statistics": [
{
"Item": "内存",
"Unit": "GB",
"Total": "3600",
"Usage": "2031",
"UsageRate": "56.42%",
"Remain": "1569",
"RemainRate": "43.58%",
"ThisMondayUsageRate": "0.00%",
"ThisMondayUsageGrowthRate": "56.42%",
"LastMondayUsageGrowthRate": "-56.42%"
},
{
"Item": "磁盘",
"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": "云数据库 PostgreSQL",
"SubProductName": "云数据库 PostgreSQL",
"Statistics": [
{
"Item": "内存",
"Unit": "GB",
"Total": "22320",
"Usage": "14559",
"UsageRate": "65.23%",
"Remain": "7761",
"RemainRate": "34.77%",
"ThisMondayUsageRate": "65.23%",
"ThisMondayUsageGrowthRate": "0.00%",
"LastMondayUsageGrowthRate": "0.50%"
},
{
"Item": "磁盘",
"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": "云数据库 Redis",
"SubProductName": "云数据库 Redis",
"Statistics": [
{
"Item": "内存",
"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. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
ResourceNotFound.CdzIdNotFound | 该专属可用区不存在 |