链接复制成功！
创建脚本
功能介绍
创建作业脚本：自定义脚本
-
脚本有标签属性，表示是高危脚本。创建时候不需要对脚本进行是否是高危的二次校验。
-
进行租户隔离；北向接口创建的脚本，审批人字段不填写，默认不需要审批。
接口约束
-
脚本名称：同一租户下，脚本名称不能重复，最大字符64个字符，支持中文+字母+数字+下划线。
-
脚本内容最大100kb。
-
脚本参数个数最多20个。
-
脚本描述：最大256个字符。
-
单个参数的参数名称 64个字符，只支持字母+数字+下划线。
-
单个参数的值最大1024个字符，正则表达式如下：^((?!.{2,})[a-zA-Z0-9_-/.*\x20?:",=+@\[{]}])*$。
-
审批人最多支持5人。
-
脚本输出的日志总量只支持1MB。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/job/scripts
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
租户token。 |
|
x-project-id |
否 |
String |
项目ID。 |
|
x-user-profile |
否 |
String |
IAM5.0用户信息。 |
|
X-Language |
否 |
String |
国际化标记，zh-cn表示中文，en-us或不传表示英文。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
脚本名称：只能包含中文、英文、数字、下划线。 |
|
properties |
是 |
ScriptPropertiesModel object |
脚本标签。 |
|
description |
是 |
String |
脚本描述。 |
|
type |
是 |
String |
脚本类型: 对于脚本后缀：
|
|
content |
是 |
String |
脚本内容。 |
|
enterprise_project_id |
否 |
String |
企业项目ID，默认为：0。 |
|
script_params |
否 |
Array of ScriptParamDefine objects |
脚本入参。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
risk_level |
是 |
String |
风险等级。
|
|
version |
是 |
String |
脚本版本号。 |
|
reviewers |
否 |
Array of ReviewerInfo objects |
审批人，不填写不需要审批。 |
|
protocol |
否 |
String |
审批消息通知协议，用于通知审批人。
|
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
String |
创建的脚本uuid。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
创建一个SHELL脚本，审批消息通过微信通知审批人。
POST https://{Endpoint}/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"
}错误码
请参见错误码。
