查询CBT任务

GET/zstack/v1/cbt-task

GET/zstack/v1/cbt-task/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/cbt-task?q=uuid=d6c3daab1c9b3274b5fc4088bd3e51ad

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/cbt-task/cf426711ed6538069d2d4d6d34d5e60a

可查询字段

运行CLI命令行工具，输入QueryCbtTask并按Tab键查看所有可查询字段以及可跨表查询的资源名。

API返回

返回示例

{
  "inventories": [
    {
      "uuid": "103f6f8dc6dc3f8b82c1e1923dc751e0",
      "name": "My Task",
      "status": "Running"
    }
  ]
}

名字	类型	描述	起始版本
success	boolean		4.10.10
inventories	List	详情参考inventories	4.10.10
error	ErrorCode	错误码，若不为null，则表示操作失败, 操作成功时该字段为null。详情参考error	4.10.10

inventories

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	4.10.10
name	String	资源名称	4.10.10
description	String	资源的详细描述	4.10.10
createDate	Timestamp	创建时间	4.10.10
lastOpDate	Timestamp	最后一次修改时间	4.10.10
status	CbtTaskStatus	详情参考status	4.10.10

status

名字	类型	起始版本
Created	CbtTaskStatus	4.10.10
Starting	CbtTaskStatus	4.10.10
Running	CbtTaskStatus	4.10.10
Stopped	CbtTaskStatus	4.10.10
Failed	CbtTaskStatus	4.10.10

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

SDK示例

Java SDK

QueryCbtTaskAction action = new QueryCbtTaskAction();
action.conditions = asList("uuid=bd8fa811d9c234ceada09446fa085967");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryCbtTaskAction.Result res = action.call();

Python SDK

QueryCbtTaskAction action = QueryCbtTaskAction()
action.conditions = ["uuid=0449908917ce338bba71c107848b7c5c"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryCbtTaskAction.Result res = action.call()