Obtains the information about resource usage by resource type in a cluster on E-MapReduce (EMR) Doctor.
Debugging
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 Resourcesis 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:ListDoctorComputeSummary | list | *All Resources * |
| 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 |
| ComponentTypes | array | No | The resource types, which are used to filter query results. Valid values:
If you do not specify this parameter, the information at the cluster level is displayed by default. Currently, only one resource type is supported. If you specify multiple resource types, the first resource type is used by default. | |
| String | string | No | The resource type. | queue |
| OrderType | string | No | The order in which you want to sort the query results. Valid values:
| ASC |
| OrderBy | string | No | The basis on which you want to sort the query results. Valid values:
| score |
Response parameters
Examples
Sample success responses
JSONformat
{
"Data": [
{
"ComponentName": "DW",
"Metrics": {
"VcoreSeconds": {
"Name": "vcoreSeconds",
"Value": 1231412,
"Unit": "VCores * Sec",
"Description": "Total vcore usage over time in seconds\n"
},
"MemSeconds": {
"Name": "memSeconds",
"Value": 12312312,
"Unit": "MB * Sec",
"Description": "Total memory usage over time in seconds"
},
"VcoreUtilization": {
"Name": "vcoreUtilization",
"Value": 32.1,
"Unit": "“”",
"Description": "Ratio of used vcore to total available cores\n"
},
"MemUtilization": {
"Name": "memUtilization",
"Value": 0.82,
"Unit": "“”",
"Description": "Ratio of used memory to total available memory\n"
},
"VcoreSecondsDayGrowthRatio": {
"Name": "vcoreSecondsDayGrowthRatio\n",
"Value": 0.22,
"Unit": "“”",
"Description": "Growth ratio of virtual core usage in seconds per day\n"
},
"MemSecondsDayGrowthRatio": {
"Name": "memSecondsDayGrowthRatio",
"Value": 0.36,
"Unit": "“”",
"Description": "Growth ratio of memory usage in seconds per day\n"
},
"ReadSize": {
"Name": "readSize",
"Value": 504888659968,
"Unit": "MB",
"Description": "Total cumulative size of data read in megabytes (MB)\n"
},
"WriteSize": {
"Name": "writeSize\n",
"Value": 6294093393920,
"Unit": "MB\n",
"Description": "Total cumulative size of data written in megabytes (MB)"
}
},
"Analysis": {
"HealthyJobCount": 3,
"SubHealthyJobCount": 13,
"UnhealthyJobCount": 123,
"NeedAttentionJobCount": 23,
"Score": 56,
"ScoreDayGrowthRatio": 0.03
}
}
],
"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