查询剧本版本列表
功能介绍
查询剧本版本列表
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/{playbook_id}/versions
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
workspace_id |
是 |
String |
工作空间ID |
|
playbook_id |
是 |
String |
剧本ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
status |
否 |
String |
剧本版本状态，编辑中：EDITING 审核中：APPROVING 不通过：UNPASSED 已发布：PUBLISHED |
|
enabled |
否 |
Integer |
启用/禁用 |
|
version_type |
否 |
Integer |
版本类型， 草稿版本：0 正式版本：1 |
|
offset |
否 |
Integer |
分页查询参数。用于指定查询结果的起始位置，从0开始 |
|
limit |
否 |
Integer |
分页查询参数，用于指定一次查询最多的结果数，从1开始 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
错误信息 |
|
size |
Integer |
分页查询数据大小 |
|
page |
Integer |
当前页码 |
|
total |
Integer |
总数 |
|
data |
Array of PlaybookVersionListEntity objects |
剧本版本列表信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
剧本版本ID |
|
description |
String |
描述 |
|
create_time |
String |
创建时间 |
|
update_time |
String |
更新时间 |
|
project_id |
String |
项目ID |
|
creator_id |
String |
创建者ID |
|
modifier_id |
String |
修改者ID |
|
playbook_id |
String |
剧本ID |
|
version |
String |
版本号 |
|
enabled |
Boolean |
是否激活 |
|
status |
String |
状态. (EDITING--编辑中, APPROVING--审核中, UNPASSED--审核不通过, PUBLISHED--审核通过) |
|
action_strategy |
String |
执行策略. 目前仅支持异步并发执行，对应值为ASYNC |
|
rule_enable |
Boolean |
过滤规则是否启用 |
|
dataclass_id |
String |
数据类ID |
|
trigger_type |
String |
触发方式. EVENT--事件触发, TIMER--定时触发 |
|
dataobject_create |
Boolean |
标识数据对象是否创建时触发剧本 |
|
dataobject_update |
Boolean |
标识数据对象是否更新时触发剧本 |
|
dataobject_delete |
Boolean |
标识数据对象是否删除时触发剧本 |
|
version_type |
Integer |
版本类型 |
|
rule_id |
String |
过滤规则ID |
|
dataclass_name |
String |
数据类名称 |
|
approve_name |
String |
审核者 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误描述 |
请求示例
无
响应示例
状态码：200
请求成功响应信息
{
"code" : 0,
"message" : "Error message",
"size" : 3,
"page" : 10,
"total" : 41,
"data" : [ {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"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",
"creator_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"modifier_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"playbook_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"version" : "v1.1.1",
"enabled" : true,
"status" : "editing",
"action_strategy" : "sync",
"rule_enable" : true,
"dataclass_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"trigger_type" : "event",
"dataobject_create" : true,
"dataobject_update" : true,
"dataobject_delete" : true,
"version_type" : 1,
"rule_id" : "string",
"dataclass_name" : "string",
"approve_name" : "string"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功响应信息 |
|
400 |
请求失败响应信息 |
错误码
请参见错误码。
