Help Center/ Cloud Operations Center/ API Reference/ API/ Job Management/ Querying Batch Instances of a User Service Ticket

Updated on 2025-12-01 GMT+08:00

View PDF

Querying Batch Instances of a User Service Ticket

Function

This API is used to query the service ticket batch instance, for example, the ECS instance in the batch script operations.

URI

GET /v1/executions/instances

**Table 1** 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	Integer	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	No	String	Definition: Service ticket step ID. Constraints: N/A. Value range: N/A. Default value: N/A.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** 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 data objects	Definition: Batch instance list. Value range: N/A.
total	Long	Definition: Total number. Value range: N/A.

**Table 3** data
Parameter	Type	Description
id	Integer	Definition: Batch execution instance ID. Value range: N/A.
execution_instance_id	String	Definition: Service ticket instance ID. Value range: N/A.
execution_step_id	String	Definition: Service ticket step ID. Value range: N/A.
start_time	Long	Definition: Start time of instance execution. Value range: N/A
end_time	Long	Definition: End time of instance execution. Value range: N/A.
status	String	Definition: Instance execution status. Value range: Running: running Succeed: successful Canceled: canceled Failed: failed
message	String	Definition: Instance execution information. Value range: N/A.
properties	Map<String,String>	Definition: Information about instances in a batch recorded in map format If scripts are executed in batches, information about instances in the batch is recorded. If APIs are called in batches in a loop, the API calling parameters and results are recorded. { "agent_id": "c30c90ac18124a4490ce49xxx", "fixed_ip": "192.168.1.xxx", "resource_name": "ecs-xx-xx", "region_id": "cn-north-x", "provider": "ecs", "region_id": "cn-north-x", "resource_id": "25aaed31-80f1-4976-8xxxxxxx", "type": "cloudservers" } Value range: N/A.

Status code: 400

**Table 4** 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

This API is used to query the service ticket batch instance, for example, the ECS instance in the batch script operations.

GET https://{Endpoint}/v1/executions/instances?execution_step_id=EXS2025062314121901xxxxx&offset=0&limit=10

Example Responses

Status code: 200

Request succeeded.

{
  "data" : [ {
    "id" : 4482,
    "execution_instance_id" : "EXI202506231412xxxxxxx",
    "execution_step_id" : "EXS202506231412xxxxxxx",
    "status" : "Failed",
    "start_time" : 1750659139000,
    "end_time" : 1750659210000,
    "message" : null,
    "properties" : {
      "provider" : "ecs",
      "type" : "cloudservers",
      "properties" : {
        "host_name" : "coc-platform-gamxxxxxxx",
        "fixed_ip" : null,
        "floating_ip" : null
      },
      "resource_id" : "a4594206-05ee-41fd-84xxxxxxx",
      "agent_sn" : null,
      "enterprise_project_id" : "9d414beb-88b7-4ea8-9e61-1xxxxxxx",
      "project_id" : "10a6c23c2a1044779794798xxxxxxx",
      "region_id" : "cn-north-7"
    }
  }, {
    "id" : 4483,
    "execution_instance_id" : "EXI20250623141219xxxxxxx",
    "execution_step_id" : "EXS202506231412xxxxxxx",
    "status" : "Failed",
    "start_time" : 1750659139000,
    "end_time" : 1750659210000,
    "message" : null,
    "properties" : {
      "provider" : "ecs",
      "type" : "cloudservers",
      "properties" : {
        "host_name" : "coc-cube-cn-north-7-gamxxxxxxx",
        "fixed_ip" : "10.2.51.200",
        "floating_ip" : null
      },
      "resource_id" : "adfbb61d-bdcd-46bb-9b32-edxxxxxxx",
      "agent_sn" : "2bc74fbce77d4528b59810xxxxxxx",
      "enterprise_project_id" : "b022c6d1-4af5-46dd-8exxxxxxx",
      "project_id" : "10a6c23c2a10447797947xxxxxxx",
      "region_id" : "cn-north-x"
    }
  } ],
  "total" : 2
}