ListDoctorJobs - Query EMR Doctor job results - E-MapReduce

Queries basic running information about multiple jobs in batch through EMR Doctor.

Operation description

Lists real-time jobs by YARN.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

emr:ListDoctorJobs

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ClusterId	string	Yes	The cluster ID.	c-b933c5aac8fe****
NextToken	string	No	Pagination token for retrieving additional results.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	No	Maximum entries per page.	20
StartRange	object	No	Start time range for filtering jobs.
StartTime	integer	No	Start of the submission time range. UNIX timestamp in milliseconds.	1683340662016
EndTime	integer	No	End of the submission time range. UNIX timestamp in milliseconds.	1683340662020
EndRange	object	No	End time range for filtering jobs.
StartTime	integer	No	Start of the end time range. UNIX timestamp in milliseconds.	1679135111960
EndTime	integer	No	End of the end time range. UNIX timestamp in milliseconds.	1666865137099
AppIds	array	No	YARN job IDs to filter by.	null
	string	No	A YARN job ID.	application_1643475036865_******
Users	array	No	Job submitters to filter by.	null
	string	No	A YARN username.	DW
Queues	array	No	YARN queues to filter by.	null
	string	No	A YARN queue name.	DW
Types	array	No	YARN engine types to filter by.	null
	string	No	A YARN engine type.	SPARK
OrderType	string	No	Sort order. Valid values: ASC: the ascending order DESC: the descending order	ASC
OrderBy	string	No	Sort field. Valid values: vcoreSeconds: total vCPU-seconds consumed by the job memSeconds: total memory-seconds consumed by the job	vcoreSeconds

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	array<object>	Job details.
	array<object>
AppId	string	The YARN job ID.	application_1607584549220_*****
AppName	string	The name of the job.	tpcds
User	string	The job submitter.	DW
Queue	string	The YARN queue.	DW
State	string	The job state. Valid values: FINISHED FAILED KILLED	FINISHED
FinalStatus	string	The final job state. Valid values: SUCCEEDED FAILED KILLED ENDED UNDEFINED	KILLED
Type	string	The compute engine type.	SPARK
StartTime	integer	Job submission time. UNIX timestamp in milliseconds.	1675180800000
LaunchTime	integer	Job launch time. UNIX timestamp in milliseconds.	1672148400000
ElapsedTime	integer	Total running time in milliseconds.	242
FinishTime	integer	Job end time. UNIX timestamp in milliseconds.	1683690929000
Metrics	object	Job metrics.
VcoreSeconds	object	vCPU usage.
Name	string	The name of the metric.	vcoreSeconds
Value	integer	The metric value.	11123
Unit	string	The metric unit.	VCores * Sec
Description	string	The metric description.	Total vcore usage over time in seconds
MemSeconds	object	Memory usage.
Name	string	The name of the metric.	memSeconds
Value	integer	The metric value.	12312312
Unit	string	The metric unit.	MB * Sec
Description	string	The metric description.	Total memory usage over time in seconds
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	A pagination token.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	Maximum entries returned.	20
TotalCount	integer	Total entries returned.	200

Examples

Success response

JSON format

{
  "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 code	Error code	Error message
400	ConflictParameters	Parameters that must not be used together. %s
400	IncompleteSignature	The request signature is invalid.
400	InvalidAction	The action %s requested is invalid.
400	InvalidParameter	The specified parameter %s is not valid.
400	InvalidParameterValue	The input parameter %s is invalid or out of range.
400	MissingAction	The action %s requested is missing.
400	MissingParameter	The input parameter %s that is mandatory for processing this request is not supplied.
400	NotAuthorized	You do not have permission to perform this action. %s
400	ThrottlingException	The request was denied due to request throttling. %s
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
404	ResourceNotFound	The resource not found by %s.
503	ServiceFailure	The request has failed due to a temporary failure of %s service.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.