Update a volume#
ボリュームを更新します。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://blockstorage.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://blockstorage.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
PUT
/v3/{project_id}/volumes/{volume_id}
HTTPステータスコード#
正常時:200
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| project_id | path | string | 必須 | プロジェクトのUUID |
| volume_id | path | string | 必須 | ボリュームのUUID |
| volume | body | object | 必須 | volumeオブジェクト |
| description | body | string | 任意 | ボリュームの説明 |
| name | body | string | 任意 | ボリュームの名前 |
| metadata | body | object | 任意 | スナップショットのメタデータのキーと値のペア (存在しない場合もあります) |
レスポンスボディ(正常系)の説明#
| 名前 | Type | Description |
|---|---|---|
| migration_status | string | ボリュームのマイグレーションステータス |
| attachments | array | 仮想サーバのアタッチメントの情報 ボリュームが仮想サーバにアタッチされている場合、サーバのUUID、アタッチメントUUID、アタッチされているホスト(ある場合)、機器、機器のUUIDを表示します。仮想サーバがアタッチされていない場合は、空欄です。 |
| links | array | ボリュームのリンクURL |
| availability_zone | string | アベイラビリティゾーンの名前 |
| encrypted | boolean | 「true」の場合は、ボリュームが暗号化されています。 |
| updated_at | string | リソースの最新更新日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。 |
| replication_status | string | ボリュームのレプリカ作成のステータス |
| snapshot_id | string | 既存のスナップショットからボリュームを作成する場合は、スナップショットのUUIDを指定します。新規ボリュームは、スナップショットと同じアベイラビリティゾーンとサイズで作成されます。 |
| id | string | ボリュームのUUID |
| size | integer | ボリュームのサイズ(GB単位) |
| user_id | string | ユーザーのUUID |
| metadata | object | スナップショットのメタデータのキーと値のペア (存在しない場合もあります) |
| status | string | ボリュームのステータス |
| description | string | ボリュームの説明 |
| multiattach | boolean | 「true」の場合は、このボリュームは複数の仮想サーバにアタッチすることができます。 |
| source_volid | string | 作成元ボリュームのUUID このAPIは、作成元と同じサイズの新規ボリュームを作成します。 |
| volume | object | volumeオブジェクト |
| consistencygroup_id | string | 整合性グループのUUID |
| name | string | ボリュームの名前 |
| bootable | string | ブートの可否を制御します。「true」の場合は、ボリュームから仮想サーバを起動させることができます。 |
| created_at | string | リソースの作成日時 日時の入力形式は以下のISO 8601形式です。 CCYY-MM-DDThh:mm:ss±hh:mm例:2015-08-27T09:49:58-05:00 「±hh:mm」の部分は、タイムゾーンにUTCからのオフセットがある場合だけ表示されます。 |
| volume_type | string | 関連付けられているボリュームのタイプ |
リクエスト例#
{ "volume": { "name": "vol-003", "description": "This is yet, another volume.", "metadata": { "name": "metadata0" } } }
レスポンス例#
{ "volume": { "status": "available", "migration_status": null, "user_id": "0eea4eabcf184061a3b6db1e0daaf010", "attachments": [], "links": [ { "href": "http://localhost:8776/v3/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635", "rel": "self" }, { "href": "http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635", "rel": "bookmark" } ], "availability_zone": "nova", "bootable": "false", "encrypted": false, "created_at": "2015-11-29T03:01:44.000000", "description": "This is yet, another volume.", "updated_at": null, "volume_type": "lvmdriver-1", "name": "vol-003", "replication_status": "disabled", "consistencygroup_id": null, "source_volid": null, "snapshot_id": null, "multiattach": false, "metadata": { "contents": "not junk" }, "id": "5aa119a8-d25b-45a7-8d1b-88e127885635", "size": 1 } }