文档首页/ 云运维中心 COC/ API参考/ API/ 脚本管理/ 公共脚本/ 展示公共脚本详情
更新时间：2025-07-04 GMT+08:00
查看PDF
分享

展示公共脚本详情

功能介绍

展示公共脚本详情。

接口约束

查询系统已存在的公共脚本。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/job/public-scripts/{script_uuid}

表1 路径参数

参数

是否必选

参数类型

描述

script_uuid

是

String

参数解释：

公共脚本Uuid。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

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

表3 响应Body参数

参数

参数类型

描述

data

PublicScriptDetailModel object

参数解释：

展示公共脚本详情返回体。

取值范围：

不涉及。
表4 PublicScriptDetailModel

参数

参数类型

描述

script_uuid

String

参数解释：

脚本uuid。

取值范围：

不涉及。

name

String

参数解释：

脚本名称。

取值范围：

不涉及。

description

String

参数解释：

脚本描述。

取值范围：

不涉及。

type

String

参数解释：

脚本类型。

取值范围：

  • SHELL：shell脚本。

  • PYTHON：Python脚本。

  • BAT：Bat脚本。

content

String

参数解释：

脚本内容。

取值范围：

不涉及。

script_params

Array of ScriptParamDefine objects

参数解释：

脚本入参。

取值范围：

不涉及。

gmt_created

Long

参数解释：

创建时间。

取值范围：

不涉及。

properties

PublicScriptPropertiesModel object

参数解释：

脚本附件属性。

取值范围：

不涉及。
表5 ScriptParamDefine

参数

参数类型

描述

param_name

String

参数解释：

参数名。

约束限制：

参数名仅支持字母、数字以及下划线。

取值范围：

不涉及。

默认取值：

不涉及。

param_value

String

参数解释：

参数值。

约束限制：

  • 参数长度为1-4096位。

  • 可以包含大写字母、小写字母、数字及特殊字符(_-/.* ?:",=+@#[{]})。

  • 禁止出现连续'.'。

取值范围：

不涉及。

默认取值：

不涉及。

param_description

String

参数解释：

参数描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

param_order

Integer

参数解释：

参数顺序。【已废弃】该参数已废弃，传入该参数不会生效。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

sensitive

Boolean

参数解释：

是否是敏感参数。

约束限制：

true/false。

取值范围：

true/false。

默认取值：

不涉及。
表6 PublicScriptPropertiesModel

参数

参数类型

描述

risk_level

String

参数解释：

风险等级。

取值范围：

  • LOW：低风险

  • MEDIUM：中风险

  • HIGH：高风险

version

String

参数解释：

脚本版本号。

取值范围：

不涉及。

请求示例

展示指定的公共脚本详情。

GET https://{Endpoint}/v1/job/public-scripts/{script_uuid}

响应示例

状态码：200

请求成功。

更多状态码请参考状态码。

{
  "data" : {
    "script_uuid" : "SC2023083111030804153xxx",
    "name" : "testEcho",
    "description" : "测试echo",
    "type" : "SHELL",
    "content" : "echo \"${aaa}\"",
    "script_params" : [ {
      "param_name" : "value",
      "param_value" : "aaa",
      "param_description" : "测试参数",
      "param_order" : 1,
      "sensitive" : false
    } ],
    "gmt_created" : 1686059454716,
    "provider" : "HWC.ECS",
    "properties" : {
      "risk_level" : "LOW",
      "version" : "1.0.0"
    }
  }
}

状态码

状态码

描述

200

请求成功。

更多状态码请参考状态码。

错误码

请参见错误码。

父主题： 公共脚本

相关文档