更新时间:2025-07-01 GMT+08:00
分享

操作脚本工单

功能介绍

操作正在执行脚本工单。

接口约束

操作类型:取消实例、跳过批次、取消整个工单、暂停整个工单、继续整个工单。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

execute_uuid

String

参数解释:

脚本工单的执行Id,取自executeJobScript和ListJobScriptOrders返回体中。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

租户token。

约束限制:

从IAM获取的租户token。

取值范围:

不涉及。

默认取值:

不涉及。

X-Language

String

参数解释:

国际化标记,zh-cn表示中文,en-us或不传表示英文。

约束限制:

zh-cn表示中文,en-us或不传表示英文。

取值范围:

zh-cn/en-us。

默认取值:

不涉及。

x-project-id

String

参数解释:

项目ID。

约束限制:

region对应的项目ID。

取值范围:

不涉及。

默认取值:

不涉及。

x-user-profile

String

参数解释:

IAM5.0用户信息。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

batch_index

Integer

参数解释:

批次id,适用于批次操作时。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

instance_id

Long

参数解释:

适用于实例操作时。

非script_execute_instance_do中iD,需要新增字段。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

operation_type

String

参数解释:

操作类型:取消实例、跳过批次、取消整个工单、暂停整个工单、继续整个工单。

  • CANCEL_INSTANCE:取消实例。

  • SKIP_BATCH:跳过批次。

  • CANCEL_ORDER:取消整个工单。

  • PAUSE_ORDER:暂停整个工单。

  • CONTINUE_ORDER:继续整个工单。

取值范围:

CANCEL_INSTANCE/SKIP_BATCH/CANCEL_ORDER/PAUSE_ORDER/CONTINUE_ORDER。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

String

参数解释:

操作的工单execute_uuid。

取值范围:

不涉及。

请求示例

取消工单中的单个实例的执行。

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

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

响应示例

状态码:200

操作的工单。

更多状态码请参考状态码

{
  "data" : "SCT202312111954xxxxxx"
}

状态码

状态码

描述

200

操作的工单。

更多状态码请参考状态码

错误码

请参见错误码

相关文档