链接复制成功!
展示脚本工单基本信息
功能介绍
查询执行:基本信息ScriptParamDefine。
执行类型、执行名称、创建人、创建时间、结束时间、执行状态、标签(脚本id,脚本名,执行脚本参数,执行用户,超时时长、成功率阈值)。
不同的任务类型消费标签中的不同key。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/job/script/orders/{execute_uuid}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
execute_uuid |
是 |
String |
脚本工单的执行Id,取自executeJobScript和ListJobScriptOrders返回体中。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
租户token。 |
X-Language |
否 |
String |
国际化标记,zh-cn表示中文,en-us或不传表示英文。 |
x-project-id |
否 |
String |
项目ID。 |
x-user-profile |
否 |
String |
IAM5.0用户信息。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
data |
JobScriptOrderInfoModel object |
返回结果。 |
参数 |
参数类型 |
描述 |
---|---|---|
execute_uuid |
String |
执行uuid。 |
gmt_created |
Long |
执行创建时间。 |
gmt_finished |
Long |
执行完成时间。 |
execute_costs |
Long |
执行耗时,单位:秒。 |
creator |
String |
创建人。 |
status |
String |
执行状态。
|
properties |
JobScriptOrderInfoProp object |
属性:脚本id,脚本名,执行脚本参数,执行用户,超时时长、成功率阈值、当前执行批次index等。 |
参数 |
参数类型 |
描述 |
---|---|---|
script_uuid |
String |
脚本uuid。 |
script_name |
String |
脚本名称。 |
script_version_uuid |
Long |
脚本版本uuid。 |
script_version_name |
String |
脚本版本名。 |
current_execute_batch_index |
Integer |
当前执行批次index。 |
execute_param |
ScriptExecuteParam object |
执行脚本参数,执行用户,超时时长、成功率阈值等。 |
参数 |
参数类型 |
描述 |
---|---|---|
resourceful |
Boolean |
该参数已废弃,传入该参数不会生效。 |
timeout |
Integer |
超时时间,单位:秒,取值范围:5 < timeout < 1800。 |
success_rate |
Double |
成功率,支持小数点后一位。 |
execute_user |
String |
脚本执行用户,如:root。 |
script_params |
Array of ScriptExecuteInputParam objects |
脚本入参列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
param_name |
String |
脚本入参的名称,同一个脚本,参数名不能重复。 |
param_value |
String |
脚本入参的值,默认必填。有引用参数(param_refer不为空)时,允许为空
|
param_order |
Integer |
【已废弃】该参数已废弃,传入该参数不会生效。 |
param_refer |
ScriptExecuteParamReference object |
参数引用 |
请求示例
无
响应示例
状态码: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 |
执行基本信息。 更多状态码请参考状态码。 |
错误码
请参见错误码。