Querying Job Ticket Details

Function

This API is used to query details about a 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:get	Read	-	-	-	-

URI

GET /v1/executions/{execution_id}

**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.

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	data object	Return data.

**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: Service ticket creator. Value range: N/A.
status	String	Definition: Service ticket status. Value range: Pending Running Succeed Canceling Canceled Failed Timeout
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.
tags	Array of tags objects	Definition: Service ticket tags. Value range: N/A.
target_parameter_name	String	Definition: Parameter name specified for rate mode execution. Value range: N/A.
targets	Array of Target objects	Definition: Element selected for rate mode execution. 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:

**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** tags
Parameter	Type	Description
key	String	Definition: Key of the service ticket tag. Value range: N/A.
value	String	Definition: Value of the service ticket tag. Value range: N/A.

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

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

Example Responses

Status code: 200

Request succeeded.

{
  "data" : {
    "id" : 3025,
    "execution_id" : "EX2025070121014501xxxxxx",
    "type" : "NORMAL",
    "document_name" : "test_document",
    "document_id" : "DM2025070118023901xxxxxx",
    "document_version_id" : "573634e7-5e69-4b4b-b4a1-b7433xxxxxx",
    "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" : [ ]
  }
}