Help Center/ Cloud Operations Center/ API Reference/ API/ Script Tickets/ Displaying the Service Ticket List
Updated on 2024-04-19 GMT+08:00

Displaying the Service Ticket List

Function

This API is used to query the job service ticket list and search for service tickets by page. The filter criteria include the creation start time, creation end time, and creator. The returned information includes the 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 or Not

Type

Description

limit

No

Integer

Pagination parameters.

Minimum value: 1

Maximum value: 100

marker

No

Long

Pagination parameters.

Minimum value: 1

Maximum value: 2147483647

start_time

No

Long

Start time

Minimum value: 1

Maximum value: 2147483647

end_time

No

Long

End time

Minimum value: 1

Maximum value: 2147483647

creator

No

String

Creator.

Minimum length: 1 character

Maximum length: 64 characters

status

No

String

Service ticket status. The options are as follows: READY: to be executed; PROCESSING: being executed; ABNORMAL: abnormal; PAUSED: suspended; CANCELED: canceled; FINISHED: successful

The value can be:

  • READY
  • PROCESSING
  • ABNORMAL
  • PAUSED
  • CANCELED
  • FINISHED

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

total

Long

Total number of records

data

JobScriptOrderListModel object

Record a list on a page

Table 3 JobScriptOrderListModel

Parameter

Type

Description

order_id

Long

Primary key ID, corresponding to the primary key of job_order_do.

Minimum value: 1

Maximum value: 9,223,372,036,854,775,807

order_name

String

Service ticket name

Minimum length: 1 character

Maximum length: 64 characters

execute_uuid

String

This UUID is used when the list is redirected to the details page, which corresponds to execute_uuid of execute_data_do.

gmt_created

Long

Creation time.

gmt_finished

Long

Completion time

execute_costs

Long

Execution duration in seconds.

creator

String

Creator.

status

String

Ticket status.

The value can be:

  • READY
  • PROCESSING
  • ABNORMAL
  • PAUSED
  • CANCELED
  • FINISHED

properties

JobScriptOrderListProp object

Label: region and other information

Table 4 JobScriptOrderListProp

Parameter

Type

Description

region_ids

String

Region ID of the CloudCMDB service instance. There may be multiple region IDs.

Request Example

None

Response Example

Status code: 200

Execute pagination data

{
    "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": "cn-north-7"
                }
            },
            {
                "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": "cn-north-7"
                }
            },
            {
                "order_id": xx,
                "order_name": "xxx",
                "execute_uuid": "SCT2023072217181xxxxxxxxxx",
                "gmt_created": 1690017490247,
                "gmt_finished": null,
                "execute_costs": null,
                "creator": "xxxxxxxxxxxcontainer1",
                "status": "ABNORMAL",
                "properties": {
                    "region_ids": "cn-north-7"
                }
            },
            {
                "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": "cn-north-7"
                }
            },
            {
                "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": "cn-north-7"
                }
            }
        ]
    }
}

Status Code

Status Code

Description

200

Execute pagination data

Error code

See Error code.