查询脚本列表 - ListScript
功能介绍
查询自定义脚本列表。
接口约束
- 
    
limit最大为100。
 - 
    
脚本风险等级只有:LOW、MEDIUM、HIGH。
 - 
    
脚本类型只有:SHELL、PYTHON、BAT。
 
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
 - 如果使用身份策略授权,需具备如下身份策略权限。 
    
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
coc:document:list
List
document *
-
-
-
 
URI
GET /v1/job/scripts
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        limit  | 
      
        是  | 
      
        Integer  | 
      
        参数解释: 分页参数:每页返回记录个数限制。 约束限制: 最大100。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        marker  | 
      
        否  | 
      
        Long  | 
      
        参数解释: 分页参数:上一页最后一个记录id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        name_like  | 
      
        否  | 
      
        String  | 
      
        参数解释: 脚本名(模糊)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        creator  | 
      
        否  | 
      
        String  | 
      
        参数解释: 创建人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        risk_level  | 
      
        否  | 
      
        String  | 
      
        参数解释: 风险等级。 约束限制: 
 取值范围: LOW/MEDIUM/HIGH。 默认取值: 不涉及。  | 
     
| 
        type  | 
      
        否  | 
      
        String  | 
      
        参数解释: 脚本类型。 约束限制: 
 取值范围: SHELL/PYTHON/BAT。 默认取值: 不涉及。  | 
     
| 
        enterprise_project_id  | 
      
        否  | 
      
        String  | 
      
        参数解释: 企业项目id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
请求参数
| 
        参数  | 
      
        是否必选  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|---|
| 
        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  | 
      
        ScriptListPage object  | 
      
        参数解释: 脚本列表返回体。 取值范围: 不涉及。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        total  | 
      
        Long  | 
      
        参数解释: 总条数。 取值范围: 不涉及。  | 
     
| 
        data  | 
      
        Array of ScriptListModel objects  | 
      
        参数解释: 单页数据列表。 取值范围: 不涉及。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        id  | 
      
        Long  | 
      
        参数解释: 脚本自增id。 取值范围: 不涉及。  | 
     
| 
        script_uuid  | 
      
        String  | 
      
        参数解释: 脚本uuid。 取值范围: 不涉及。  | 
     
| 
        enterprise_project_id  | 
      
        String  | 
      
        参数解释: 企业项目ID,默认为:0。 取值范围: 不涉及。  | 
     
| 
        name  | 
      
        String  | 
      
        参数解释: 脚本名称。 取值范围: 不涉及。  | 
     
| 
        type  | 
      
        String  | 
      
        参数解释: 脚本类型。 
 取值范围: SHELL/PYTHON/BAT。  | 
     
| 
        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。 取值范围: 不涉及。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        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。 默认取值: 不涉及。  | 
     
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        reviewer_name  | 
      
        String  | 
      
        参数解释: 审批人名称(IAM用户名)。 约束限制: IAM用户名。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
| 
        reviewer_id  | 
      
        String  | 
      
        参数解释: 审批人ID(IAM用户Id)。 约束限制: IAM用户Id。 取值范围: 不涉及。 默认取值: 不涉及。  | 
     
状态码:400
| 
        参数  | 
      
        参数类型  | 
      
        描述  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
        参数解释: 错误码。 取值范围: 参见错误码章节。  | 
     
| 
        error_msg  | 
      
        String  | 
      
        参数解释: 错误描述。 取值范围: 参见错误码章节。  | 
     
请求示例
查询自定义脚本列表
GET https://{Endpoint}/v1/job/scripts?limit=100
 响应示例
状态码:200
脚本分页数据。
更多状态码请参考状态码。
{
  "data" : {
    "total" : 70,
    "data" : [ {
      "id" : 6229,
      "name" : "测试111",
      "type" : "SHELL",
      "creator" : "runbook_notif",
      "creator_id" : "e56462d17f334b8789ff0b5b9cca3bb9",
      "operator" : null,
      "gmt_created" : 1701314214271,
      "gmt_modified" : null,
      "status" : "APPROVED",
      "script_uuid" : "SC20231130111654023511657",
      "usage_count" : 0,
      "properties" : {
        "risk_level" : "HIGH",
        "reviewers" : [ ],
        "version" : "1.0.0",
        "protocol" : null
      },
      "enterprise_project_id" : 0
    }, {
      "id" : 6228,
      "name" : "测试11",
      "type" : "SHELL",
      "creator" : "runbook_notif",
      "creator_id" : "e56462d17f334b8789ff0b5b9cca3bb9",
      "operator" : null,
      "gmt_created" : 1701314090063,
      "gmt_modified" : null,
      "status" : "APPROVED",
      "script_uuid" : "SC20231130111450026f7f8b2",
      "usage_count" : 0,
      "properties" : {
        "risk_level" : "LOW",
        "reviewers" : [ ],
        "version" : "1.0.0",
        "protocol" : null
      },
      "enterprise_project_id" : 0
    } ]
  }
}
  状态码:400
包含错误信息。
更多状态码请参考状态码。
{
  "error_code" : "COC.00040701",
  "error_msg" : "error_msg"
}
 错误码
请参见错误码。