1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.com。
集群服务中yarn组件作业查询中的统计列表,获取集群中作业统计信息
默认接口请求频率限制:20次/秒。
接口更新时间:2024-12-02 07:46:08。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeApplicationStatics |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群id 示例值: tbds-lpzpjomo |
| StartTime | 否 | 否 | Int64 | 起始时间 示例值: 1748188800 |
| EndTime | 否 | 否 | Int64 | 结束时间 示例值: 1748247028 |
| Queues | 否 | 否 | Array of String | 过滤的队列名 示例值: [] |
| Users | 否 | 否 | Array of String | 过滤的用户名 示例值: [] |
| ApplicationTypes | 否 | 否 | Array of String | 过滤的作业类型 示例值: [] |
| GroupBy | 否 | 否 | Array of String | 分组字段,可选:queue, user, applicationType 示例值: [] |
| OrderBy | 否 | 否 | String | 排序字段,可选:sumMemorySeconds, sumVCoreSeconds, sumHDFSBytesWritten, sumHDFSBytesRead 示例值: 1 |
| IsAsc | 否 | 否 | Int64 | 是否顺序排序,0-逆序,1-正序 示例值: 1 |
| Offset | 否 | 否 | Int64 | 页号,默认值:0,表示第一页 示例值: 0 |
| Limit | 否 | 否 | Int64 | 页容量,默认值:10,最大值200 示例值: 10 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Statics | Array of ApplicationStatics | 作业统计信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| TotalCount | Int64 | 总数 示例值: 1 |
| Queues | Array of String | 可选择的队列名 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| Users | Array of String | 可选择的用户名 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| ApplicationTypes | Array of String | 可选择的作业类型 注意:此字段可能返回 null,表示取不到有效值。 示例值: 1 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| UnauthorizedOperation.AppIdMismatched | appid不一致。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| InvalidParameter.ImpalaQueryException | impala查询参数异常。 |