1. 接口描述
接口请求域名： emr.tencentcloudapi.com 。
DescribeYarnApplications
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeYarnApplications。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-03。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | 集群ID 示例值：emr-xfyags1d |
| StartTime | 是 | Integer | 起始时间秒 示例值：1686029737 |
| EndTime | 是 | Integer | 结束时间秒，EndTime-StartTime不得超过1天秒数86400 示例值：1686129737 |
| Offset | 是 | Integer | 分页偏移量，Offset=0表示第一页；如果limit=100，Offset=1，则表示第二页，数据第101条开始查询，返回100条数据；如果limit=100，Offset=2，则表示第三页，数据第201条开始查询，返回100条数据。依次类推 示例值：0 |
| Limit | 是 | Integer | 分页大小，合法范围[1,100] 示例值：20 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Total | Integer | 总数 |
| Results | Array of YarnApplication | 结果列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取Yarn的Applications列表
获取Yarn的Applications列表
输入示例
POST / HTTP/1.1
Host: emr.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeYarnApplications
<公共请求参数>
{
"InstanceId": "emr-qy2p6mem",
"Offset": 0,
"Limit": 2,
"StartTime": 1685633400,
"EndTime": 1686239999
}输出示例
{
"Response": {
"Total": 225,
"RequestId": "12345678999",
"Results": [
{
"MemorySeconds": 5512381,
"NumAMContainerPreempted": 0,
"HDFSBytesWritten": 0,
"MapOutputRecords": 0,
"State": "",
"FailedReduceAttempts": 0,
"ApplicationType": "TEZ",
"MbMillisMaps": 0,
"Progress": 0,
"GcTimeMillis": 0,
"ReducesCompleted": 0,
"MapInputRecords": 0,
"KilledMapAttempts": 0,
"RunningContainers": 0,
"ReduceOutputRecords": 0,
"TotalLaunchedMaps": 0,
"VCoreSeconds": 3175,
"AllocatedMB": 0,
"AvgReduceTime": 0,
"ClusterUsagePercentage": 0,
"User": "hadoop",
"PreemptedResourceMB": 0,
"FinishedTime": -1,
"TotalLaunchedReduces": 0,
"Name": "HIVE-a4ee6338-7b65-4e10-a5fe-717ff8f5c1a7",
"AvgShuffleTime": 0,
"ReducesTotal": 0,
"PreemptedResourceVCores": 0,
"StartedTime": 1686156754000,
"ElapsedTime": "12min14s",
"MbMillisReduces": 0,
"NumNonAMContainerPreempted": 0,
"MapsCompleted": 0,
"ReduceInputRecords": 0,
"KilledReduceAttempts": 0,
"FailedMapAttempts": 0,
"SuccessfulReduceAttempts": 0,
"Queue": "default",
"VCoreMillisMaps": 0,
"AvgMapTime": 0,
"AllocatedVCores": 0,
"HDFSBytesRead": 0,
"VCoreMillisReduces": 0,
"MapsTotal": 0,
"FinalStatus": "UNDEFINED",
"AvgMergeTime": 0,
"Id": "application_1686105960659_0022",
"QueueUsagePercentage": 0,
"SuccessfulMapAttempts": 0
},
{
"MemorySeconds": 4415161,
"NumAMContainerPreempted": 0,
"HDFSBytesWritten": 0,
"MapOutputRecords": 0,
"State": "",
"FailedReduceAttempts": 0,
"ApplicationType": "TEZ",
"MbMillisMaps": 0,
"Progress": 0,
"GcTimeMillis": 0,
"ReducesCompleted": 0,
"MapInputRecords": 0,
"KilledMapAttempts": 0,
"RunningContainers": 0,
"ReduceOutputRecords": 0,
"TotalLaunchedMaps": 0,
"VCoreSeconds": 2934,
"AllocatedMB": 0,
"AvgReduceTime": 0,
"ClusterUsagePercentage": 0,
"User": "hadoop",
"PreemptedResourceMB": 0,
"FinishedTime": -1,
"TotalLaunchedReduces": 0,
"Name": "HIVE-113e63ac-47f4-449f-b690-fa52358f348b",
"AvgShuffleTime": 0,
"ReducesTotal": 0,
"PreemptedResourceVCores": 0,
"StartedTime": 1686152517000,
"ElapsedTime": "7min38s",
"MbMillisReduces": 0,
"NumNonAMContainerPreempted": 0,
"MapsCompleted": 0,
"ReduceInputRecords": 0,
"KilledReduceAttempts": 0,
"FailedMapAttempts": 0,
"SuccessfulReduceAttempts": 0,
"Queue": "default",
"VCoreMillisMaps": 0,
"AvgMapTime": 0,
"AllocatedVCores": 0,
"HDFSBytesRead": 0,
"VCoreMillisReduces": 0,
"MapsTotal": 0,
"FinalStatus": "UNDEFINED",
"AvgMergeTime": 0,
"Id": "application_1686105960659_0021",
"QueueUsagePercentage": 0,
"SuccessfulMapAttempts": 0
}
]
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.ImpalaQueryException | impala查询参数异常。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| UnauthorizedOperation.AppIdMismatched | appid不一致。 |
