更新块存储卷

PUT/zstack/v1/block-volumes/{uuid}/actions

Request

cURL

curl --request PUT \
  --url '/v1/block-volumes/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/block-volumes/{uuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "updateBlockVolume": {
    "name": "example"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"updateBlockVolume":{"name":"example"}}' \
http://localhost:8080/zstack/v1/block-volumes/09c2f52fe02030019306d55b1ac7e849/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	4.7.11
name (可选)	String	body(包含在`updateBlockVolume`结构中)	资源名称	4.7.11
description (可选)	String	body(包含在`updateBlockVolume`结构中)	资源的详细描述	4.7.11
burstTotalBw (可选)	Long	body(包含在`updateBlockVolume`结构中)	突发带宽	4.7.11
burstTotalIops (可选)	Long	body(包含在`updateBlockVolume`结构中)	突发IOPS	4.7.11
maxTotalBw (可选)	Long	body(包含在`updateBlockVolume`结构中)	最大带宽	4.7.11
maxTotalIops (可选)	Long	body(包含在`updateBlockVolume`结构中)	最大IOPS	4.7.11
systemTags (可选)	List	body	系统标签	4.7.11
userTags (可选)	List	body	用户标签	4.7.11

API返回

该API成功时返回一个空的JSON结构{}，出错时返回的JSON结构包含一个error字段，例如：

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Create VM on KVM timeout after 300s"
  }
}

SDK示例

Java SDK

UpdateBlockVolumeAction action = new UpdateBlockVolumeAction();
action.uuid = "09c2f52fe02030019306d55b1ac7e849";
action.name = "example";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UpdateBlockVolumeAction.Result res = action.call();

Python SDK

UpdateBlockVolumeAction action = UpdateBlockVolumeAction()
action.uuid = "09c2f52fe02030019306d55b1ac7e849"
action.name = "example"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
UpdateBlockVolumeAction.Result res = action.call()