更新时间:2024-06-06 GMT+08:00

执行自定义脚本

功能介绍

执行脚本

脚本入参、超时时间、执行用户、资源受限 脚本入参支持20个。 单次下发的机器支持200个。 单次批次内机器数量最大10个。 最大批次数量为20批。 脚本输出的日志总量只支持1MB。

URI

POST /v1/job/scripts/{script_uuid}

表1 路径参数

参数

是否必选

参数类型

描述

script_uuid

String

脚本UUID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

execute_param

ScriptExecuteParam object

脚本执行参数

execute_batches

Array of ExecuteInstancesBatchInfo objects

目标实例分批信息

表3 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

脚本入参列表

表4 ScriptExecuteInputParam

参数

是否必选

参数类型

描述

param_name

String

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

最小长度:1

最大长度:64

param_value

String

脚本入参的值

最小长度:0

最大长度:1024

枚举值:

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

param_order

Integer

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

最小值:1

最大值:20

表5 ExecuteInstancesBatchInfo

参数

是否必选

参数类型

描述

batch_index

Integer

批次索引,从1开始,未校验:最大值

最小值:1

最大值:20

target_instances

Array of ExecuteResourceInstance objects

目标节点列表

数组长度:1 - 10

rotation_strategy

String

暂停继续策略

枚举值:

  • CONTINUE
  • PAUSE
表6 ExecuteResourceInstance

参数

是否必选

参数类型

描述

resource_id

String

ecs云服务器ID

最小长度:1

最大长度:64

agent_sn

String

UniAgent_sn

最小长度:1

最大长度:32

project_id

String

项目Id

最小长度:1

最大长度:32

region_id

String

服务器所属region

最小长度:1

最大长度:32

响应参数

状态码: 204

表7 响应Body参数

参数

参数类型

描述

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

包含报错信息

错误码

请参见错误码