ListDoctorApplications - E-MapReduce - Alibaba Cloud Documentation Center

Obtains the analysis results of multiple jobs 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
emr:ListDoctorApplications	list	All Resources ``	none	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.
String	string	No	The ID of the job that is submitted to YARN.	application_1643475036865_******
Users	array	No	The users who submit the jobs.
String	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.
String	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.
String	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 parameters

Parameter	Type	Description	Example
	object	The response parameters.
Data	array<object>	The details of jobs.
ListDoctorApplicationsDTO	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 (,).
String	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	long	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	long	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	float	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	float	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	long	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	long	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.
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

Sample success responses

JSONformat

{
  "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": ""
      }
    }
  ],
  "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
404	ResourceNotFound	The resource not found by %s.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.
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.

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

Change history

Change time	Summary of changes	Operation

No change history