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

Operation Script Service Ticket

Function

This API is used to execute the script service ticket.

Constraints

Operation type. You can cancel an instance, skip a batch, cancel a service ticket, suspend a service ticket, or continue 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:job:action

    Write

    job *

    -

    -

    -

    -

    coc:JobType

URI

PUT /v1/job/script/orders/{execute_uuid}/operation

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.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

batch_index

No

Integer

Definition:

Batch ID, which is applicable to batch operations.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

instance_id

No

Long

Definition:

This parameter is used for instance operations.

The value is not the same as the ID in script_execute_instance_do. Therefore, you need to add a field.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

operation_type

Yes

String

Definition:

Operation type. You can cancel an instance, skip a batch, cancel a service ticket, suspend a service ticket, or continue a service ticket.

The value can be CANCEL_INSTANCE,

SKIP_BATCH,

CANCEL_ORDER,

PAUSE_ORDER,

CONTINUE_ORDER,

Value range:

CANCEL_INSTANCE, SKIP_BATCH, CANCEL_ORDER, PAUSE_ORDER, or CONTINUE_ORDER.

Default value:

N/A.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data

String

Definition:

Execution UUID of the service ticket to be updated.

Value range:

N/A.

Example Requests

Cancel the execution of a single instance in a service ticket.

PUT https://{Endpoint}/v1/job/script/orders/{execute_uuid}/operation

{
  "instance_id": 510450xxx,
  "operation_type": "CANCEL_INSTANCE"
}

Example Responses

Status code: 200

The executed service ticket is returned.

For more status codes, see Status Codes.

{
  "data" : "SCT202312111954xxxxxx"
}

Status Codes

Status Code

Description

200

The executed service ticket is returned.

For more status codes, see Status Codes.

Error Codes

See Error Codes.

Parent topic: Script Tickets