获取Workflow工作流节点度量信息 - ShowWorkflowStepExecutionMetrics

功能介绍

获取Workflow工作流节点度量信息接口用于查询工作流中各节点的度量信息。

该接口适用于以下场景：当用户需要监控工作流节点的性能指标，可以通过此接口获取详细的度量数据。使用该接口的前提条件是用户已登录且具有查看工作流节点度量信息的权限。操作完成后，响应消息体中将包含指定节点的度量信息。若节点不存在或用户无权限操作，接口将返回相应的错误信息。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。获取该接口关联的CLI示例： hcloud ModelArts ShowWorkflowStepExecutionMetrics。

授权信息

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

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

  授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
  modelarts:workflow:get	Read	workflow *	-	-	-

URI

GET /v2/{project_id}/workflows/{workflow_id}/executions/{execution_id}/step-executions/{step_execution_id}/metrics

请求参数

无

响应参数

状态码：200

请求示例

获取工作流节点度量信息

GET https://{endpoint}/v2/{project_id}/workflows/{workflow_id}/executions/4dd2a2f5-bde2-45dd-af6b-5e5d570118d1/step_executions/255a1079-b00a-4c3a-8218-3458f7546b8d/metrics

响应示例

状态码：200

OK

[ {
  "created_at" : "2022-11-03T17:30:49.735253+08:00",
  "key" : "accuracy",
  "title" : "accuracy",
  "type" : "line chart",
  "data" : {
    "x_axistrhrth" : [ {
      "title" : "step",
      "value" : [ 1, 2, 3, 4, 5 ]
    }, {
      "title" : "timestamp",
      "value" : [ 1667467812015, 1667467817223, 1667467822783, 1667467828078, 1667467833344 ]
    } ],
    "y_axishdsfgsdvg" : [ {
      "title" : "value",
      "value" : [ 0.5, 0.6, 0.7, 0.8, 0.9 ]
    } ],
    "z_wefwe" : [ ]
  }
}, {
  "created_at" : "2022-11-03T17:30:49.009943+08:00",
  "key" : "loss",
  "title" : "loss",
  "type" : "line chart",
  "data" : {
    "x_axis" : [ {
      "title" : "step",
      "value" : [ 1, 2, 3, 4, 5 ]
    }, {
      "title" : "timestamp",
      "value" : [ 1667467811884, 1667467817178, 1667467822255, 1667467827822, 1667467833115 ]
    } ],
    "y_axis" : [ {
      "title" : "value",
      "value" : [ 0.5, 0.6, 0.7, 0.8, 0.9 ]
    } ]
  }
} ]

状态码

错误码

请参见错误码。