Update Distributed Storage Pool

PUT/zstack/v1/primary-storage/ceph/pools/{uuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/primary-storage/ceph/pools/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/primary-storage/ceph/pools/{uuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateCephPrimaryStoragePool": {
    "aliasName": "alias",
    "description": "description"
  },
  "systemTags": [],
  "userTags": []
}

In the example above, systemTags and userTags fields can be omitted. They are listed to indicate that the body can contain these two fields.

Curl Examples

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateCephPrimaryStoragePool":{"aliasName":"alias","description":"description"}}' \
http://localhost:8080/zstack/v1/primary-storage/ceph/pools/8b2d94a2a12332a7ace559238644472c/actions

Parameter List

Name	Type	Location	Description	Starting Version
uuid	String	url	Resource UUID, uniquely identifies the resource	0.6
aliasName (optional)	String	body (nested in updateCephPrimaryStoragePool structure)		0.6
description (optional)	String	body (nested in updateCephPrimaryStoragePool structure)	Resource description	0.6
systemTags (optional)	List	body		0.6
userTags (optional)	List	body		0.6

API Response

Response Example

{
  "inventory": {
    "uuid": "7f0e174e86e739d695b0e5b9674e3638",
    "primaryStorageUuid": "6b247ebee1e4326998f10e03a5f8c230",
    "poolName": "pool name",
    "aliasName": "alias name",
    "description": "description",
    "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
inventory	CephPrimaryStoragePoolInventory	For details, see inventory	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

inventory

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

UpdateCephPrimaryStoragePoolAction action = new UpdateCephPrimaryStoragePoolAction();
action.uuid = "8b2d94a2a12332a7ace559238644472c";
action.aliasName = "alias";
action.description = "description";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateCephPrimaryStoragePoolAction.Result res = action.call();

Python SDK

UpdateCephPrimaryStoragePoolAction action = UpdateCephPrimaryStoragePoolAction()
action.uuid = "8b2d94a2a12332a7ace559238644472c"
action.aliasName = "alias"
action.description = "description"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateCephPrimaryStoragePoolAction.Result res = action.call()