1. 接口描述
接口请求域名： cvm.tencentcloudapi.com 。
本接口(DescribeAccountQuota)用于查询用户配额详情。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeAccountQuota。 |
| Version | 是 | String | 公共参数，本接口取值：2017-03-12。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 按照【可用区】进行过滤。可用区形如：ap-guangzhou-1。 类型：String 必选：否 可选项：可用区列表 按照【配额类型】进行过滤。配额类型形如：PostPaidQuotaSet。 类型：String 必选：否 可选项：PostPaidQuotaSet,DisasterRecoverGroupQuotaSet,PrePaidQuotaSet,SpotPaidQuotaSet 示例值：[ { "Name": "quota-type", "Values": [ "PrePaidQuotaSet" ] } ] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AppId | Integer | 用户appid 示例值：1251783334 |
| AccountQuotaOverview | AccountQuotaOverview | 配额数据 示例值：{ "PrePaidQuotaSet": [ { "TotalQuota": 300, "UsedQuota": 5, "RemainingQuota": 295, "OnceQuota": 500, "Zone": "ap-shanghai-5" } ], "PostPaidQuotaSet": [ { "TotalQuota": 300, "UsedQuota": 5, "RemainingQuota": 295, "Zone": "ap-shanghai-5" } ] } |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询用户概览数据
查询用户云主机、各个地域配额等数据。
输入示例
GET https://cvm.tencentcloudapi.com/?Action=DescribeAccountQuota
&<公共请求参数>输出示例
{
"Response": {
"AccountQuotaOverview": {
"Region": "ap-guangzhou",
"AccountQuota": {
"PostPaidQuotaSet": [
{
"UsedQuota": 0,
"RemainingQuota": 288,
"TotalQuota": 288,
"Zone": "ap-guangzhou-1"
},
{
"UsedQuota": 2,
"RemainingQuota": 1248,
"TotalQuota": 1250,
"Zone": "ap-guangzhou-2"
}
],
"DisasterRecoverGroupQuotaSet": [
{
"CvmInRackGroupQuota": 30,
"GroupQuota": 10,
"CvmInHostGroupQuota": 50,
"CurrentNum": 0,
"CvmInSwitchGroupQuota": 20
}
],
"PrePaidQuotaSet": [
{
"UsedQuota": 0,
"OnceQuota": 300,
"Zone": "ap-guangzhou-1",
"TotalQuota": 255,
"RemainingQuota": 255
},
{
"UsedQuota": 0,
"OnceQuota": 300,
"Zone": "ap-guangzhou-2",
"TotalQuota": 222,
"RemainingQuota": 222
}
],
"SpotPaidQuotaSet": [
{
"UsedQuota": 0,
"RemainingQuota": 244,
"TotalQuota": 244,
"Zone": "ap-guangzhou-1"
},
{
"UsedQuota": 4,
"RemainingQuota": 195,
"TotalQuota": 199,
"Zone": "ap-guangzhou-2"
}
],
"ImageQuotaSet": [
{
"UsedQuota": 0,
"TotalQuota": 10
}
]
}
},
"RequestId": "7f117776-3d20-4f00-839b-b22b04625f47",
"AppId": 251007416
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidFilter | 无效的过滤器。 |
| InvalidFilterValue.LimitExceeded | Filter。 |
| InvalidParameterValue.Range | 无效参数值。参数值取值范围不合法。 |
| InvalidZone.MismatchRegion | 指定的zone不存在。 |
| UnsupportedOperation | 操作不支持。 |
