Displaying Basic Information about Script Service Tickets

Function

This API is used to query the basic execution information about the script service ticket.

Constraints

Returned information: execution type, execution name, creator, creation time, end time, execution status, and tag (script ID, script name, script execution parameters, execution user, timeout duration, and success rate threshold).

The key in consumption labels of different task types is different.

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:job:get	Read	job *	-	-	-
coc:job:get	Read	-	coc:JobType	-	-

URI

GET /v1/job/script/orders/{execute_uuid}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
execute_uuid	Yes	String	Definition: Execution ID of a script service ticket, which is obtained from the response bodies of executeJobScript and ListJobScriptOrders. Constraints: N/A. Value range: N/A. Default value: N/A.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: Tenant token. Constraints: Tenant token obtained from IAM. Value range: N/A. Default value: N/A.
X-Language	No	String	Definition: Internationalization tag. zh-cn indicates Chinese, and en-us or no value indicates English. Constraints: zh-cn indicates Chinese, and en-us or no value indicates English. Value range: zh-cn and en-us Default value: N/A.
x-project-id	No	String	Definition: The project ID. Constraints: Project ID corresponding to the region. Value range: N/A. Default value: N/A.
x-user-profile	No	String	Definition: IAM 5.0 user information. Constraints: N/A. Value range: N/A. Default value: N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
data	JobScriptOrderInfoModel object	Definition: Returned result. Value range: N/A.

**Table 4** JobScriptOrderInfoModel
Parameter	Type	Description
execute_uuid	String	Definition: Execution UUID. Value range: N/A.
gmt_created	Long	Definition: Execution creation time. Value range: N/A.
gmt_finished	Long	Definition: Execution completion time. Value range: N/A.
execute_costs	Long	Definition: Execution duration, in seconds. Value range: N/A.
creator	String	Definition: Creator. Value range: N/A.
status	String	Definition: Execution status. Value range: The value can be READY, PROCESSING, ABNORMAL, PAUSED, CANCELED, and FINISHED.
properties	JobScriptOrderInfoProp object	Definition: Attributes, including script ID, script name, script execution parameters, execution user, timeout interval, success rate threshold, and index of the current execution batch. Value range: N/A.

**Table 5** JobScriptOrderInfoProp
Parameter	Type	Description
script_uuid	String	Definition: Script UUID. Value range: N/A.
script_name	String	Definition: Script name. Value range: N/A.
script_version_uuid	Long	Definition: Script version UUID. Value range: N/A.
script_version_name	String	Definition: Script version name. Value range: N/A.
current_execute_batch_index	Integer	Definition: Index of the current execution batch. Value range: N/A.
execute_param	ScriptExecuteParam object	Definition: Script execution parameters, execution user, timeout interval, and success rate threshold. Value range: N/A.

**Table 6** ScriptExecuteParam
Parameter	Type	Description
resourceful	Boolean	Definition: This parameter has been discarded and does not take effect when it is transferred. Constraints: N/A. Value range: N/A. Default value: N/A.
timeout	Integer	Definition: Timeout. Constraints: The unit is second. The value range is 5 < timeout < 1800. Value range: N/A. Default value: N/A.
success_rate	Double	Definition: Success rate. Constraints: A value with one decimal place is supported. Value range: 1–100 Default value: N/A.
execute_user	String	Definition: User who executes the script. The script must be executed by user root. Constraints: N/A. Value range: N/A. Default value: N/A.
script_params	Array of ScriptExecuteInputParam objects	Definition: Script input parameters. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 7** ScriptExecuteInputParam
Parameter	Type	Description
param_name	String	Definition: Name of a script input parameter. The parameter name must be unique in the same script. Constraints: N/A. Value range: N/A. Default value: N/A.
param_value	String	Definition: Value of the script input parameter, which is mandatory by default. This parameter can be left empty when there are referenced parameters (param_refer is not empty). Constraints: The parameter value contains 1 to 4096 characters. The value can contain uppercase letters, lowercase letters, digits, and special characters (_-/.?:",=+@#[{]}). Consecutive periods (.) are not allowed. Value range: N/A. Default value*: N/A.
param_order	Integer	Definition: This parameter has been discarded and does not take effect when it is configured. Constraints: N/A. Value range: N/A. Default value: N/A.
param_refer	ScriptExecuteParamReference object	Definition: Parameter reference. Constraints: N/A. Value range: N/A. Default value: N/A.

**Table 8** ScriptExecuteParamReference
Parameter	Type	Description
refer_type	String	Definition: Parameter reference type: PARAM_STORE Constraints: N/A. Value range: N/A. Default value: N/A.
param_id	String	Definition: Unique primary key ID of a referenced parameter. Constraints: LOW MEDIUM HIGH Value range: N/A. Default value: N/A.
param_version	String	Definition: Version of the reference parameter. Constraints: N/A. Value range: N/A. Default value: N/A.

Example Requests

Display basic information about a script service ticket.

GET https://{Endpoint}/v1/job/script/orders/{execute_uuid}

Example Responses

Status code: 200

Execution basic information is returned.

For more status codes, see Status Codes.

{
  "data" : {
    "execute_uuid" : "SCT2023102211473xxxxxxxxxx",
    "gmt_created" : 1697946452186,
    "gmt_finished" : 1697946763469,
    "execute_costs" : 311282,
    "creator" : "xxxxxxxxxxxcontainer1",
    "status" : "CANCELED",
    "properties" : {
      "script_uuid" : "SC2023101717xxxxxxxxxxxxx",
      "script_name" : "xjptxxxxxxxx",
      "current_execute_batch_index" : 1,
      "execute_param" : {
        "resourceful" : true,
        "timeout" : 300,
        "execute_user" : "root",
        "success_rate" : 100,
        "script_params" : [ ]
      },
      "script_source" : "CUSTOM_SCRIPT"
    }
  }
}