1. 接口描述
接口请求域名: cvm.tencentcloudapi.com 。
本接口(DescribeResourcePoolPacks)用于查询用户已创建的实例资源池列表,包括资源池基本信息、剩余容量、底层物理拓扑信息等。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeResourcePoolPacks。 |
| Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| MaxResults | 否 | Integer | 返回数量,默认值为10,最小值为10,最大值为100。 示例值:10 |
| NextToken | 否 | String | 分页标记,用于获取下一页数据。 示例值:HlyieKNKhSHMWHVqZOjzlhKBK1ar2qPnSdoW9YMz84kYuRMJlvGgMfAh68VpTOIS |
| Filters.N | 否 | Array of Filter | 按照【实例资源池ID】进行过滤。形如:rpp-rn99mzt2。 类型:String 必选:否 按照【可用区】进行过滤。形如:ap-guangzhou-6。 类型:String 必选:否 可选项:可用区列表 按照【实例类型】进行过滤。形如:SA9。 类型:String 必选:否 按照【实例规格】进行过滤。形如:SA9.96XLARGE1152。 类型:String 必选:否 按照【实例资源池状态】进行过滤。 类型:String 必选:否 可选项:CREATING (创建中) | ACTIVE (运行中) | RETIRED (已过期) 每次请求的 Filters的上限为10。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DedicatedResourcePackSet | Array of ResourcePoolPack | 符合条件的实例资源池列表。 |
| NextToken | String | 下一页数据的标记,用于分页查询。值为空时表示已到最后一页。 注意:此字段可能返回 null,表示取不到有效值。 示例值:DmfvOh9/PDSxjhK9C1m7xWt3GwgUbcW+D4qc2Nfu5ytgQNy7iXh21v7KeIK8Qni6 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询实例资源池预扣包列表
查询实例资源池预扣包列表
输入示例
POST / HTTP/1.1
Host: cvm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeResourcePoolPacks
<公共请求参数>
{
"MaxResults": 10
}
输出示例
{
"Response": {
"DedicatedResourcePackSet": [
{
"AutoPlacement": true,
"AvailableCapacity": {
"Cpu": 28,
"Disk": 0,
"Gpu": 0,
"Memory": 56
},
"DedicatedResourcePackId": "rpp-2gyonkx7",
"DedicatedResourcePackName": "",
"EndTime": "2026-03-07T10:19:40Z",
"HostIp": "28F18A615F13777FCD220D3D4AF9D956",
"InstanceFamily": "S9",
"InstanceType": "S9.8XLARGE64",
"RackId": "1A2A88376C7181435588E9FA520CE151",
"RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
"ResourcePoolPackType": "EXCLUSIVE",
"StartTime": "2026-02-07T10:19:40Z",
"Status": "ACTIVE",
"SwitchId": "3A7F5B75F1B7E292920E7118FD652EFD",
"TotalCapacity": {
"Cpu": 32,
"Disk": 0,
"Gpu": 0,
"Memory": 64
},
"Zone": "ap-guangzhou-7"
}
],
"RequestId": "ff3e17a5-592c-4391-83d7-904210e92e95"
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalServerError | 操作内部错误。 |
| InvalidFilter | 无效的过滤器。 |
| InvalidFilterValue.LimitExceeded | Filter传值超出限制。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
| InvalidParameterValue.ResourcePoolPackIdMalformed | 指定的资源池ID格式错误。请确保在请求中提供完整的资源池ID,格式为rpp-xxxxxxxx |
| InvalidZone.MismatchRegion | 指定的zone不存在。 |
| MissingParameter | 缺少参数错误。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation.ResourcePoolPackageInvisibleForUser | 该资源池对用户不可见 |