Querying Ticket Step Details

Function

This API is used to query details about service ticket execution steps.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
coc:execution:listExecutionStep	Read	-	-	-	-

URI

GET /v1/executions/{execution_id}/steps

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
execution_id	Yes	String	Definition: Ticket ID. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Pagination parameter. Constraints: Number of records displayed on each page. Value range: N/A. Default value: N/A.
offset	No	Long	Definition: Pagination parameter. Constraints: The query starts from the next data specified by offset. If this parameter is not transferred, the preset value 0 is used. Value range: N/A. Default value: N/A.
execution_step_id_list	No	Array of strings	Definition: Step ID array. Constraints: N/A. Value range: N/A. Default value: N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: For details, see Error Codes.
error_msg	String	Definition: Error message. Value range: For details, see Error Codes.
data	Array of ExecutionStep objects	Definition: Return data. Value range: N/A.
total	Long	Definition: Total number. Value range: N/A.

**Table 4** ExecutionStep
Parameter	Type	Description
execution_step_id	String	Definition: Service ticket step ID. Value range: N/A.
action	String	Definition: Atomic capability action. Value range: N/A.
start_time	Long	Definition: Start time of the service ticket step. Value range: N/A.
end_time	Long	Definition: Service ticket step end time. Value range: N/A.
message	String	Definition: Execution information of the service ticket step. Value range: N/A.
name	String	Definition: Service ticket step name. Value range: N/A.
status	String	Definition: Execution status of the service ticket step. Value range: N/A.
inputs	Array of inputs objects	Definition: Step input parameter. Value range: N/A.
outputs	Array of outputs objects	Definition: Step output parameter. Value range: N/A.
properties	Map<String,String>	Definition: Additional attributes of a service ticket step, which are stored in map format. For example, if the internal IP address is displayed, the value is {"fixed_ip": "192.168.1.xx"}. Value range: N/A.

**Table 5** inputs
Parameter	Type	Description
key	String	Definition: Parameter key. Value range: N/A.
value	String	Definition: Parameter value. Value range: N/A.

**Table 6** outputs
Parameter	Type	Description
key	String	Definition: Parameter key. Value range: N/A.
value	String	Definition: Parameter value. Value range: N/A.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: For details, see Error Codes.
error_msg	String	Definition: Error description. Value range: For details, see Error Codes.

Example Requests

Query ticket step details.

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

Example Responses

Status code: 200

Request succeeded.

{
  "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
}