Use ListDoctorJobsStats to get a summary of job statistics - E-MapReduce - Alibaba Cloud - E-MapReduce

Retrieves aggregated running statistics for multiple jobs through E-MapReduce (EMR) Doctor.

Operation description

Lists aggregated statistics for YARN-managed jobs.

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

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 used to retrieve the next page of results.	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	No	The maximum number of entries to return on each page.	20
StartRange	object	No	The start time range for filtering jobs. Only jobs whose start time falls within this range are returned.
StartTime	integer	No	The beginning of the time range. Specify a UNIX timestamp in milliseconds.	1679036826987
EndTime	integer	No	The end of the time range. Specify a UNIX timestamp in milliseconds.	1666406820000
EndRange	object	No	The end time range for filtering jobs. Only jobs whose end time falls within this range are returned.
StartTime	integer	No	The beginning of the time range. Specify a UNIX timestamp in milliseconds.	1675180800000
EndTime	integer	No	The end of the time range. Specify a UNIX timestamp in milliseconds.	1680019200000
GroupBy	array	No	The fields used to group data. Currently, only the first value is used. Multi-value combinations will be supported in the future.	null
	string	No	The field that is used for grouping data. Valid values: queue: grouping by queue user: grouping by user type: grouping by engine type	type
OrderType	string	No	The order in which you want to sort the query results. Valid values: ASC: in ascending order DESC: in descending order	ASC
OrderBy	string	No	The field used to sort the query results. Valid values: vcoreSeconds: the total vCPU-seconds consumed by the job memSeconds: the total memory-seconds consumed by the job	vcoreSeconds

Response elements

Element	Type	Description	Example
	object	The response parameters.
Data	array<object>	The summary of job information.
	array<object>
Queue	string	The YARN queue to which the job was submitted.	DW
Type	string	The type of the compute engine.	SPARK
User	string	The username used to submit the job.	DW
VcoreSeconds	object	The total vCPU-seconds consumed by the job.
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 total memory-seconds consumed by the job.
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
AppsCount	object	The total number of jobs.
Name	string	The name of the metric.	appsCount
Value	integer	The value of the metric.	123
Unit	string	The unit of the metric.	""
Description	string	The description of the metric.	Total apps count
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": [
    {
      "Queue": "DW",
      "Type": "SPARK",
      "User": "DW",
      "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"
      },
      "AppsCount": {
        "Name": "appsCount",
        "Value": 123,
        "Unit": "\"\"",
        "Description": "Total apps count"
      }
    }
  ],
  "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.