查询脚本列表 - ListScripts
功能介绍
查询脚本列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/scripts
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| offset | 否 | Integer | 查询的偏移量,默认值0。 |
| limit | 否 | Integer | 单次查询的大小[1-100],默认值10。 |
| id | 否 | String | 脚本ID。 |
| name | 否 | String | 脚本名称。 |
| type | 否 | String | 脚本类型。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| count | Integer | 总数。 |
| scripts | Array of ScriptSimpleInfo objects | 脚本列表。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | 脚本ID。 |
| name | String | 脚本名称。 |
| description | String | 描述。 |
| type | String | 脚本类型:POWERSHELL/BAT/SHELL。 |
| version | String | 脚本版本。 |
| create_time | String | 创建时间。 |
| update_time | String | 更新时间。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:405
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
状态码:503
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码,失败时返回。 |
| error_msg | String | 错误描述。 |
请求示例
无
响应示例
状态码:200
成功响应。
{
"count" : 0,
"scripts" : [ {
"id" : "string",
"name" : "string",
"description" : "string",
"type" : "string",
"version" : "string",
"create_time" : "2024-12-25T07:09:33.224Z",
"update_time" : "2024-12-25T07:09:33.224Z"
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 成功响应。 |
| 400 | 由于包含语法错误,当前请求无法被服务器理解。 |
| 401 | 鉴权失败。 |
| 403 | 没有操作权限。 |
| 404 | 找不到资源。 |
| 405 | 请求中指定的方法不被允许。 |
| 500 | 服务内部错误,具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。 |
错误码
请参见错误码。