Use ListDoctorApplications to obtain job analysis results - E-MapReduce

Obtains the analysis results of multiple jobs on E-MapReduce (EMR) Doctor.

Operation description

list all doctor analysis apps

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:ListDoctorApplications

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	The pagination token that is used in the request to retrieve a new page of results.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	No	The maximum number of entries to return on each page.	20
DateTime	string	Yes	Specify the date in the ISO 8601 standard. For example, 2023-01-01 represents January 1, 2023.	2023-01-01
AppIds	array	No	The IDs of jobs that are submitted to YARN.	null
	string	No	The ID of the job that is submitted to YARN.	application_1643475036865_******
Users	array	No	The users who submit the jobs.	null
	string	No	The username that is used to submit the job to YARN.	DW
Queues	array	No	The YARN queues to which the jobs are submitted.	null
	string	No	The name of the YARN queue to which the job is submitted.	DW
Types	array	No	The YARN engines to which the jobs are submitted.	null
	string	No	The type of the YARN engine to which the job is submitted.	SPARK
OrderType	string	No	The order in which you want to sort the query results. Valid values: ASC: the ascending order DESC: the descending order	ASC
OrderBy	string	No	The field that you use to sort the query results. Valid values: startTime: the time when the job starts endTime: the time when the job ends vcoreUtilization: the vCPU utilization of the job memUtilization: the memory usage of the job 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 score: the score of the job	score

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	array<object>	The details of jobs.
	array<object>
AppId	string	The job ID in YARN. The value of QueryID or SessionID is returned for a Hive job.	application_1665056147236_*****
Ids	array	The job IDs. Multiple job IDs are separated with commas (,).	null
	string	The ID of the job that was submitted to YARN.	application_1665056147236_*****
AppName	string	The name of the job.	data-upload
User	string	The username that was used to submit the job.	DW
StartTime	integer	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.	1677465658275
EndTime	integer	The time when the job 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.	1682049088086
Queue	string	The YARN queue to which the job was submitted.	DW
Type	string	The type of the compute engine.	TEZ
QuerySql	string	The query statement. This parameter is left empty for non-SQL jobs.	SELECT id, count(1) FROM test group by id;
Metrics	object	The data about metrics.
VcoreUtilization	object	The CPU utilization. This parameter has the same meaning as %CPU in the Linux top command.
Name	string	The name of the metric.	vcoreUtilization
Value	number	The value of the metric.	23.1
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Ratio of used vcore to total available cores
MemUtilization	object	The memory usage
Name	string	The name of the metric.	memUtilization
Value	number	The value of the metric.	0.23
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Ratio of used memory to total available memory
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 amount of memory consumed.
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
Analysis	object	The analysis results of the jobs.
Score	integer	The score of the job.	23
Suggestion	string	The suggestion on executing the job.	##### Current node: container ##### Issues found: Maximum memory utilization is 7.75%, which is low Try reducing the Tez Container memory by setting hive.tez.container.size
RequestId	string	The request ID.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	A pagination token.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	The maximum number of entries returned.	20
TotalCount	integer	The total number of entries returned.	200

Examples

Success response

JSON format

{
  "Data": [
    {
      "AppId": "application_1665056147236_*****",
      "Ids": [
        "application_1665056147236_*****"
      ],
      "AppName": "data-upload",
      "User": "DW",
      "StartTime": 1677465658275,
      "EndTime": 1682049088086,
      "Queue": "DW",
      "Type": "TEZ",
      "QuerySql": "SELECT id, count(1) FROM test group by id;\n",
      "Metrics": {
        "VcoreUtilization": {
          "Name": "vcoreUtilization",
          "Value": 23.1,
          "Unit": "\"\"",
          "Description": "Ratio of used vcore to total available cores\n"
        },
        "MemUtilization": {
          "Name": "memUtilization\n",
          "Value": 0.23,
          "Unit": "\"\"",
          "Description": "Ratio of used memory to total available memory\n"
        },
        "VcoreSeconds": {
          "Name": "vcoreSeconds",
          "Value": 11123,
          "Unit": "VCores * Sec\n",
          "Description": "Total vcore usage over time in seconds"
        },
        "MemSeconds": {
          "Name": "memSeconds",
          "Value": 12312312,
          "Unit": "MB * Sec",
          "Description": "Total memory usage over time in seconds"
        }
      },
      "Analysis": {
        "Score": 23,
        "Suggestion": "##### Current node: container\n##### Issues found:\nMaximum memory utilization is 7.75%, which is low\n\n\nTry reducing the Tez Container memory by setting hive.tez.container.size"
      }
    }
  ],
  "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.