ListDoctorJobs - 批量获取任务运行结果

通过EMR Doctor批量获取任务基本运行信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
emr:ListDoctorJobslist
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
ClusterIdstring

集群 ID。

c-b933c5aac8fe****
NextTokenstring

标记当前开始读取的位置。

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

一次获取的最大记录数。

20
StartRangeobject

开始时间范围,过滤开始时间在一个时间范围内的任务。

StartTimelong

任务提交时间起始范围,Unix 时间戳,单位毫秒。

1683340662016
EndTimelong

任务提交时间结束范围,Unix 时间戳,单位毫秒。

1683340662020
EndRangeobject

结束时间范围,过滤出结束时间在一个时间范围内的任务。

StartTimelong

任务结束时间起始范围,Unix 时间戳,单位毫秒。

1679135111960
EndTimelong

任务结束时间结束范围,Unix 时间戳,单位毫秒。

1666865137099
AppIdsarray

任务提交到 YARN 的 IDs,用于过滤任务列表。

Stringstring

YARN 的任务 ID。

application_1643475036865_******
Usersarray

任务提交的用户列表,用于过滤任务列表。

Stringstring

任务提交到 YARN 的用户名称。

DW
Queuesarray

任务提交到 YARN 的队列列表,用于过滤任务列表。

Stringstring

任务提交到的 YARN 队列名称。

DW
Typesarray

任务提交到 YARN 的引擎列表,用于过滤任务列表。

Stringstring

任务提交到 YARN 的引擎类型。

SPARK
OrderTypestring

排序方向。取值:

  • ASC: 升序排列。
  • DESC:降序排列。
ASC
OrderBystring

排序字段。取值:

  • vcoreSeconds:任务 CPU 使用量。
  • memSeconds:任务内存使用量。
vcoreSeconds

返回参数

名称类型描述示例值
object

返回数据

Dataarray<object>

任务列表信息。

ListDoctorJobsDTOobject

任务信息。

AppIdstring

任务提交到 YARN 的 ID。

application_1607584549220_*****
AppNamestring

任务名称。

tpcds
Userstring

任务提交用户名。

DW
Queuestring

任务提交到 YARN 的队列。

DW
Statestring

应用执行状态,取值说明:

  • FINISHED:结束的。
  • FAILED:失败的。
  • KILLED:中止的。
FINISHED
FinalStatusstring

应用执行结束状态,取值说明:

  • SUCCEEDED:成功的。
  • FAILED:失败的。
  • KILLED:中止的。
  • ENDED: 结束的。
  • UNDEFINED:未定义的。
KILLED
Typestring

计算引擎类型。

SPARK
StartTimelong

任务提交时间,Unix 时间戳,单位毫秒。

1675180800000
LaunchTimelong

任务启动时间,Unix 时间戳,单位毫秒。

1672148400000
ElapsedTimelong

任务运行总时间,单位毫秒。

242
FinishTimelong

任务结束时间,Unix 时间戳,单位毫秒。

1683690929000
Metricsobject

指标数据。

VcoreSecondsobject

CPU 使用量。

Namestring

指标名称。

vcoreSeconds
Valuelong

指标值。

11123
Unitstring

指标单位。

VCores * Sec
Descriptionstring

指标描述。

Total vcore usage over time in seconds
MemSecondsobject

内存使用量。

Namestring

指标名称。

memSeconds
Valuelong

指标值。

12312312
Unitstring

指标单位。

MB * Sec
Descriptionstring

指标描述。

Total memory usage over time in seconds
RequestIdstring

请求 ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextTokenstring

返回读取到的数据位置。

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

本次请求所返回的最大记录条数。

20
TotalCountinteger

本次请求条件下的数据总量。

200

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "AppId": "application_1607584549220_*****",
      "AppName": "tpcds",
      "User": "DW",
      "Queue": "DW",
      "State": "FINISHED",
      "FinalStatus": "KILLED",
      "Type": "SPARK",
      "StartTime": 1675180800000,
      "LaunchTime": 1672148400000,
      "ElapsedTime": 242,
      "FinishTime": 1683690929000,
      "Metrics": {
        "VcoreSeconds": {
          "Name": "vcoreSeconds\n",
          "Value": 11123,
          "Unit": "VCores * Sec\n",
          "Description": "Total vcore usage over time in seconds\n"
        },
        "MemSeconds": {
          "Name": "memSeconds",
          "Value": 12312312,
          "Unit": "MB * Sec\n",
          "Description": "Total memory usage over time in seconds\n"
        }
      }
    }
  ],
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "NextToken": "DD6B1B2A-5837-5237-ABE4-FF0C89568980",
  "MaxResults": 20,
  "TotalCount": 200
}

错误码

HTTP status code错误码错误信息描述
400ConflictParametersParameters that must not be used together. %s多个参数间存在冲突。
400IncompleteSignatureThe request signature is invalid.API请求签名不合法。
400InvalidActionThe action %s requested is invalid.不合法的Action。
400InvalidParameterThe specified parameter %s is not valid.参数错误。
400InvalidParameterValueThe input parameter %s is invalid or out of range.参数值超出范围。
400MissingActionThe action %s requested is missing.缺少Action参数
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
400NotAuthorizedYou do not have permission to perform this action. %s没有权限。
400ThrottlingExceptionThe request was denied due to request throttling. %s限流。
404ResourceNotFoundThe resource not found by %s.请求的资源未找到。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
503ServiceFailureThe request has failed due to a temporary failure of %s service.依赖的阿里云其他服务不可用。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.请求超时或者服务不可用。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史