查询剧本实例详情
功能介绍
Show playbook instance
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/instances/{instance_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
workspace_id |
是 |
String |
工作空间ID |
|
instance_id |
是 |
String |
instance _id |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
剧本实例ID |
|
name |
String |
剧本实例名称 |
|
project_id |
String |
项目ID |
|
playbook |
PlaybookInfoRef object |
剧本信息 |
|
dataclass |
DataclassInfoRef object |
数据类信息 |
|
dataobject |
DataobjectInfo object |
数据对象详情 |
|
status |
String |
剧本实例状态. (RUNNING--运行中、FINISHED--成功、FAILED--失败、RETRYING--重试中、TERMINATING--终止中、TERMINATED--已终止) |
|
trigger_type |
String |
触发类型. TIMER--定时触发, EVENT--事件触发 |
|
start_time |
String |
创建时间 |
|
end_time |
String |
更新时间 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
剧本ID |
|
version_id |
String |
剧本版本ID |
|
name |
String |
名称 |
|
version |
String |
版本 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
ID值 |
|
create_time |
String |
创建时间 |
|
update_time |
String |
更新时间 |
|
project_id |
String |
项目ID |
|
dataclass_id |
String |
数据类ID |
|
name |
String |
名称 |
|
content |
String |
数据内容 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
请求ID,格式为：request_uuid-timestamp-hostname |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
错误码 |
|
message |
String |
错误描述 |
请求示例
无
响应示例
状态码：200
Instance Informations
{
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "MyXXX",
"project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"playbook" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"version" : "v1.1.1"
},
"dataclass" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
},
"dataobject" : {
"id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
"name" : "909494e3-558e-46b6-a9eb-07a8e18ca62f"
},
"status" : "TERMINATED",
"trigger_type" : "string",
"start_time" : "2021-01-30T23:00:00Z+0800",
"end_time" : "2021-01-30T23:00:00Z+0800"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Instance Informations |
|
400 |
Error response |
错误码
请参见错误码。
