GetMetrics - 获取任务指标-人工智能平台 PAI(PAI)-阿里云帮助中心

获取metrics数据

接口说明

请求说明

该接口用于查询指定命名空间（Namespace）下的特定作业（JobId）或维度（Dimensions）的监控指标。
支持自定义查询的时间范围，默认为最近一小时的数据。
可以选择不同的时间间隔（Period）来获取更细粒度或更粗略的数据点。
如果需要分页获取大量数据，可以通过NextToken参数进行翻页操作。
MetricName是必填项，用来指定要查询的具体监控指标名称。
对于某些高级功能或者特定类型的监控指标，请参考相关文档以了解更多信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

paidlc:GetMetrics

none

*全部资源

*

无

请求语法

GET /api/v1/cms/metrics HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
Namespace	string	否	云产品的数据命名空间。关于云产品的数据命名空间，请参见云产品监控项。	acs_pai_dlc
JobId	string	否	任务 ID。	dlckjd5hm84tmjec
Dimensions	string	否	（必填）请求参数。	[{\"jobId\":\"dlcdpfpc96mh63mg\",\"pod\":\"dlcdpfpc96mh63mg-worker-748\",\"regionId\":\"cn-wulanchabu\",\"userId\":\"1458867964644701\"}]
Length	string	否	每次查询大小，用于分页查询，默认值为 1000。	5000
EndTime	string	否	查询的截止时间，默认值：当前。	2020-11-09T16:00:00Z
Period	string	否	监控数据的统计周期。单位：秒。取值：15、60、900 和 3600。	5
NextToken	string	否	分页游标标识。说明如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的 NextToken 作为参数再次请求获得下一页的数据，直到返回为 Null 为止，表示获取到了所有的数据。	2c6b65b6f9d625d4716568ca19b2064be0b5e8707e68181f
MetricName	string	否	metric 名称。未填充，不在使用中	JOB_MEMORY_FREE
StartTime	string	否	查询监控数据的时间区间的起始时间（UTC），默认值是 1 小时前。	2020-11-08T16:00:00Z
Token	string	否	用于鉴权的临时令牌。	eyXXXX-XXXX.XXXXX

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Code	string	状态码。说明 200 表示成功。	200
DataPoints	string	监控指标数据内容。	[{'Content': '', 'OperationName': 'purchase', 'Success': 1, 'Id': '217', 'LogDatetime': 1687679582923}]
Message	string	检测结果具体信息。	Success.
NextToken	string	Id of the request	AAAAAV3MpHK1AP0pfERHZN5pu6lESTRpd5hnHNnmKOP/+w9F
Period	string	监控数据的统计周期。取值：15、60、900 和 3600。单位：秒。说明如果不设置统计周期，则按照注册监控项时申请的上报周期来查询监控数据。每个云产品的监控项（MetricName）的统计周期不同。更多信息，请参见云产品监控项。	5
RequestId	string	请求 ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
Success	boolean	操作是否成功。取值：true：成功。false：失败。	True

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "DataPoints": "[{'Content': '', 'OperationName': 'purchase', 'Success': 1, 'Id': '217', 'LogDatetime': 1687679582923}]",
  "Message": "Success.",
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6lESTRpd5hnHNnmKOP/+w9F",
  "Period": "5",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "Success": true
}

错误码

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

变更历史

更多信息，参考变更详情。