# 获取公共脚本列表 - ListJobPublicScripts #### 功能介绍 获取公共脚本列表。 #### 接口约束 - limit最大为100。 - 脚本风险等级只有：LOW、MEDIUM、HIGH。 - 脚本类型只有：SHELL、PYTHON、BAT。 - 分页逻辑：采用limit+marker方式，提高分页效率。 - 用自增id作为marker参数。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ListJobPublicScripts)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | coc:document:list | List | document \* | - | - | - | #### URI GET /v1/job/public-scripts 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释：** 分页参数：每页返回记录个数限制。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | marker | 否 | Long | **参数解释：** 分页参数：上一页最后一个记录id。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | name_like | 否 | String | **参数解释：** 脚本名（只支持右模糊搜索）。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | name | 否 | String | **参数解释：** 脚本名（精确搜索）。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | risk_level | 否 | String | **参数解释：** 风险等级。 **约束限制：** - LOW：低风险。 - MEDIUM：中风险。 - HIGH：高风险。 **取值范围：** LOW/MEDIUM/HIGH。 **默认取值：** 不涉及。 | | type | 否 | String | **参数解释：** 脚本类型。 **约束限制：** - SHELL：shell脚本。 - PYTHON：python脚本。 - BAT：bat脚本。 **取值范围：** SHELL/PYTHON/BAT。 **默认取值：** 不涉及。 | #### 请求参数 表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 | [PublicScriptListPage] object | **参数解释：** 获取公共脚本列表返回结果。 **取值范围：** 不涉及。 | 表4PublicScriptListPage | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Long | **参数解释：** 总条数。 **取值范围：** 不涉及。 | | data | Array of [PublicScriptListModel] objects | **参数解释：** 单页数据列表。 **取值范围：** 不涉及。 | 表5PublicScriptListModel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | **参数解释：** 脚本自增id。 **取值范围：** 不涉及。 | | script_uuid | String | **参数解释：** 脚本uuid。 **取值范围：** 不涉及。 | | name | String | **参数解释：** 脚本名称。 **取值范围：** 不涉及。 | | type | String | **参数解释：** 脚本类型。 **取值范围：** - SHELL：shell脚本 - PYTHON：python脚本 - BAT：bat脚本 | | status | String | **参数解释：** 脚本状态 - PENDING_APPROVE：待审批。 - APPROVED：正常（审批通过）。 - REJECTED：驳回（审批人，驳回该脚本）。 **取值范围：** PENDING_APPROVE/APPROVED/REJECTED。 | | gmt_created | Long | **参数解释：** 创建时间。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 脚本描述。 **取值范围：** 不涉及。 | | properties | [PublicScriptPropertiesModel] object | **参数解释：** 脚本附加属性。 **取值范围：** 不涉及。 | 表6PublicScriptPropertiesModel | 参数 | 参数类型 | 描述 | |:---|:---|:---| | risk_level | String | **参数解释：** 风险等级。 **取值范围：** - LOW：低风险 - MEDIUM：中风险 - HIGH：高风险 | | version | String | **参数解释：** 脚本版本号。 **取值范围：** 不涉及。 | #### 请求示例 获取公共脚本列表。 ``` GET https://{Endpoint}/v1/job/public-scripts ``` #### 响应示例 **状态码：200** 请求成功。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 ``` { "data" : { "total" : 2, "data" : [ { "id" : 1422704, "name" : "HWC.ECS.OSOps-switch-linux-ssh.sh", "type" : "SHELL", "gmt_created" : 1745294950699, "status" : "APPROVED", "script_uuid" : "SC2024052200000006dd50344", "description" : "启动或关闭linux操作系统ssh", "properties" : { "risk_level" : "HIGH", "version" : "1.0.0" } }, { "id" : 1422703, "name" : "HWC.ECS.OSOps-switch-linux-firewall.sh", "type" : "SHELL", "gmt_created" : 1745294950689, "status" : "APPROVED", "script_uuid" : "SC2024052200000005dd50344", "description" : "启动或关闭linux操作系统防火墙", "properties" : { "risk_level" : "HIGH", "version" : "1.0.0" } } ] } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功。 更多状态码请参考[状态码](https://support.huaweicloud.com/api-coc/coc_api_05_03.html)。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。