Query CBT Tasks

GET/zstack/v1/cbt-task

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

Headers

Authorization: OAuth the-session-uuid

Curl Example

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

Queryable Fields

Run the CLI command line tool, enter QueryCbtTask, and press Tab to view all queryable fields and the resource names that support cross-table queries.

API Response

Response Example

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

Name	Type	Description	Starting Version
success	boolean		4.10.10
inventories	List	For details, see inventories	4.10.10
error	ErrorCode	Error code. If not null, the operation failed. This field is null when the operation succeeds. For details, see error	4.10.10

inventories

Name	Type	Description	Starting Version
uuid	String	Resource UUID. Uniquely identifies the resource	4.10.10
name	String	Resource name	4.10.10
description	String	Detailed description of the resource	4.10.10
createDate	Timestamp	Creation time	4.10.10
lastOpDate	Timestamp	Last modification time	4.10.10
status	CbtTaskStatus	For details, see status	4.10.10

status

Name	Type	Starting Version
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

Name	Type	Description	Starting Version
code	String	Error code number. The globally unique identifier of the error, for example, SYS.1000 or HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	Detailed information about the error	0.6
elaboration	String	Reserved field. Default is null	0.6
opaque	LinkedHashMap	Reserved field. Default is null	0.6
cause	ErrorCode	Root error. The source error that caused the current error. This field is null if there is no source error	0.6

SDK Examples

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()