All Products
Search
Document Center

E-MapReduce:GetDoctorApplication

Last Updated:Dec 12, 2024

Obtains job analysis information 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
emr:GetDoctorApplicationget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
ClusterIdstringYes

The cluster ID.

c-b933c5aac8fe****
AppIdstringYes

The ID of the job that is submitted to YARN.

application_1542620905989_****
DateTimestringYes

Specify the date in the ISO 8601 standard. For example, 2023-01-01 represents January 1, 2023.

2023-01-01

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The details of the job.

AppNamestring

The name of the job.

CREATE TABLE test...ranks=1 (Stage-1)
Idsarray

The job IDs. Multiple job IDs are separated with commas (,).

Stringstring

The job ID in YARN.

application_1643475036865_******
Userstring

The username that is used to submit the job.

DW
StartTimelong

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
EndTimelong

The end time of the job. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. Unit: milliseconds.

1666213200000
Queuestring

The YARN queue to which the job was submitted.

DW
Typestring

The type of the compute engine.

SPARK
QuerySqlstring

The SQL statement of the job. This parameter is left empty for non-SQL jobs.

SELECT id, count(1) FROM test group by id;
Metricsobject

The metric information.

VcoreUtilizationobject

The CPU utilization. The meaning is the same as that of the %CPU command in the output of the Linux top command.

Namestring

The name of the metric.

vcoreUtilization
Valuefloat

The value of the metric.

32.1
Unitstring

The unit of the metric.

“”
Descriptionstring

The description of the metric.

Ratio of used vcore to total available cores
MemUtilizationobject

The memory usage.

Namestring

The name of the metric.

memUtilization
Valuefloat

The value of the metric.

0.82
Unitstring

The unit of the metric.

“”
Descriptionstring

The description of the metric.

Ratio of used memory to total available memory
VcoreSecondsobject

The aggregated number of vCPUs that are allocated to the job multiplied by the number of seconds the job has been running.

Namestring

The name of the metric.

vcoreSeconds
Valuelong

The value of the metric.

11123
Unitstring

The unit of the metric.

VCores * Sec
Descriptionstring

The description of the metric.

Total vcore usage over time in seconds
MemSecondsobject

The aggregated amount of memory that is allocated to the job multiplied by the number of seconds the job has been running.

Namestring

The name of the metric.

memSeconds
Valuelong

The value of the metric.

12312312
Unitstring

The unit of the metric.

MB * Sec
Descriptionstring

The description of the metric.

Total memory usage over time in seconds
Analysisobject

The job analysis result.

Scoreinteger

The score of the job.

67
Suggestionstring

The suggestion for running the job.

RequestIdstring

The request ID.

DD6B1B2A-5837-5237-ABE4-FF0C8944****

Examples

Sample success responses

JSONformat

{
  "Data": {
    "AppName": "CREATE TABLE test...ranks=1 (Stage-1)",
    "Ids": [
      "application_1643475036865_******"
    ],
    "User": "DW",
    "StartTime": 1677465658275,
    "EndTime": 1666213200000,
    "Queue": "DW",
    "Type": "SPARK",
    "QuerySql": "SELECT id, count(1) FROM test group by id;",
    "Metrics": {
      "VcoreUtilization": {
        "Name": "vcoreUtilization",
        "Value": 32.1,
        "Unit": "“”",
        "Description": "Ratio of used vcore to total available cores"
      },
      "MemUtilization": {
        "Name": "memUtilization",
        "Value": 0.82,
        "Unit": "“”",
        "Description": "Ratio of used memory to total available memory"
      },
      "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"
      }
    },
    "Analysis": {
      "Score": 67,
      "Suggestion": ""
    }
  },
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

Error codes

HTTP status codeError codeError message
400ConflictParametersParameters that must not be used together. %s
400IncompleteSignatureThe request signature is invalid.
400InvalidActionThe action %s requested is invalid.
400InvalidParameterThe specified parameter %s is not valid.
400InvalidParameterValueThe input parameter %s is invalid or out of range.
400MissingActionThe action %s requested is missing.
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.
400NotAuthorizedYou do not have permission to perform this action. %s
400ThrottlingExceptionThe request was denied due to request throttling. %s
404ResourceNotFoundThe resource not found by %s.
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.
503ServiceFailureThe request has failed due to a temporary failure of %s service.
503ServiceUnavailableThe 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 timeSummary of changesOperation
No change history