TI-ONE 训练平台
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > TI-ONE 训练平台 > API 文档 > 资源组相关接口 > 查询资源组详情

查询资源组详情

最近更新时间：2024-03-12 01:55:50

我的收藏

本页目录：

1. 接口描述

接口请求域名： tione.tencentcloudapi.com 。

查询资源组详情

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBillingResourceGroups。
Version 是 String 公共参数，本接口取值：2021-11-11。
Region 是 String 公共参数，详见产品支持的 地域列表。
Type 否 String 资源组类型;
枚举值:
空: 通用, TRAIN: 训练, INFERENCE: 推理
示例值：INFERENCE
Filters.N 否 Array of Filter Filter.Name: 枚举值: ResourceGroupId (资源组id列表)
ResourceGroupName (资源组名称列表)
Filter.Values: 长度为1且Filter.Fuzzy=true时，支持模糊查询; 不为1时，精确查询
每次请求的Filters的上限为5，Filter.Values的上限为100
TagFilters.N 否 Array of TagFilter 标签过滤
Offset 否 Integer 偏移量，默认为0；分页查询起始位置，如：Limit为100，第一页Offset为0，第二页OffSet为100....即每页左边为闭区间
示例值：0
Limit 否 Integer 分页查询每页大小，默认20
示例值：0
SearchWord 否 String 支持模糊查找资源组id和资源组名
示例值：ersg
DontShowInstanceSet 否 Boolean 是否不展示节点列表;
true: 不展示，false 展示；
默认为false
示例值：false

3. 输出参数

参数名称 类型 描述
TotalCount Integer 资源组总数； 注意接口是分页拉取的，total是指资源组总数，不是本次返回中ResourceGroupSet数组的大小
示例值：1
ResourceGroupSet Array of ResourceGroup 资源组详情
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询资源组详情

输入示例

POST / HTTP/1.1
Host: tione.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBillingResourceGroups
<公共请求参数>

{
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ],
            "Negative": true,
            "Fuzzy": true
        }
    ],
    "TagFilters": [
        {
            "TagKey": "abc",
            "TagValues": [
                "abc"
            ]
        }
    ],
    "Offset": 0,
    "Limit": 0,
    "SearchWord": "abc",
    "DontShowInstanceSet": true
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "ResourceGroupSet": [
            {
                "ResourceGroupId": "abc",
                "ResourceGroupName": "abc",
                "FreeInstance": 1,
                "TotalInstance": 1,
                "UsedResource": {
                    "Cpu": 1,
                    "Memory": 1,
                    "Gpu": 1,
                    "GpuDetailSet": [
                        {
                            "Name": "abc",
                            "Value": 1
                        }
                    ]
                },
                "TotalResource": {
                    "Cpu": 1,
                    "Memory": 1,
                    "Gpu": 1,
                    "GpuDetailSet": [
                        {
                            "Name": "abc",
                            "Value": 1
                        }
                    ]
                },
                "InstanceSet": [
                    {
                        "InstanceId": "abc",
                        "UsedResource": {
                            "Cpu": 1,
                            "Memory": 1,
                            "Gpu": 1,
                            "GpuType": "abc",
                            "RealGpu": 1,
                            "RealGpuDetailSet": [
                                {
                                    "Name": "abc",
                                    "Value": 1
                                }
                            ]
                        },
                        "TotalResource": {
                            "Cpu": 1,
                            "Memory": 1,
                            "Gpu": 1,
                            "GpuType": "abc",
                            "RealGpu": 1
                        },
                        "InstanceStatus": "abc",
                        "SubUin": "abc",
                        "CreateTime": "abc",
                        "ExpireTime": "abc",
                        "AutoRenewFlag": "abc",
                        "SpecId": "abc",
                        "SpecAlias": "abc",
                        "SpecFeatures": [
                            "abc"
                        ],
                        "CvmInstanceId": "abc"
                    }
                ],
                "TagSet": [
                    {
                        "TagKey": "abc",
                        "TagValue": "abc"
                    }
                ]
            }
        ],
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
AuthFailure.CamException CAM系统异常。
AuthFailure.UnauthorizedOperation 未授权操作。
FailedOperation 操作失败。
FailedOperation.CallClusterFail 调用集群失败。
FailedOperation.ExecDatabaseFail 数据库执行错误。
FailedOperation.ExecTagFail 标签操作失败。
FailedOperation.QueryDatabaseFail 数据库查询错误。
FailedOperation.QueryTagFail 查询标签服务失败。
FailedOperation.UnmarshalData 数据解析失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.ValidateError 请求参数校验失败。
InvalidParameterValue.InvalidFilter 无效的过滤器。
InvalidParameterValue.LimitExceeded 参数值数量超过限制。
MissingParameter 缺少参数错误。
中国站