执行自定义脚本
功能介绍
执行脚本
脚本入参、超时时间、执行用户、资源受限 脚本入参支持20个。 单次下发的机器支持200个。 单次批次内机器数量最大10个。 最大批次数量为20批。 脚本输出的日志总量只支持1MB。
URI
POST /v1/job/scripts/{script_uuid}
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
script_uuid |
是 |
String |
脚本UUID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
execute_param |
是 |
ScriptExecuteParam object |
脚本执行参数 |
execute_batches |
是 |
Array of ExecuteInstancesBatchInfo objects |
目标实例分批信息 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
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 |
脚本入参列表 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
param_name |
是 |
String |
脚本入参的名称,同一个脚本，参数名不能重复 最小长度：1 最大长度：64 |
param_value |
是 |
String |
脚本入参的值 最小长度：0 最大长度：1024 枚举值：
|
param_order |
是 |
Integer |
参数顺序，从1开始，保持连续 最小值：1 最大值：20 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
batch_index |
是 |
Integer |
批次索引，从1开始，未校验：最大值 最小值：1 最大值：20 |
target_instances |
是 |
Array of ExecuteResourceInstance objects |
目标节点列表 数组长度：1 - 10 |
rotation_strategy |
是 |
String |
暂停继续策略 枚举值：
|
响应参数
状态码： 204
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 最小长度：8 最大长度：36 |
error_msg |
String |
错误描述 最小长度：2 最大长度：512 |
请求示例
https://coc.myhuawei.com/v1/job/scripts/{script_uuid}
{
"execute_param" : {
"timeout" : 300,
"execute_user" : "root",
"success_rate" : "100.0",
"script_params" : [ {
"param_name" : "a",
"param_value" : "key1",
"param_order" : 1
} ]
},
"execute_batches" : [ {
"batch_index" : 1,
"rotation_strategy" : "CONTINUE",
"target_instances" : [ {
"resource_id" : "resource_id",
"agent_sn" : "agent_sn",
"agent_status" : "ONLINE",
"region_id" : "cn-north-7",
"project_id" : "project_id"
} ]
} ]
}
响应示例
状态码： 200
execute_uuid
{
"data" : "SCT2023083109562601af694bf"
}
状态码： 204
{
"error_code" : "COC.00040701",
"error_msg" : "error_msg"
}
状态码
状态码 |
描述 |
|---|---|
200 |
execute_uuid |
204 |
包含报错信息 |
错误码
请参见错误码。
