All Products
Search
Document Center

E-MapReduce:ListDoctorJobs

Last Updated:Dec 12, 2024

Obtains the basic running information about multiple jobs at a time on E-MapReduce (EMR) Doctor.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
emr:ListDoctorJobslist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

c-b933c5aac8fe****
NextTokenstringNo

The pagination token that is used in the request to retrieve a new page of results.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsintegerNo

The maximum number of entries to return on each page.

20
StartRangeobjectNo

The range of start time. You can filter jobs whose start time falls within the specified time range.

StartTimelongNo

The beginning of the time range during which jobs were submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1683340662016
EndTimelongNo

The end of the time range during which jobs were submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1683340662020
EndRangeobjectNo

The range of end time. You can filter jobs whose end time falls within the specified time range.

StartTimelongNo

The beginning of the time range during which jobs ended. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1679135111960
EndTimelongNo

The end of the time range during which jobs ended. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1666865137099
AppIdsarrayNo

The IDs of the jobs that are submitted to YARN.

StringstringNo

The ID of the job that is submitted to YARN.

application_1643475036865_******
UsersarrayNo

The users who submit the jobs.

StringstringNo

The username that is used to submit the job to YARN.

DW
QueuesarrayNo

The YARN queues to which the jobs are submitted.

StringstringNo

The name of the YARN queue to which the job is submitted.

DW
TypesarrayNo

The YARN engines to which the jobs are submitted.

StringstringNo

The type of the YARN engine to which the job is submitted.

SPARK
OrderTypestringNo

The order in which you want to sort the query results. Valid values:

  • ASC: the ascending order
  • DESC: the descending order
ASC
OrderBystringNo

The field that you use to sort the query results. Valid values:

  • vcoreSeconds: the aggregated number of vCPUs that are allocated to the job multiplied by the number of seconds the job has been running
  • memSeconds: the aggregated amount of memory that is allocated to the job multiplied by the number of seconds the job has been running
vcoreSeconds

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataarray<object>

The information about the jobs.

ListDoctorJobsDTOobject
AppIdstring

The ID of the job that was submitted to YARN.

application_1607584549220_*****
AppNamestring

The name of the job.

tpcds
Userstring

The username that was used to submit the job.

DW
Queuestring

The YARN queue to which the job was submitted.

DW
Statestring

The running state of the job. Valid values:

  • FINISHED
  • FAILED
  • KILLED
FINISHED
FinalStatusstring

The final state of the job. Valid values:

  • SUCCEEDED
  • FAILED
  • KILLED
  • ENDED
  • UNDEFINED
KILLED
Typestring

The type of the compute engine.

SPARK
StartTimelong

The time when the job was submitted. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1675180800000
LaunchTimelong

The time when the job was started. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1672148400000
ElapsedTimelong

The total running time of the job. Unit: milliseconds.

242
FinishTimelong

The end time of the job. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1683690929000
Metricsobject

The data about the metrics.

VcoreSecondsobject

The CPU usage.

Namestring

The name of the metric.

vcoreSeconds
Valuelong

The value of the metric.

11123
Unitstring

The unit of the metric.

VCores * Sec
Descriptionstring

The description of the metric.

Total vcore usage over time in seconds
MemSecondsobject

The amount of memory consumed.

Namestring

The name of the metric.

memSeconds
Valuelong

The value of the metric.

12312312
Unitstring

The unit of the metric.

MB * Sec
Descriptionstring

The description of the metric.

Total memory usage over time in seconds
RequestIdstring

The request ID.

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

A pagination token.

DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResultsinteger

The maximum number of entries returned.

20
TotalCountinteger

The total number of entries returned.

200

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

HTTP status codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
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.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history