创建脚本
功能介绍
创建作业脚本：自定义脚本
- 脚本有标签属性，表示是高危脚本。创建时候不需要对脚本进行是否是高危的二次校验。
- 进行租户隔离；北向接口创建的脚本，审批人字段不填写，默认不需要审批
- 约束条件：
- 脚本名称：同一租户下，脚本名称不能重复，最大字符64个字符，支持中文+字母+数字+下划线。
- 脚本内容最大4096个字符。
- 脚本参数个数最多20个。
- 脚本描述：最大256个字符。
- 单个参数的参数名称 64个字符，只支持字母+数字+下划线。
- 单个参数的值最大1024个字符，正则表达式如下：^((?!.{2,})[a-zA-Z0-9_-/.*\x20?:",=+@\[{]}])*$。
- 审批人最多支持5人。
- 脚本输出的日志总量只支持1MB。
URI
POST /v1/job/scripts
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
name |
是 |
String |
脚本名称：只能包含中文、英文、数字、下划线 最小长度：1 最大长度：64 |
properties |
是 |
ScriptPropertiesModel object |
脚本标签：
|
description |
是 |
String |
脚本描述 最小长度：1 最大长度：256 |
type |
是 |
String |
脚本类型: 对于脚本后缀： SHELL:.sh PYTHON:.py BAT:.bat 枚举值：
|
content |
是 |
String |
脚本内容 最小长度：1 最大长度：4096 |
script_params |
否 |
Array of ScriptParamDefine objects |
脚本入参 数组长度：0 - 20 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
risk_level |
是 |
String |
风险等级 LOW:低风险 MEDIUM:中风险 HIGH:高风险 枚举值：
|
version |
是 |
String |
脚本版本号 最小长度：1 最大长度：10 |
reviewers |
否 |
Array of ReviewerInfo objects |
审批人，不填写不需要审批 数组长度：0 - 5 |
protocol |
否 |
String |
审批消息通知协议，用于通知审批人 DEFAULT：默认 SMS：短信 EMAIL：邮件 DING_TALK：钉钉 WE_LINK：welink WECHAT:微信 CALLNOTIFY：语言 NOT_TO_NOTIFY：不通知 枚举值：
|
响应参数
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_code |
String |
错误码 最小长度：8 最大长度：36 |
error_msg |
String |
错误描述 最小长度：2 最大长度：512 |
请求示例
实例请求体
https://coc.myhuaweicloud.com/v1/job/scripts
{
"type" : "SHELL",
"content" : "echo ${value}",
"name" : "09101112",
"description" : "实例脚本",
"properties" : {
"risk_level" : "HIGH",
"version" : "1.0.0",
"reviewers" : [ {
"reviewer_name" : "test",
"reviewer_id" : "7a8513cd87b7448283a1d5190eb91234"
} ],
"protocol" : "WECHAT"
},
"script_params" : [ {
"param_name" : "a",
"param_value" : "string",
"param_description" : "string",
"param_order" : 1,
"sensitive" : true
} ]
}
响应示例
状态码： 200
脚本uuid
{
"data" : "SC2023102521413701c4a8a62"
}
状态码： 400
包含错误信息
{
"error_code" : "COC.00040701",
"error_msg" : "script_params size must be between 0 and 50"
}
状态码
状态码 |
描述 |
|---|---|
200 |
脚本uuid |
400 |
包含错误信息 |
错误码
请参见错误码。
