Obtain job running information and metrics with GetDoctorJob - E-MapReduce - Alibaba Cloud - E-MapReduce

Queries the basic running information about a job by using EMR Doctor.

Operation description

Get realtime job 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:GetDoctorJob

get

*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****
AppId	string	Yes	The ID of the job that is submitted to YARN.	application_1542620905989_****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	object	The information about the job.
AppId	string	The ID of the job that was submitted to YARN.	application_1542620905989_****
AppName	string	The name of the job.	CREATE TABLE test...ranks=1 (Stage-1)
User	string	The username used to submit the job.	DW
Queue	string	The YARN queue to which the job was submitted.	DW
State	string	The running state of the job. Valid values: FINISHED FAILED KILLED	FINISHED
FinalStatus	string	The final state of the job. Valid values: SUCCEEDED FAILED KILLED ENDED UNDEFINED	KILLED
Type	string	The type of the compute engine.	SPARK
StartTime	integer	The time when the job was submitted. The value is a UNIX timestamp. Unit: milliseconds.	1673946000000
LaunchTime	integer	The time when the job was started. The value is a UNIX timestamp. Unit: milliseconds.	1665014400000
ElapsedTime	integer	The total running time of the job. Unit: milliseconds.	278
FinishTime	integer	The time when the job ended. The value is a UNIX timestamp. Unit: milliseconds.	1658388322000
Metrics	object	The metric data.
VcoreSeconds	object	The CPU usage.
Name	string	The name of the metric.	vcoreSeconds
Value	integer	The value of the metric.	11123
Unit	string	The unit of the metric.	VCores * Sec
Description	string	The description of the metric.	Total vcore usage over time in seconds
MemSeconds	object	The memory usage.
Name	string	The name of the metric.	memSeconds
Value	integer	The value of the metric.	12312312
Unit	string	The unit of the metric.	MB * Sec
Description	string	The description of the metric.	Total memory usage over time in seconds
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Success response

JSON format

{
  "Data": {
    "AppId": "application_1542620905989_****",
    "AppName": "CREATE TABLE test...ranks=1 (Stage-1)",
    "User": "DW",
    "Queue": "DW",
    "State": "FINISHED",
    "FinalStatus": "KILLED",
    "Type": "SPARK",
    "StartTime": 1673946000000,
    "LaunchTime": 1665014400000,
    "ElapsedTime": 278,
    "FinishTime": 1658388322000,
    "Metrics": {
      "VcoreSeconds": {
        "Name": "vcoreSeconds",
        "Value": 11123,
        "Unit": "VCores * Sec",
        "Description": "Total vcore usage over time in seconds"
      },
      "MemSeconds": {
        "Name": "memSeconds",
        "Value": 12312312,
        "Unit": "MB * Sec",
        "Description": "Total memory usage over time in seconds"
      }
    }
  },
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

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.