查询端点监控 - ShowV2EndpointsMetrics

功能介绍

查询端点CPU、MEM、NPU、GPU监控数据。此接口为同步接口。

调用方法

URI

GET /v2/workspaces/{workspace_id}/endpoints/{endpoint_id}/metrics

表1 路径参数
参数	是否必选	参数类型	描述
workspace_id	是	String	参数解释：工作空间ID。约束限制：不涉及。取值范围：长度为32~36的英文字符、数字和中划线的组合。默认取值：不涉及。
endpoint_id	是	String	参数解释：端点ID。约束限制：不涉及。取值范围：长度为32~36的英文字符、数字和中划线的组合。默认取值：不涉及。

表2 Query参数
参数	是否必选	参数类型	描述
step	是	Integer	参数解释：查询时间步长。约束限制：不涉及。取值范围：单位秒。 60：每分钟一个点。 3600：每1小时一个点。 86400：每天一个点。默认取值：60。
metric_name	是	String	参数解释：指标名称，可以取值多个，多个值用逗号分隔。约束限制： aura_job：端点监控指标。 spark（SPARK_JOB / SPARK_SQL）：端点监控指标。取值范围：不涉及。默认取值：不涉及。
start_time	是	Long	参数解释：开始时间。约束限制：不涉及。取值范围：时间戳，单位秒。默认取值：不涉及。
end_time	是	Long	参数解释：结束时间。约束限制：不涉及。取值范围：时间戳，单位秒。默认取值：不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。约束限制：不涉及。取值范围：长度不超过65534个字符。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
data	Array of V2EndpointMetrics objects	参数解释：端点指标信息。

表5 V2EndpointMetrics
参数	参数类型	描述
collection_time	Integer	参数解释：数据时间（秒）。取值范围：不涉及。
values	Array of V2EndpointMetric objects	参数解释：端点指标值列表。

表6 V2EndpointMetric
参数	参数类型	描述
metric_name	String	参数解释：指标名称。取值范围： aura_job：端点监控指标。 spark（SPARK_JOB / SPARK_SQL）：端点监控指标。
metric_value	Number	参数解释：指标值。取值范围：不涉及。

状态码：400

表7 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

状态码：401

表8 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

状态码：403

表9 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

状态码：408

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案描述。取值范围：长度为0~4096个字符。

状态码：500

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：长度为8~36个字符。
error_msg	String	参数解释：错误描述。取值范围：长度为2~512个字符。
solution_msg	String	参数解释：解决方案。取值范围：长度为0~4096个字符。

请求示例

查询指定端点在“2026-06-16 13:50:00”到“2026-06-16 13:51:00”之间的“CPU使用率”指标数据，数据步长为“1分钟”。

GET /v2/workspaces/{workspace_id}/endpoints/{endpoint_id}/metrics?start_time=1781589000&end_time=1781589060&step=60&metric_name=CPU_RATE

响应示例

状态码：200

请求成功。

[ {
  "collection_time" : 1781589000,
  "values" : [ {
    "metric_name" : "CPU_RATE",
    "metric_value" : 0.5
  } ]
} ]

状态码：400

请求参数错误。

{
  "error_code" : "AIDataLake.00010011",
  "error_msg" : "Invalid specification code.",
  "solution_msg" : "Enter a correct specification code."
}

状态码：401

未授权。

{
  "error_code" : "APIGW.0301",
  "error_msg" : "Incorrect IAM authentication information decrypt token fail"
}

状态码：403

禁止访问。

{
  "error_code" : "AIDataLake.00010038",
  "error_msg" : "Unauthorized requests.",
  "solution_msg" : "Check permissions {xxx} and retry after authorization."
}

状态码：408

请求超时。

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

状态码：500

内部服务器错误。

{
  "error_code" : "AIDataLake.00010067",
  "error_msg" : "Failed to initialize the task because the number of tasks may have reached the upper limit.",
  "solution_msg" : "Try again later."
}