1. 接口描述
接口请求域名: tione.tencentcloudapi.com 。
查询资源组节点列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBillingResourceGroup。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-11。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ResourceGroupId | 是 | String | 资源组id, 取值为创建资源组接口(CreateBillingResourceGroup)响应中的ResourceGroupId 示例值:ersg-8jpj27jc |
Filters.N | 否 | Array of Filter | 过滤条件 注意: 1. Filter.Name 只支持以下枚举值: InstanceId (资源组节点id) InstanceStatus (资源组节点状态) 2. Filter.Values: 长度为1且Filter.Fuzzy=true时,支持模糊查询; 不为1时,精确查询 3. 每次请求的Filters的上限为10,Filter.Values的上限为100 示例值:[{Name: "InstanceStatus", Values: ["RUNNING"]}] |
Offset | 否 | Integer | 分页查询起始位置,如:Limit为10,第一页Offset为0,第二页Offset为10....即每页左边为闭区间; 默认0 示例值:0 |
Limit | 否 | Integer | 分页查询每页大小,默认20 示例值:10 |
Order | 否 | String | 排序方向; 枚举值: ASC | DESC;默认DESC 示例值:ASC |
OrderField | 否 | String | 排序字段; 枚举值: CreateTime (创建时间) | ExpireTime (到期时间);默认CreateTime 示例值:CreateTime |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 资源组节点总数; 注意接口是分页拉取的,total是指资源组节点总数,不是本次返回中InstanceSet数组的大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
InstanceSet | Array of Instance | 资源组节点信息 注意:此字段可能返回 null,表示取不到有效值。 |
ResourceGroupSWType | String | 资源组纳管类型 示例值:NORMAL |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询资源组节点列表
输入示例
POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillingResourceGroup
<公共请求参数>
{
"ResourceGroupId": "ersg-9hw7jfk6",
"Filters": [
{
"Name": "InstanceStatus",
"Values": [
"RUNNING"
],
"Negative": true,
"Fuzzy": true
}
],
"Offset": 1,
"Limit": 1,
"Order": "ASC",
"OrderField": "CreateTime"
}
输出示例
{
"Response": {
"TotalCount": 2,
"InstanceSet": [
{
"InstanceId": "sm-8r7jbnsz",
"UsedResource": {
"Cpu": 78200,
"Memory": 349696,
"Gpu": 400,
"GpuType": "4090D",
"RealGpu": 0,
"RealGpuDetailSet": []
},
"TotalResource": {
"Cpu": 78200,
"Memory": 349780,
"Gpu": 400,
"GpuType": "4090D",
"RealGpu": 0,
"RealGpuDetailSet": []
},
"InstanceStatus": "RUNNING",
"SubUin": "100023251204",
"CreateTime": "2024-12-19 15:36:44",
"ExpireTime": "",
"AutoRenewFlag": "NOTIFY_AND_MANUAL_RENEW",
"SpecId": "sv_tio_platform_cloud_post_gpu_80c368g_44090d_sw",
"SpecAlias": "80核358GB 4090D*4"
}
],
"RequestId": "114e2564-3ce6-469c-b9c0-284a51247902"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
AuthFailure.CamException | CAM系统异常。 |
AuthFailure.NoPermission | 没有权限。 |
AuthFailure.UnauthorizedOperation | 未授权操作。 |
FailedOperation | 操作失败。 |
FailedOperation.CallClusterFail | 调用集群失败。 |
FailedOperation.QueryDatabaseFail | 数据库查询错误。 |
FailedOperation.QueryTagFail | 查询标签服务失败。 |
FailedOperation.RecordNotFound | 记录不存在。 |
FailedOperation.UnmarshalData | 数据解析失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidFilter | 无效的过滤器。 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
MissingParameter | 缺少参数错误。 |