ListDoctorComputeSummary - E-MapReduce - Alibaba Cloud Documentation Center

Obtains the information about resource usage by resource type in a cluster 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

There is currently no authorization information disclosed in the API.

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: engine: filters results by engine. queue: filters results by queue. cluster: displays the results at the cluster level. 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: in ascending order. DESC: in descending order.	ASC
OrderBy	string	No	The basis on which you want to sort the query results. Valid values: vcoreSeconds: the total CPU consumption over time in seconds. memSeconds: the total memory consumption over time in seconds. vcoreUtilization: the average CPU utilization. The meaning is the same as the %CPU parameter in the output of the top command in Linux. memUtilization: the average memory usage. vcoreSecondsDayGrowthRatio: the day-to-day growth rate of the total CPU consumption over time in seconds. memSecondsDayGrowthRatio: the day-to-day growth rate of the total memory consumption over time in seconds. readSize: the total amount of data read from the file system. writeSize: the total amount of data written to the file system. healthyJobCount: the total number of healthy jobs. subHealthyJobCount: the total number of sub-healthy jobs. unhealthyJobCount: the total number of unhealthy jobs. needAttentionJobCount: the total number of jobs that require attention. score: the score for jobs. scoreDayGrowthRatio: the day-to-day growth rate of the score for jobs.	score

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
Data	array<object>	The details of resource usage.
ListDoctorComputeSummeryDTO	object
ComponentName	string	The name of the resource whose details are obtained based on the value of ComponentTypes. For example, if the value of ComponentTypes is Queue, the value of this parameter is a queue, such as DW.	DW
Metrics	object	The metric information.
VcoreSeconds	object	The total CPU consumption over time in seconds.
Name	string	The name of the metric.	vcoreSeconds
Value	long	The value of the metric.	1231412
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 consumption over time in seconds.
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
VcoreUtilization	object	The average CPU utilization. The meaning is the same as the %CPU parameter in the output of the top command in Linux.
Name	string	The name of the metric.	vcoreUtilization
Value	float	The value of the metric.	32.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 average memory usage.
Name	string	The name of the metric.	memUtilization
Value	float	The value of the metric.	0.82
Unit	string	The unit of the metric.	“”
Description	string	The description of the metric.	Ratio of used memory to total available memory
VcoreSecondsDayGrowthRatio	object	The day-to-day growth rate of the total CPU consumption over time in seconds.
Name	string	The name of the metric.	vcoreSecondsDayGrowthRatio
Value	float	The value of the metric.	0.22
Unit	string	The unit of the metric.	“”
Description	string	The description of the metric.	Growth ratio of virtual core usage in seconds per day
MemSecondsDayGrowthRatio	object	The day-to-day growth rate of the total memory consumption over time in seconds.
Name	string	The name of the metric.	memSecondsDayGrowthRatio
Value	float	The value of the metric.	0.36
Unit	string	The unit of the metric.	“”
Description	string	The description of the metric.	Growth ratio of memory usage in seconds per day
ReadSize	object	The total amount of data read from the file system.
Name	string	The name of the metric.	readSize
Value	long	The value of the metric.	504888659968
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Total cumulative size of data read in megabytes (MB)
WriteSize	object	The total amount of data written to the file system.
Name	string	The name of the metric.	writeSize
Value	long	The value of the metric.	6294093393920
Unit	string	The unit of the metric.	MB
Description	string	The description of the metric.	Total cumulative size of data written in megabytes (MB)
Analysis	object	The resource analysis results.
HealthyJobCount	long	The total number of healthy jobs.	3
SubHealthyJobCount	long	The total number of sub-healthy jobs.	13
UnhealthyJobCount	long	The total number of unhealthy jobs.	123
NeedAttentionJobCount	long	The total number of jobs that require attention.	23
Score	integer	The score for jobs.	56
ScoreDayGrowthRatio	float	The day-to-day growth rate of the score for jobs.	0.03
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 that are returned.	20
TotalCount	integer	The total number of entries returned.	200

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