链接复制成功！
执行自定义脚本
功能介绍
执行脚本
脚本入参、超时时间、执行用户、资源受限。
脚本入参支持20个。
单次下发的机器支持200个。
单次批次内机器数量最大10个。
最大批次数量为20批。
脚本输出的日志总量只支持1MB。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/job/scripts/{script_uuid}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
script_uuid |
是 |
String |
脚本UUID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
租户token。 |
|
X-Language |
否 |
String |
国际化标记，zh-cn表示中文，en-us或不传表示英文。 |
|
x-project-id |
否 |
String |
项目ID。 |
|
x-user-profile |
否 |
String |
IAM5.0用户信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
execute_param |
是 |
ScriptExecuteParam object |
脚本执行参数。 |
|
execute_batches |
是 |
Array of ExecuteInstancesBatchInfo objects |
目标实例分批信息。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
参数引用 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
refer_type |
是 |
String |
参数引用类型：PARAM_STORE。 |
|
param_id |
是 |
String |
引用参数的唯一主键id。
|
|
param_version |
否 |
String |
引用参数的版本号。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
batch_index |
是 |
Integer |
批次索引，从1开始。 |
|
target_instances |
是 |
Array of ExecuteResourceInstance objects |
目标节点列表。 |
|
rotation_strategy |
是 |
String |
暂停继续策略。
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource_id |
是 |
String |
ECS云服务器ID。 |
|
region_id |
是 |
String |
服务器所属region。 |
|
provider |
否 |
String |
资源提供者：ECS，不传默认为：ECS。请保证一次执行， 每个实例的provider是一致的。后续扩展CCE等。 |
|
type |
否 |
String |
资源提供者下资源类型，不传默认为CLOUDSERVER。 CLOUDSERVER：CLOUDSERVER类型。 约束：不允许跨type支持。 |
|
custom_attributes |
否 |
Array of Customttribute objects |
支持用户自定义5个key_value形式的属性。 约束条件：
|
|
agent_sn |
否 |
String |
【已废弃】该参数已废弃，传入该参数不会生效。 |
|
project_id |
否 |
String |
【已废弃】该参数已废弃，传入该参数不会生效。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
String |
execute_uuid。 |
状态码：204
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
执行脚本请求体示例。
https://{Endpoint}/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
请求成功。
更多状态码请参考状态码。
{
"data" : "SCT2023083109562601af694bf"
}状态码：204
包含错误信息。
更多状态码请参考状态码。
{
"error_code" : "COC.00040701",
"error_msg" : "error_msg"
}错误码
请参见错误码。
