文档首页/数智融合计算服务 DataArts Fabric/API参考/API/端点管理/查询端点资源监控 - ShowEndpointMetrics
更新时间：2025-12-23 GMT+08:00
查看PDF
分享

查询端点资源监控 - ShowEndpointMetrics

功能介绍

查询端点监控，可根据指标名称查询对应的资源使用信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    DataArtsFabric:endpoint:show

    Read

    workspace *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId

    -

    -

    endpoint *

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

参数解释：工作空间ID，获取方法，请参见获取工作空间ID。

约束限制：不涉及。

取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

endpoint_id

是

String

参数解释：端点ID。获取方法，请参见获取端点ID。

约束限制：不涉及。

取值范围：长度为[1,36]的英文字符、数字和中划线(-)的组合。

默认取值：不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

metric_name

是

String

  • 参数解释：指标名称。

  • 约束限制：不涉及。

  • 取值范围：

    • endpoint_dcu_usage：Sql端点DCU资源使用量。

    • endpoint_session_active：Sql端点活跃session。

    • QUERY_HISTORY_COUNT：历史topsql执行数量趋势。

    • QUERY_HISTORY_MAX_DURATION：历史topsql平均执行时间。

    • QUERY_HISTORY_MIN_DURATION：历史topsql最小执行时间。

    • QUERY_HISTORY_AVG_DURATION：历史topsql最大执行时间。

  • 默认取值：不涉及。

start_time

是

Long

  • 参数解释：开始时间。

  • 约束限制：不涉及。

  • 取值范围：时间戳，单位秒。

  • 默认取值：不涉及。

end_time

是

Long

  • 参数解释：结束时间。

  • 约束限制：不涉及。

  • 取值范围：时间戳，单位秒。

  • 默认取值：不涉及。

step

否

Integer

  • 参数解释：查询时间步长。

  • 约束限制：不涉及。

  • 取值范围：单位秒。

    • 60: 每分钟一个点

    • 300: 每5分钟一个点

    • 1200: 每20分钟一个点

    • 3600: 每1小时一个点

    • 14400: 每4小时一个点

    • 86400: 每天一个点

  • 默认取值：300。

statistical_type

否

String

  • 参数解释：统计方式。

  • 约束限制：不涉及。

  • 取值范围：单位秒。

    • avg_over_time: 平均值

    • min_over_time: 最小值

    • max_over_time: 最大值

  • 默认取值：avg_over_time。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释：租户Token。用于调用接口的认证。获取方法，请参见认证鉴权。

约束限制：不涉及。

取值范围：长度不超过65534个字符。

默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data

Object

  • 参数解释：指标数据。

  • 约束限制：不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：408

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

状态码：500

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：错误码。

约束限制：不涉及。

取值范围：长度为[8,36]个字符。

默认取值：不涉及。

error_msg

String

参数解释：错误描述。

约束限制：不涉及。

取值范围：长度为[2,512]个字符。

默认取值：不涉及。

solution_msg

String

参数解释：解决方案描述。

约束限制：不涉及。

取值范围：长度为[0,4096]个字符。

默认取值：不涉及。

请求示例

GET https://{endpoint}/v1/workspaces/{workspace_id}/endpoints/{endpoint_id}/metrics

响应示例

状态码：200

端点指标查询响应。

{
  "data" : [ {
    "values" : [ {
      "collectionTime" : 1757916260,
      "value" : 0.25
    }, {
      "collectionTime" : 1757916440,
      "value" : 0.125
    }, {
      "collectionTime" : 1757916560,
      "value" : 0.125
    }, {
      "collectionTime" : 1757916860,
      "value" : 0.375
    }, {
      "collectionTime" : 1757917160,
      "value" : 0.375
    }, {
      "collectionTime" : 1757917760,
      "value" : 0.375
    } ],
    "dimensions" : {
      "domainId" : "0c1ce5af27d24f3b9ddeba857a869bd1",
      "endpoint" : "0288b810-d119-4d51-b6d5-fccee06e209f",
      "namespace" : "ailake.fabric",
      "workspace" : "fcb4f34b-fbef-4c06-a43f-c86e0909d1eb"
    }
  } ]
}

状态码：400

BadRequest

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

状态码：401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码：403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "title" : "Forbidden"
  },
  "error_code" : 403,
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

状态码：408

Request Time-out

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

状态码：500

InternalServerError

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

状态码

状态码

描述

200

端点指标查询响应。

400

BadRequest

401

Unauthorized

403

Forbidden

408

Request Time-out

500

InternalServerError

错误码

请参见错误码。

父主题：端点管理

相关文档