Query Distributed Storage Pool

GET/zstack/v1/primary-storage/ceph/pools

GET/zstack/v1/primary-storage/ceph/pools/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Examples

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/primary-storage/ceph/pools?q=name=highPerformance

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/primary-storage/ceph/pools/d4e5d23825ff3004856e1720eff59131

Queryable Fields

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

API Response

Response Example

{
  "inventories": [
    {
      "primaryStorageUuid": "d0e638ede3263a9080c41ce860106043",
      "poolName": "test pool",
      "aliasName": "alias test pool",
      "description": "high performance",
      "createDate": "Nov 14, 2017 10:20:57 PM",
      "lastOpDate": "Nov 14, 2017 10:20:57 PM",
      "type": "Data"
    }
  ]
}

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

error

Name	Type	Description	Starting Version
code	String	Error code number, globally unique identifier for the error, such as SYS.1000, HOST.1001	0.6
description	String	Brief description of the error	0.6
details	String	Detailed error information	0.6
elaboration	String	Reserved field, defaults to null	0.6
opaque	LinkedHashMap	Reserved field, defaults to null	0.6
cause	ErrorCode	Root cause. The source error that triggered the current error. If there is no original error, this field is null	0.6

inventories

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	0.6
primaryStorageUuid	String	Primary Storage UUID	0.6
poolName	String		0.6
aliasName	String		0.6
description	String	Resource description	0.6
createDate	Timestamp	Creation time	0.6
lastOpDate	Timestamp	Last modification time	0.6
type	String		0.6
usedCapacity	Long		2.3.2
replicatedSize	Integer		2.3.2
availableCapacity	Long		2.3.2

SDK Examples

Java SDK

QueryCephPrimaryStoragePoolAction action = new QueryCephPrimaryStoragePoolAction();
action.conditions = asList("name=highPerformance");
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
QueryCephPrimaryStoragePoolAction.Result res = action.call();

Python SDK

QueryCephPrimaryStoragePoolAction action = QueryCephPrimaryStoragePoolAction()
action.conditions = ["name=highPerformance"]
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
QueryCephPrimaryStoragePoolAction.Result res = action.call()