查询工单步骤详情
功能介绍
查询工单步骤详情。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/executions/{execution_id}/steps
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
execution_id |
是 |
String |
参数解释: 工单id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
limit |
否 |
Integer |
参数解释: 分页参数。 约束限制: 每页显示的条目数量。 取值范围: 不涉及。 默认取值: 不涉及。 |
offset |
否 |
Long |
参数解释: 分页参数。 约束限制: 从offset指定的下一条数据开始查询,不传默认0。 取值范围: 不涉及。 默认取值: 不涉及。 |
execution_step_id_list |
否 |
Array of strings |
参数解释: 步骤id数组。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 参见错误码章节。 |
error_msg |
String |
参数解释: 错误信息。 取值范围: 参见错误码章节。 |
data |
Array of ExcutionStep objects |
参数解释: 返回数据。 取值范围: 不涉及。 |
total |
Long |
参数解释: 总数。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
execution_step_id |
String |
参数解释: 工单步骤id。 取值范围: 不涉及。 |
action |
String |
参数解释: 原子能力action。 取值范围: 不涉及。 |
start_time |
Long |
参数解释: 工单步骤开始时间。 取值范围: 不涉及。 |
end_time |
Long |
参数解释: 工单步骤结束时间。 取值范围: 不涉及。 |
message |
String |
参数解释: 工单步骤执行信息。 取值范围: 不涉及。 |
name |
String |
参数解释: 工单步骤名称。 取值范围: 不涉及。 |
status |
String |
参数解释: 工单步骤执行状态。 取值范围: 不涉及。 |
inputs |
Array of inputs objects |
参数解释: 步骤输入参数。 取值范围: 不涉及。 |
outputs |
Array of outputs objects |
参数解释: 步骤输出参数。 取值范围: 不涉及。 |
properties |
Map<String,String> |
参数解释: 工单步骤附加属性,map形式存储,如展示内网ip,则为{"fixed_ip": "192.168.1.xx"}。 取值范围: 不涉及。 |
状态码:400
请求示例
查询工单步骤详情。
GET https://{Endpoint}/v1/executions/{execution_id}/steps
响应示例
状态码:200
请求成功。
{ "data" : [ { "id" : 10576, "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 |
包含错误信息。 更多状态码请参考状态码。 |
错误码
请参见错误码。