Displaying the Script Tickets

Function

This API is used to query the job service ticket list, by page.

Constraints

Query criteria: creation start time, creation end time, and creator.

Returned information: ID, script name, region, creator, creation time, end time, total duration, and status

URI

GET /v1/job/script/orders

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Pagination parameter. Constraints: N/A. Value range: N/A. Default value: N/A.
marker	No	Long	Definition: Pagination parameter. Constraints: N/A. Value range: N/A. Default value: N/A.
start_time	No	Long	Definition: Creation start time. Constraints: N/A. Value range: N/A. Default value: N/A.
end_time	No	Long	Definition: Creation end time. Constraints: N/A. Value range: N/A. Default value: N/A.
creator	No	String	Definition: Creator. Constraints: N/A. Value range: N/A. Default value: N/A.
status	No	String	Definition: Service ticket status. Constraints: PROCESSING, ABNORMAL, PAUSED, CANCELED, and FINISHED. Value range: PROCESSING, ABNORMAL, PAUSED, CANCELED, or FINISHED. Default value: N/A.
name_like	No	String	Definition: Service ticket name. 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	JobScriptOrderListPage object	Definition: Service ticket list. Value range: N/A.

**Table 4** JobScriptOrderListPage
Parameter	Type	Description
total	Long	Definition: Total number of records. Value range: N/A.
data	Array of JobScriptOrderListModel objects	Definition: Data listed on a single page. Value range: N/A.

**Table 5** JobScriptOrderListModel
Parameter	Type	Description
order_id	Long	Definition: Primary key ID, corresponding to the primary key of job_order_do. Value range: N/A.
order_name	String	Definition: Service ticket name. Value range: N/A.
execute_uuid	String	Definition: This UUID is used when the details page is redirected from the list, whose value is corresponds to execute_uuid of execute_data_do. Value range: N/A.
gmt_created	Long	Definition: Creation time. Value range: N/A.
gmt_finished	Long	Definition: 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: Service ticket status. Value range: The value can be READY, PROCESSING, ABNORMAL, PAUSED, CANCELED, and FINISHED.
properties	JobScriptOrderListProp object	Definition: Label, including region and other information. Value range: N/A.

**Table 6** JobScriptOrderListProp
Parameter	Type	Description
region_ids	String	Definition: ID of the region where the CloudCMDB service instances are deployed. There may be multiple region IDs. Value range: N/A.

Example Requests

Display the script service tickets.

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

Example Responses

Status code: 200

Executed pagination data is returned.

For more status codes, see Status Codes.

{
  "data" : {
    "total" : 222,
    "data" : [ {
      "order_id" : 74,
      "order_name" : "071201",
      "execute_uuid" : "SCT20230724201xxxxxxxxxxxx",
      "gmt_created" : 1690200829451,
      "gmt_finished" : 1690200850293,
      "execute_costs" : 20842,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "CANCELED",
      "properties" : {
        "region_ids" : "***"
      }
    }, {
      "order_id" : 73,
      "order_name" : "071201",
      "execute_uuid" : "SCT2023072411xxxxxxxxxxxxx",
      "gmt_created" : 1690168434460,
      "gmt_finished" : 1690168443277,
      "execute_costs" : 8817,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "FINISHED",
      "properties" : {
        "region_ids" : "***"
      }
    }, {
      "order_id" : 72,
      "order_name" : "xxx",
      "execute_uuid" : "SCT2023072217181xxxxxxxxxx",
      "gmt_created" : 1690017490247,
      "gmt_finished" : null,
      "execute_costs" : null,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "ABNORMAL",
      "properties" : {
        "region_ids" : "***"
      }
    }, {
      "order_id" : 71,
      "order_name" : "patch_730",
      "execute_uuid" : "SCT2023071915xxxxxxxxxxxxx",
      "gmt_created" : 1689753553241,
      "gmt_finished" : 1689753579363,
      "execute_costs" : 26122,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "FINISHED",
      "properties" : {
        "region_ids" : "***"
      }
    }, {
      "order_id" : 70,
      "order_name" : "111",
      "execute_uuid" : "SCT2023071915xxxxxxxxxxxxx",
      "gmt_created" : 1689751168547,
      "gmt_finished" : null,
      "execute_costs" : null,
      "creator" : "xxxxxxxxxxxcontainer1",
      "status" : "ABNORMAL",
      "properties" : {
        "region_ids" : "***"
      }
    } ]
  }
}