列出检索脚本 - ListRetrieveScripts
功能介绍
列出检索脚本
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/workspaces/{workspace_id}/siem/retrieve-scripts
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产,可以通过调用API获取,也可以从控制台获取。获取项目ID 约束限制: 不涉及 取值范围: 不涉及w 默认取值: 不涉及 |
|
workspace_id |
是 |
String |
工作空间ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
table_id |
否 |
String |
表ID |
|
offset |
否 |
Long |
参数解释: 偏移量 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
|
script_name |
否 |
String |
脚本名称 |
|
offset |
否 |
Long |
参数解释: 偏移量 取值范围: 0-1000000 默认取值: 0 |
|
limit |
否 |
Long |
参数解释: 查询数据限制 取值范围: 0-1000 默认取值: 不涉及 |
|
sort_key |
否 |
String |
按照属性排序。 |
|
sort_dir |
否 |
String |
排序顺序,支持 ASC 或 DESC。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。获取用户Token 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
listcount |
Long |
计数 |
|
records |
Array of RetrieveScript objects |
检索 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
script_id |
String |
UUID |
|
project_id |
String |
项目ID |
|
workspace_id |
String |
工作空间ID |
|
script_name |
String |
脚本名称 |
|
table_id |
String |
UUID |
|
category |
String |
参数解释: 脚本分类
约束限制 不涉及 取值范围:
默认值 不涉及 |
|
directory |
String |
脚本目录分组名称,长度在1到256个字符之间。 |
|
description |
String |
脚本的相关描述信息,长度在1到1024个字符之间。 |
|
script |
String |
脚本内容,长度在1到10240个字符之间。 |
|
create_by |
String |
Iam用户ID |
|
create_time |
Integer |
毫秒时间戳 |
|
update_by |
String |
Iam用户ID |
|
update_time |
Integer |
毫秒时间戳 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
成功 |
|
400 |
Error response |
错误码
请参见错误码。