查询yarn调度基本信息

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

1. 接口描述

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

查询yarn调度基本信息

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

接口更新时间：2025-09-12 15:28:41。

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

错误码	描述
InternalError	内部错误。
InternalError.WoodClusterNotFound	内部错误。
ResourceNotFound	资源不存在。
ResourceNotFound.InstanceNotFound	无法找到该实例。

5. 示例

示例1 查询yarn调度基本信息

输入示例

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

{
  "ClusterId": "tbds-33f4bexm"
}

输出示例

{
    "Response": {
        "RequestId": "991c3ec6-f483-44b9-9c83-4abf99c0cb75",
        "Type": "fairScheduler",
        "YarnScheduleBaseInfoList": [{
            "QueueName": "default",
            "IsRootQueue": false,
            "Capacity": 51,
            "MaxCapacity": 51,
            "FullQueueName": "root.default"
        }]
    }
}