1. 接口描述
接口请求域名: ags.tencentcloudapi.com 。
查询当前地域、当前租户的 GPU 资源组及统计。通过 resource-group-id 精确过滤可查询组详情,仍返回数组;无匹配项返回空数组。资源组可以为空,商业期限和续费标记逐台保存。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DescribeGPUResourceGroups。 |
| Version | 是 | String | 公共参数,本接口取值:2025-09-20。 |
| Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
| Filters.N | 否 | Array of Filter | 过滤条件,最多 10 项,Name 不可重复,每项 Values 为 1–10 个值。不同 Name 为 AND、同一 Values 为 OR。支持 resource-group-id(精确 ID)、resource-group-name(精确名称)、resource-group-name-like(普通文本子串,% 和 _ 不作为通配符)、gpu-type、gpu-num、cpu、memory。ID/GPUType 最多 64 字节,名称最多 128 字节;gpu-num 为正整数字符串,cpu/memory 为正数字符串,单位核/GiB。 |
| Offset | 否 | Integer | 分页偏移量,默认为 0,必须大于等于 0。 示例值:0 |
| Limit | 否 | Integer | 每页条数,省略或传 0 时取 100;非零取值范围 1–500。 示例值:20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ResourceGroups | Array of GPUResourceGroup | 匹配的资源组列表;无匹配时为 []。 |
| TotalCount | Integer | 匹配的资源组总数,分页前计算。 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询GPU资源组
查询当前地域、当前租户的 GPU 资源组及统计。通过 resource-group-id 精确过滤可查询组详情,仍返回数组;无匹配项返回空数组。资源组可以为空,商业期限和续费标记逐台保存。
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGPUResourceGroups
<公共请求参数>
{
"Filters": [
{
"Name": "resource-group-name-like",
"Values": [
"推理"
]
},
{
"Name": "gpu-type",
"Values": [
"5090d"
]
},
{
"Name": "gpu-num",
"Values": [
"2"
]
}
],
"Offset": 0,
"Limit": 20
}
输出示例
{
"Response": {
"ResourceGroups": [
{
"ResourceGroupId": "gpug-example",
"Name": "推理服务",
"Spec": {
"GPUType": "5090d",
"GPUTypeAlias": "NVIDIA RTX 5090 D",
"GPUMemoryGiB": 64,
"CPU": 64,
"Memory": 192,
"GPUNum": 2
},
"Statistics": {
"TotalCount": 10,
"AvailableCount": 5,
"AllocatedCount": 3,
"StateCounts": {
"Delivering": 1,
"Active": 8,
"Isolated": 1,
"Destroying": 0
}
}
}
],
"TotalCount": 1,
"RequestId": "request-example"
}
}
示例2 按资源组ID查询详情
复用同一接口查询详情,没有独立的 DescribeGPUResourceGroup Action。
输入示例
POST / HTTP/1.1
Host: ags.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeGPUResourceGroups
<公共请求参数>
{
"Filters": [
{
"Name": "resource-group-id",
"Values": [
"gpug-example"
]
}
]
}
输出示例
{
"Response": {
"ResourceGroups": [
{
"ResourceGroupId": "gpug-example",
"Name": "推理服务",
"Spec": {
"GPUType": "5090d",
"GPUTypeAlias": "NVIDIA RTX 5090 D",
"GPUMemoryGiB": 64,
"CPU": 64,
"Memory": 192,
"GPUNum": 2
},
"Statistics": {
"TotalCount": 10,
"AvailableCount": 5,
"AllocatedCount": 3,
"StateCounts": {
"Delivering": 1,
"Active": 8,
"Isolated": 1,
"Destroying": 0
}
}
}
],
"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 | 操作不支持。 |