ListDoctorComputeSummary - 批量获取集群资源使用结果 - 开源大数据平台E-MapReduce

通过EMR Doctor根据过滤条件批量获取集群资源使用情况。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
emr:ListDoctorComputeSummary	list	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
ClusterId	string	是	集群 ID。	c-b933c5aac8fe****
NextToken	string	否	标记当前开始读取的位置。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	否	一次获取的最大记录数。	20
DateTime	string	是	其日期和时间信息以 ISO 8601 格式表示，例如：2023 年 1 月 1 日为 2023-01-01。	2023-01-01
ComponentTypes	array	否	过滤资源的类型。取值： engine：通过引擎类型来过滤结果。 queue：通过队列来过滤结果。 cluster：展示整个集群结果。如果不填写，默认展示整个集群信息。目前只支持单资源类型，填写多个资源类型会默认取第一个资源类型。
String	string	否	资源类型。	queue
OrderType	string	否	排序方向。取值： ASC：升序排列。 DESC：降序排列。	ASC
OrderBy	string	否	排序顺序。取值： vcoreSeconds：资源 CPU 使用总量。 memSeconds：资源内存使用总量。 vcoreUtilization：资源平均 CPU 使用率。同 Linux Top 的%CPU 含义。 memUtilization：资源平均内存利用率。 vcoreSecondsDayGrowthRatio：资源 CPU 使用总量日环比。 memSecondsDayGrowthRatio：资源内存使用总量日环比。 readSize：资源读取文件系统总量。 writeSize：资源写入文件系统总量。 healthyJobCount：健康任务总数。 subHealthyJobCount：亚健康任务总数。 unhealthyJobCount：不健康任务总数。 needAttentionJobCount：需要关注的任务总数。 score：资源任务评分。 scoreDayGrowthRatio：资源任务评分日环比。	score

返回参数

名称	类型	描述	示例值
	object	返回数据
Data	array<object>	资源列表详情。
ListDoctorComputeSummeryDTO	object	资源使用详情。
ComponentName	string	根据 ComponentTypes 获取的资源详情，如 ComponentTypes 为 Queue，则会对应了某个队列的名称，如 DW 队列。	DW
Metrics	object	指标数据。
VcoreSeconds	object	资源 CPU 使用总量。
Name	string	指标名称。	vcoreSeconds
Value	long	指标值。	1231412
Unit	string	指标单位。	VCores * Sec
Description	string	指标描述。	Total vcore usage over time in seconds
MemSeconds	object	资源内存使用总量。
Name	string	指标名称。	memSeconds
Value	long	指标值。	12312312
Unit	string	指标单位。	MB * Sec
Description	string	指标描述。	Total memory usage over time in seconds
VcoreUtilization	object	资源平均 CPU 使用率。同 Linux Top 的%CPU 含义。
Name	string	指标名称。	vcoreUtilization
Value	float	指标值。	32.1
Unit	string	指标单位。	“”
Description	string	指标描述。	Ratio of used vcore to total available cores
MemUtilization	object	资源平均内存利用率。
Name	string	指标名称。	memUtilization
Value	float	指标值。	0.82
Unit	string	指标单位。	“”
Description	string	指标描述。	Ratio of used memory to total available memory
VcoreSecondsDayGrowthRatio	object	资源 CPU 使用总量日环比。
Name	string	指标名称。	vcoreSecondsDayGrowthRatio
Value	float	指标值。	0.22
Unit	string	指标单位。	“”
Description	string	指标描述。	Growth ratio of virtual core usage in seconds per day
MemSecondsDayGrowthRatio	object	资源内存使用总量日环比。
Name	string	指标名称。	memSecondsDayGrowthRatio
Value	float	指标值。	0.36
Unit	string	指标单位。	“”
Description	string	指标描述。	Growth ratio of memory usage in seconds per day
ReadSize	object	资源读取文件系统总量。
Name	string	指标名称。	readSize
Value	long	指标值。	504888659968
Unit	string	指标单位。	MB
Description	string	指标描述。	Total cumulative size of data read in megabytes (MB)
WriteSize	object	资源写入文件系统总量。
Name	string	指标名称。	writeSize
Value	long	指标值。	6294093393920
Unit	string	指标单位。	MB
Description	string	指标描述。	Total cumulative size of data written in megabytes (MB)
Analysis	object	资源分析。
HealthyJobCount	long	健康任务总数。	3
SubHealthyJobCount	long	亚健康任务总数。	13
UnhealthyJobCount	long	不健康任务总数。	123
NeedAttentionJobCount	long	需要关注的任务总数。	23
Score	integer	资源任务评分。	56
ScoreDayGrowthRatio	float	资源任务评分日环比。	0.03
RequestId	string	请求 ID。	DD6B1B2A-5837-5237-ABE4-FF0C8944****
NextToken	string	返回读取到的数据位置。	DD6B1B2A-5837-5237-ABE4-FF0C89568980
MaxResults	integer	本次请求所返回的最大记录条数。	20
TotalCount	integer	本次请求条件下的数据总量。	200

示例

正常返回示例

JSON格式

{
  "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
}

错误码

HTTP status code	错误码	错误信息	描述
400	ConflictParameters	Parameters that must not be used together. %s	多个参数间存在冲突。
400	IncompleteSignature	The request signature is invalid.	API请求签名不合法。
400	InvalidAction	The action %s requested is invalid.	不合法的Action。
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.	缺少Action参数
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.	请求超时或者服务不可用。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作

暂无变更历史