查询指定集群下的yarn队列

最近更新时间: 2026-09-17 00:05:49

1. 接口描述

接口请求域名： tbdsnew.api3.fincloud.tencent.cn。

该接口用于查询指定集群下的yarn队列列表，并包含已绑定的资源组信息

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

接口更新时间：2025-09-11 20:02:11。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeYarnResourceList
Version 是 否 String 公共参数，本接口取值：2019-01-03
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ClusterId 是 否 String 集群id
示例值： cluster-001

3. 输出参数

参数名称 类型 描述
Data Array of YarnResourceResponse yarn类型资源列表
注意：此字段可能返回 null，表示取不到有效值。
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。

5. 示例

示例1 获取yarn队列列表

输入示例

POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeYarnResourceList
<公共请求参数>

{
  "ClusterId": "cluster-001",
  "QueueName": "default"
}

输出示例

{
    "Response": {
        "RequestId": "req-123456805",
        "Data": [
            {
                "ResourceName": "yarn-queue-001",
                "ResourcePath": "root.default.queue1",
                "ResourceType": "yarn",
                "ClusterId": "cluster-001",
                "ResourceQuota": "10000MB,100vCores",
                "IsUsed": false
            }
        ]
    }
}