文档首页/云运维中心 COC/API参考/API/作业管理/查询工单步骤详情 - ListExecutionSteps
更新时间：2025-11-03 GMT+08:00
查看PDF
分享

查询工单步骤详情 - ListExecutionSteps

功能介绍

查询用户工单步骤详情。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    coc:execution:listExecutionStep

    Read

    -

    -

    -

    -

URI

GET /v1/executions/{execution_id}/steps

表1 路径参数

参数

是否必选

参数类型

描述

execution_id

是

String

参数解释：

工单id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

参数解释：

分页参数。

约束限制：

每页显示的条目数量。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Long

参数解释：

分页参数。

约束限制：

从offset指定的下一条数据开始查询，不传默认0。

取值范围：

不涉及。

默认取值：

不涉及。

execution_step_id_list

否

Array of strings

参数解释：

步骤id数组。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

参见错误码章节。

error_msg

String

参数解释：

错误信息。

取值范围：

参见错误码章节。

data

Array of ExecutionStep objects

参数解释：

返回数据。

取值范围：

不涉及。

total

Long

参数解释：

总数。

取值范围：

不涉及。

表4 ExecutionStep

参数

参数类型

描述

execution_step_id

String

参数解释：

工单步骤id。

取值范围：

不涉及。

action

String

参数解释：

原子能力action。

取值范围：

不涉及。

start_time

Long

参数解释：

工单步骤开始时间。

取值范围：

不涉及。

end_time

Long

参数解释：

工单步骤结束时间。

取值范围：

不涉及。

message

String

参数解释：

工单步骤执行信息。

取值范围：

不涉及。

name

String

参数解释：

工单步骤名称。

取值范围：

不涉及。

status

String

参数解释：

工单步骤执行状态。

取值范围：

  • Pending：暂停。

  • Running：运行中。

  • Succeed：成功。

  • Canceling：取消中。

  • Canceled：取消。

  • Failed：失败。

  • Timeout：超时。

inputs

Array of inputs objects

参数解释：

步骤输入参数。

取值范围：

不涉及。

outputs

Array of outputs objects

参数解释：

步骤输出参数。

取值范围：

不涉及。

properties

Map<String,String>

参数解释：

工单步骤附加属性，map形式存储，如展示内网ip，则为{"fixed_ip": "192.168.1.xx"}。

取值范围：

不涉及。

表5 inputs

参数

参数类型

描述

key

String

参数解释：

参数的key。

取值范围：

不涉及。

value

String

参数解释：

参数的value。

取值范围：

不涉及。

表6 outputs

参数

参数类型

描述

key

String

参数解释：

参数的key。

取值范围：

不涉及。

value

String

参数解释：

参数的value。

取值范围：

不涉及。

状态码：400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

参见错误码章节。

error_msg

String

参数解释：

错误描述。

取值范围：

参见错误码章节。

请求示例

查询工单步骤详情。

GET https://{Endpoint}/v1/executions/{execution_id}/steps

响应示例

状态码：200

请求成功。

{
  "data" : [ {
    "execution_step_id" : "EXS20250701210145xxxxxx",
    "action" : "hwc:runbook:suspend@1.0.0",
    "name" : "pause",
    "start_time" : null,
    "end_time" : null,
    "status" : "Pending",
    "message" : null,
    "inputs" : [ ],
    "outputs" : [ ]
  } ],
  "total" : 1
}

状态码

状态码

描述

200

请求成功。

400

包含错误信息。

更多状态码请参考状态码。

错误码

请参见错误码。

父主题：作业管理

相关文档