1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
查询当前地域、当前租户的逐台 GPU 商业资源及占用状态。仅展示当前资源,不展示已销毁或补偿完成的失败资源;先筛选(含占用状态)再统计和分页。
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeGPUResources。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| ResourceGroupId | 否 | String | 按资源组 ID 过滤,可省略,最多 64 字节。 示例值:gpug-example |
| ResourceIds.N | 否 | Array of String | 按GPU资源 ID 过滤,最多 500 个,每个为非空字符串且最多 64 字节;值之间为 OR,与其他条件为 AND。 示例值:["ins-1223"] |
| State | 否 | String | 按GPU状态过滤,可省略。大小写敏感:Delivering、Active、Isolated、Destroying。 示例值:Active |
| AllocationState | 否 | String | 按占用状态过滤,可省略。大小写敏感:Idle、Allocating、InUse、Returning、Unavailable。 示例值:InUse |
| Offset | 否 | Integer | 分页偏移量,默认为 0,必须大于等于 0。 示例值:0 |
| Limit | 否 | Integer | 每页条数,省略或传 0 时取 100;非零取值范围 1–500。 示例值:20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Resources | Array of GPUResource | GPU 资源列表;每台一条,无匹配时为 []。 |
| TotalCount | Integer | 筛选后、分页前的总数。 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询GPU资源
查询当前地域、当前租户的逐台 GPU 商业资源及占用状态。仅展示当前资源,不展示已销毁或补偿完成的失败资源;先筛选(含占用状态)再统计和分页。
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGPUResources
<公共请求参数>
{
"ResourceGroupId": "gpug-example",
"State": "Active",
"AllocationState": "InUse",
"Offset": 0,
"Limit": 20
}
输出示例
{
"Response": {
"Resources": [
{
"ResourceId": "ins-example-001",
"ResourceGroupId": "gpug-example",
"State": "Active",
"AllocationState": "InUse",
"InstanceId": "sandbox-example-001",
"ActiveAt": "2026-10-21T10:00:00+08:00",
"ExpireAt": "2026-11-21T10:00:00+08:00",
"RenewFlag": 1,
"StatusReason": ""
}
],
"TotalCount": 1,
"RequestId": "request-example"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| InternalError | 内部错误。 |
| InternalError.Unknown | 未分类内部错误 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnsupportedOperation | 操作不支持。 |