更新时间:2024-06-06 GMT+08:00

查询脚本列表

功能介绍

作业脚本列表:自定义脚本

limit最大为100

URI

GET /v1/job/scripts

表1 Query参数

参数

是否必选

参数类型

描述

limit

Integer

分页参数:每页返回记录个数限制

最小值:1

最大值:100

marker

Long

分页参数:上一页最后一个记录id

最小值:0

最大值:9223372036854775807

name_like

String

脚本名(模糊)

最小长度:1

最大长度:32

creator

String

创建人

最小长度:1

最大长度:64

risk_level

String

风险等级 LOW:低风险 MEDIUM:中风险 HIGH:高风险

枚举值:

  • LOW
  • MEDIUM
  • HIGH

type

String

脚本类型 SHELL:shell脚本 PYTHON:python脚本 BAT:Bat脚本

枚举值:

  • SHELL
  • PYTHON
  • BAT

请求参数

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

total

Long

总条数

最小值:1

最大值:9223372036854775807

data

Array of ScriptListModel objects

单页数据列表

数组长度:1 - 100

表3 ScriptListModel

参数

参数类型

描述

id

Long

脚本自增id

最小值:1

最大值:9223372036854775807

script_uuid

String

脚本uuid

最小长度:1

最大长度:25

name

String

脚本名称

最小长度:1

最大长度:64

type

String

脚本类型 SHELL:shell脚本 PYTHON:python脚本 BAT:bat脚本

枚举值:

  • SHELL
  • PYTHON
  • BAT

status

String

脚本状态 PENDING_APPROVE:待审批 APPROVED:正常(审批通过) REJECTED:驳回(审批人,驳回该脚本

枚举值:

  • PENDING_APPROVE
  • APPROVED
  • REJECTED

gmt_created

Long

创建时间

最小值:1

最大值:9223372036854775807

gmt_modified

Long

修改时间

最小值:1

最大值:9223372036854775807

creator

String

创建人

最小长度:1

最大长度:64

creator_id

String

创建人Id

最小长度:1

最大长度:64

operator

String

修改人

最小长度:1

最大长度:64

properties

ScriptPropertiesModel object

脚本标签:风险等级risk_level(取值范围:LOW/MEDIUM/HIGH)、审批人reviewer

表4 ScriptPropertiesModel

参数

参数类型

描述

risk_level

String

风险等级 LOW:低风险 MEDIUM:中风险 HIGH:高风险

枚举值:

  • 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:不通知

枚举值:

  • DEFAULT
  • SMS
  • EMAIL
  • DING_TALK
  • WE_LINK
  • WECHAT
  • CALLNOTIFY
  • NOT_TO_NOTIFY
表5 ReviewerInfo

参数

参数类型

描述

reviewer_name

String

审批人名称(IAM用户名)

最小长度:1

最大长度:64

reviewer_id

String

审批人ID(IAM用户Id)

最小长度:0

最大长度:32

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

响应示例

状态码: 400

包含错误信息

{
  "error_code" : "COC.00040701",
  "error_msg" : "error_msg"
}

状态码

状态码

描述

200

脚本分页数据

400

包含错误信息

错误码

请参见错误码