UpdateXskyBlockVolume
API Request
URLs
PUT zstack/v1/xsky/block-volumes/{uuid}/actions
Headers
Authorization: OAuth the-session-uuid
Body
{
"updateXskyBlockVolume": {
"name": "example"
},
"systemTags": [],
"userTags": []
}
In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.
Curl Sample
curl -H "Content-Type: application/json;charset=UTF-8"
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c"
-X PUT -d '{"updateXskyBlockVolume":{"name":"example"}}'
http://localhost:8080/zstack/v1/xsky/block-volumes/eeb07fe1a24833959f75c38b9c7e4132/actions
Request Parameters
| Name | Type | Location | Description | Optional Value | Starting Version |
|---|---|---|---|---|---|
| uuid | String | url | The resource UUID. | 4.7.11 | |
| name | String | body (contained in the updateXskyBlockVolume structure) | The resource name. | 4.7.11 | |
| description | String | body (contained in the updateXskyBlockVolume structure) | Optional. Optional. The detailed description of the resource. | 4.7.11 | |
| burstTotalBw | Long | body (contained in the updateXskyBlockVolume structure) | Optional. | 4.7.11 | |
| burstTotalIops | Long | body (contained in the updateXskyBlockVolume structure) | Optional. | 4.7.11 | |
| maxTotalBw | Long | body (contained in the updateXskyBlockVolume structure) | Optional. | 4.7.11 | |
| maxTotalIops | Long | body (contained in the updateXskyBlockVolume structure) | Optional. | 4.7.11 | |
| systemTags | List | body | Optional. The system tags. | 4.7.11 | |
| userTags | List | body | Optional. The user tags. | 4.7.11 |
API Response
When the API succeeded, an empty JSON structure {} is returned. When the API failed, the returned JSON structure includes an error field. For example,
{
"error": {
"code": "SYS.1001",
"description": "A message or a operation timeout",
"details": "Create VM on KVM timeout after 300s"
}
}
SDK Sample
Java SDK
UpdateXskyBlockVolumeAction action = new UpdateXskyBlockVolumeAction();
action.uuid = "eeb07fe1a24833959f75c38b9c7e4132";
action.name = "example";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateXskyBlockVolumeAction.Result res = action.call();
Python SDK
action = UpdateXskyBlockVolumeAction()
action.uuid = "eeb07fe1a24833959f75c38b9c7e4132"
action.name = "example"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()
