链接复制成功！
获取自定义脚本详情
功能介绍
获取脚本详情
接口约束
只能查询本账号的自定义脚本详情。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/job/scripts/{script_uuid}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
script_uuid |
是 |
String |
参数解释： 脚本UUID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 租户token。 约束限制： 从IAM获取的租户token。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
X-Language |
否 |
String |
参数解释： 国际化标记，zh-cn表示中文，en-us或不传表示英文。 约束限制： zh-cn表示中文，en-us或不传表示英文。 取值范围： zh-cn/en-us。 默认取值： 不涉及。 |
|
x-project-id |
否 |
String |
参数解释： 项目ID。 约束限制： region对应的项目ID。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
x-user-profile |
否 |
String |
参数解释： IAM5.0用户信息。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
ScriptDetailModel object |
参数解释： 自定义脚本的详细数据。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
script_uuid |
String |
参数解释： 脚本uuid。 取值范围： 不涉及。 |
|
name |
String |
参数解释： 脚本名称。 取值范围： 不涉及。 |
|
version |
String |
参数解释： 脚本版本号。 约束条件 。 后期废除，不建议使用。 取值范围： 不涉及。 |
|
description |
String |
参数解释： 脚本描述。 取值范围： 不涉及。 |
|
type |
String |
参数解释： 脚本类型。
取值范围： SHELL/PYTHON/BAT。 |
|
content |
String |
参数解释： 脚本内容。 取值范围： 不涉及。 |
|
script_params |
Array of ScriptParamDefine objects |
参数解释： 脚本入参。 取值范围： 不涉及。 |
|
status |
String |
参数解释： 脚本状态
取值范围： PENDING_APPROVE/APPROVED/REJECTED。 |
|
gmt_created |
Long |
参数解释： 创建时间。 取值范围： 不涉及。 |
|
gmt_modified |
Long |
参数解释： 修改时间。 取值范围： 不涉及。 |
|
creator |
String |
参数解释： 创建人。 取值范围： 不涉及。 |
|
creator_id |
String |
参数解释： 创建人Id。 取值范围： 不涉及。 |
|
operator |
String |
参数解释： 修改人。 取值范围： 不涉及。 |
|
properties |
ScriptPropertiesModel object |
参数解释： 脚本标签：风险等级risk_level(取值范围：LOW/MEDIUM/HIGH)、审批人reviewer、脚本解释器interpreter等。 取值范围： 不涉及。 |
|
enterprise_project_id |
String |
参数解释： 企业项目id。 取值范围： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
param_name |
String |
参数解释： 参数名。 约束限制： 参数名仅支持字母、数字以及下划线。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
param_value |
String |
参数解释： 参数值。 约束限制：
取值范围： 不涉及。 默认取值： 不涉及。 |
|
param_description |
String |
参数解释： 参数描述。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
param_order |
Integer |
参数解释： 参数顺序。【已废弃】该参数已废弃，传入该参数不会生效。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
sensitive |
Boolean |
参数解释： 是否是敏感参数。 约束限制： true/false。 取值范围： true/false。 默认取值： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
risk_level |
String |
参数解释： 风险等级。 约束限制：
取值范围： LOW/MEDIUM/HIGH。 默认取值： 不涉及。 |
|
version |
String |
参数解释： 脚本版本号。 约束限制： 格式：1.0.0 取值范围： 不涉及。 默认取值： 不涉及。 |
|
reviewers |
Array of ReviewerInfo objects |
参数解释： 审批人，不填写不需要审批。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
protocol |
String |
参数解释： 审批消息通知协议，用于通知审批人。 约束限制：
取值范围： DEFAULT/DEFAULT/SMS/EMAIL/DING_TALK/WE_LINK/WECHAT/CALLNOTIFY/NOT_TO_NOTIFY。 默认取值： 不涉及。 |
请求示例
获取自定义脚本详情请求示例。
GET https://{Endpoint}/v1/job/scripts/{script_uuid}响应示例
状态码：200
请求成功。
更多状态码请参考状态码。
{
"data" : {
"script_uuid" : "SC20230831110xxx",
"name" : "testExxx",
"description" : "测试xx",
"type" : "SHELL",
"content" : "echo \"${aaa}\"",
"script_params" : [ {
"param_name" : "value",
"param_value" : "aaa",
"param_description" : "测试参数",
"param_order" : 1,
"sensitive" : false
} ],
"gmt_created" : 1686059454716,
"gmt_modified" : 1745222192134,
"status" : "APPROVED",
"creator" : "COC-TEST",
"creator_id" : "1994a3ed905a47ad82c6xxxxxxx",
"operator" : "COC-TEST",
"properties" : {
"risk_level" : "LOW",
"version" : "1.0.0"
},
"enterprise_project_id" : 0
}
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 更多状态码请参考状态码。 |
错误码
请参见错误码。
