Help Center/ Cloud Operations Center/ API Reference/ API/ Script Management/ Script Tickets/ Displaying the Service Ticket Batches
Updated on 2025-10-24 GMT+08:00
View PDF
Share

Displaying the Service Ticket Batches

Function

This API is used to query the batch list of service tickets.

Constraints

Constraints:

  • All instances in a batch must belong to the same region.

  • All instances in a batch must be in the same AZ.

  • All instances in a batch must belong to the same application.

  • A maximum of 50/ %instances in a batch can belong to the same group (except that there is only one instance in a group).

  • The number of nodes in each of the first three batches cannot exceed 10.

  • The number of instances in each batch cannot exceed 10.

  • The total number of hosts is 200.

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:JobType

URI

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

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

Array of JobScriptBatchListModel objects

Definition:

Batch list.

Value range:

N/A.
Table 4 JobScriptBatchListModel

Parameter

Type

Description

batch_index

Integer

Definition:

Batch index, starting from 1.

Value range:

N/A.

total_instances

Integer

Definition:

Number of instance nodes in a batch.

Value range:

N/A.

rotation_strategy

String

Definition:

Policy for determining whether to pause or continue an execution

Value range:

The value can be CONTINUE or

PAUSE.

properties

String

Definition:

Batch label.

Value range:

N/A.

Example Requests

Display the service ticket batches.

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

Example Responses

Status code: 200

Request result is returned.

For more status codes, see "Status Codes" in coc_api_05_03.xml.

{
  "data" : [ {
    "batch_index" : 1,
    "total_instances" : 1,
    "rotation_strategy" : "CONTINUE",
    "properties" : null
  } ]
}

Status Codes

Status Code

Description

200

Request result is returned.

For more status codes, see Status Codes.

Error Codes

See Error Codes.

Parent topic: Script Tickets