文档首页/ 云运维中心 COC/ API参考/ API/ 脚本工单/ 展示脚本工单基本信息
更新时间:2024-01-04 GMT+08:00
分享

展示脚本工单基本信息

功能介绍

查询执行:基本信息 执行类型、执行名称、创建人、创建时间、结束时间、执行状态、标签(脚本id,脚本名,执行脚本参数,执行用户,超时时长、成功率阈值)

不同的任务类型消费标签中的不同key

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

execute_uuid

String

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

最小长度:1

最大长度:26

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

execute_uuid

String

执行uuid

gmt_created

Long

执行创建时间

gmt_finished

Long

执行完成时间

execute_costs

Long

执行耗时,单位:秒

creator

String

创建人

status

String

执行状态

枚举值:

  • READY
  • PROCESSING
  • ERROR
  • PAUSED
  • CANCELED
  • FINISHED
  • ROLLBACKED

properties

JobScriptOrderInfoProp object

属性:脚本id,脚本名,执行脚本参数,执行用户,超时时长、成功率阈值、当前执行批次index等

表3 JobScriptOrderInfoProp

参数

参数类型

描述

script_uuid

String

脚本uuid

script_name

Long

脚本名称

script_version_uuid

Long

脚本版本uuid

script_version_name

String

脚本版本名

current_execute_batch_index

Integer

当前执行批次index

execute_param

ScriptExecuteParam object

执行脚本参数,执行用户,超时时长、成功率阈值等

表4 ScriptExecuteParam

参数

参数类型

描述

resourceful

Boolean

是否资源受限,true表示不受限,false表示受限

timeout

Integer

超时时间,单位:秒,取值范围待定,5 < timeout < 1800

最小值:5

最大值:1800

success_rate

Double

成功率,支持小数点后一位

最小值:1

最大值:100

execute_user

String

脚本执行用户,如:root

最小长度:1

最大长度:32

script_params

Array of ScriptExecuteInputParam objects

脚本入参列表

表5 ScriptExecuteInputParam

参数

参数类型

描述

param_name

String

脚本入参的名称,同一个脚本,参数名不能重复

最小长度:1

最大长度:64

param_value

String

脚本入参的值

最小长度:0

最大长度:1024

枚举值:

  • ^((?!\.{2
  • })[a-zA-Z0-9_\-\/\.\x20\?:"
  • =+@\\\[\{\]\}])*$

param_order

Integer

参数顺序,从1开始,保持连续

最小值:1

最大值:20

请求示例

响应示例

状态码: 200

执行基本信息

{
  "data" : {
    "execute_uuid" : "SCT2023102211473xxxxxxxxxx",
    "gmt_created" : 1697946452186,
    "gmt_finished" : 1697946763469,
    "execute_costs" : 311282,
    "creator" : "xxxxxxxxxxxcontainer1",
    "status" : "CANCELED",
    "properties" : {
      "script_uuid" : "SC2023101717xxxxxxxxxxxxx",
      "script_name" : "xjptxxxxxxxx",
      "current_execute_batch_index" : 1,
      "execute_param" : {
        "resourceful" : true,
        "timeout" : 300,
        "execute_user" : "root",
        "success_rate" : 100,
        "script_params" : [ ]
      },
      "script_source" : "CUSTOM_SCRIPT"
    }
  }
}

状态码

状态码

描述

200

执行基本信息

错误码

请参见错误码

相关文档