查询剧本列表
功能介绍
查询剧本列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
workspace_id |
是 |
String |
工作空间ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
search_txt |
否 |
String |
搜索关键字 |
|
enabled |
否 |
Boolean |
是否启用 |
|
offset |
是 |
Integer |
分页查询参数。用于指定查询结果的起始位置，从0开始 |
|
limit |
是 |
Integer |
分页查询参数，用于指定一次查询最多的结果数，从1开始 |
|
description |
否 |
String |
剧本描述 |
|
dataclass_name |
否 |
String |
数据类名称 |
|
name |
否 |
String |
剧本名称 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
content-type |
是 |
String |
application/json;charset=UTF-8 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
响应消息信息 |
|
total |
Integer |
总条数 |
|
size |
Integer |
分页查询数据大小 |
|
page |
Integer |
当前页码 |
|
data |
Array of PlaybookInfo objects |
剧本列表信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
剧本ID |
|
name |
String |
剧本名称 |
|
description |
String |
描述信息 |
|
create_time |
String |
剧本创建时间 |
|
update_time |
String |
剧本更新时间 |
|
project_id |
String |
项目ID |
|
version_id |
String |
剧本版本ID |
|
enabled |
Boolean |
是否启用 |
|
workspace_id |
String |
工作空间ID |
|
approve_role |
String |
审核用户角色 |
|
user_role |
String |
用户角色 |
|
edit_role |
String |
编辑用户角色 |
|
owner_id |
String |
所有者ID |
|
version |
String |
版本号 |
|
dataclass_name |
String |
数据类名称 |
|
dataclass_id |
String |
数据类ID |
|
unaudited_version_id |
String |
待审核剧本版本ID |
|
reject_version_id |
String |
已驳回剧本版本ID |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误描述 |
请求示例
无
响应示例
状态码：200
剧本列表查询成功响应参数
{
"code" : 0,
"message" : null,
"total" : 41,
"page" : 10,
"data" : [ {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "MyXXX",
"description" : "This my XXXX",
"create_time" : "2021-01-30T23:00:00Z+0800",
"update_time" : "2021-01-30T23:00:00Z+0800",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"enabled" : true,
"workspace_id" : "string",
"approve_role" : "approve",
"user_role" : "string",
"edit_role" : "editor",
"owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"version" : "v1.1.1",
"dataclass_name" : "string",
"dataclass_id" : "string",
"unaudited_version_id" : "string",
"reject_version_id" : "string"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
剧本列表查询成功响应参数 |
|
400 |
查询失败响应参数 |
错误码
请参见错误码。
