Querying Job Service Tickets

Function

This API is used to query a job service ticket.

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:list	List	-	-	-	-

URI

GET /v1/executions

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Pagination parameter. Constraints: Maximum number of records returned on each page. If this parameter is not set, 10 records are queried on the first page by default. 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.
creator	No	String	Definition: Creator, which is a fuzzy search. Constraints: N/A. Value range: N/A. Default value: N/A.
start_time	No	Long	Definition: Start time. Constraints: N/A. Value range: N/A. Default value: N/A.
end_time	No	Long	Definition: End time. Constraints: N/A. Value range: N/A. Default value: N/A.
document_name	No	String	Definition: Job name, which is a fuzzy search. Constraints: N/A. Value range: N/A. Default value: N/A.
document_id	No	String	Definition: Job ID. Constraints: N/A. Value range: N/A. Default value: N/A.
tags	No	String	Definition: Tag filter criteria, for example, tags=key1=value1 and key2=value2. Constraints: N/A. Value range: N/A. Default value: N/A.
exclude_child_executions	No	Boolean	Definition: Sub-tickets are not returned during list query. 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: N/A.
error_msg	String	Definition: Error message. Value range: N/A.
data	Array of data objects	Definition: Return data. Value range: N/A.
total	Long	Definition: Total number. Value range: N/A.

**Table 3** data
Parameter	Type	Description
execution_id	String	Definition: Unique ID of a service ticket. Value range: N/A.
document_name	String	Definition: Job name. Value range: N/A.
document_id	String	Definition: Job ID. Value range: N/A.
document_version_id	String	Definition: Job version ID. Value range: N/A.
document_version	String	Definition: Job version number. Value range: N/A.
start_time	Long	Definition: Start time of service ticket execution. Value range: N/A.
end_time	Long	Definition: End time of service ticket execution. Value range: N/A.
update_time	Long	Definition: Ticket update time. Value range: N/A.
creator	String	Definition: Time when a service ticket is created. Value range: N/A.
status	String	Definition: Service ticket status. Value range: N/A.
description	String	Definition: Service ticket execution description. Value range: N/A.
parameters	Array of parameters objects	Definition: Global parameters for service ticket execution. Value range: N/A.
sys_tags	Array of sys_tags objects	Definition: System tags. Value range: N/A.
tags	Array of tags objects	Definition: List of custom tags. Value range: N/A.
type	String	Definition: Service ticket type. BATCH: batch mode. RATE_CONTROL: rate control mode. NORMAL: normal mode. BATCH RATE_CONTROL NORMAL Value range:
target_parameter_name	String	Definition: Parameter specified for rate mode execution. Value range: N/A.
targets	Array of Target objects	Definition: Element specified for rate mode execution. Value range: N/A.

**Table 4** parameters
Parameter	Type	Description
key	String	Definition: Parameter name. Value range: N/A.
value	String	Definition: Parameter value. Value range: N/A.

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

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

**Table 7** Target
Parameter	Type	Description
key	String	Definition: Speed mode execution type, InstanceValues. Value range: N/A.
values	Array of objects	Definition: Execution element in rate mode. Currently, only CloudCMDB resources are supported. Value range: N/A.

Status code: 400

**Table 8** 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 the service ticket list of a job.

GET https://{Endpoint}/v1/executions?offset=0&limit=2

Example Responses

Status code: 200

Request succeeded.

{
  "data" : [ {
    "id" : 3025,
    "execution_id" : "EX2025070121014xxxxxxx",
    "type" : "NORMAL",
    "document_name" : "test_document",
    "document_id" : "DM202507011802390xxxxxxx",
    "document_version_id" : "573634e7-5e69-4b4b-b4a1-b7xxxxxxx",
    "document_version" : "v2",
    "start_time" : 1751374905000,
    "end_time" : null,
    "update_time" : 1751374905000,
    "status" : "Pending",
    "description" : null,
    "parameters" : [ ],
    "target_parameter_name" : null,
    "targets" : null,
    "creator" : "COC-Script",
    "tags" : [ ],
    "sys_tags" : [ ]
  }, {
    "id" : 3024,
    "execution_id" : "EX2025063021172xxxxxxx",
    "type" : "NORMAL",
    "document_name" : "qweqwe",
    "document_id" : "DM202506302117010xxxxxxx",
    "document_version_id" : "6b3a059d-2cca-4bb0-82c0-e9xxxxxxx",
    "document_version" : "v1",
    "start_time" : 1751289441000,
    "end_time" : 1751289511000,
    "update_time" : 1751289512000,
    "status" : "Succeeded",
    "description" : null,
    "parameters" : [ {
      "key" : "aaa",
      "value" : "[\"qwe\",\"rew\"]"
    } ],
    "target_parameter_name" : null,
    "targets" : null,
    "creator" : "COC-Script",
    "tags" : [ ],
    "sys_tags" : [ ]
  } ],
  "total" : 718
}