List accessible volumes with details#
利用可能なボリュームとその詳細を一覧表示します。
APIエンドポイント#
| リージョン | APIエンドポイント |
|---|---|
| 西日本リージョン3の場合 | https://blockstorage.jp-west-3.cloud.global.fujitsu.com |
| 東日本リージョン3の場合 | https://blockstorage.jp-east-3.cloud.global.fujitsu.com |
HTTPメソッドとURI#
GET
/v3/{project_id}/volumes/detail
HTTPステータスコード#
正常時：200
エラー時：400
リクエストパラメータの説明#
| 名前 | In | Type | デフォルト値 /必須指定 |
Description |
|---|---|---|---|---|
| project_id | path | string | 必須 | プロジェクトのUUID |
| sort | query | string | 任意 | ソートキーと任意のソート指示のリスト 以下の形式で、コンマ(,)で区切られます。 < キー > [: < 方向 > ] 方向は、「asc(昇順)」または「desc(降順)」のどちらかです。 |
| limit | query | integer | 任意 | クエリ結果で返却される項目の最大数 指定されたlimit値を超えない範囲で、最大個数の項目が返却されます。limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。 |
| offset | query | integer | 任意 | limitと組み合わせて、項目の一部分を表示させます。offsetは表示するリストの開始位置です。 |
| marker | query | string | 任意 | 前回のレスポンスの最後の項目のID limitパラメータを指定した場合、レスポンス内の最後の項目のIDをmarkerパラメータで指定して再度リクエストを送ることで、リストの続きを取得することができます。 |
| with_count | query | boolean | false 任意 |
レスポンスにある項目の数を表示するかどうかを設定します。 📒注: マイクロバージョン3.45以上を指定してください。 |
レスポンスボディ（正常系）の説明#
| 名前 | 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からのオフセットがある場合だけ表示されます。 |
| os-volume-replication:extended_status | string | バックエンドドライバーが管理する、ボリュームのレプリカ作成のステータス |
| replication_status | string | ボリュームのレプリカ作成のステータス |
| snapshot_id | string | 既存のスナップショットからボリュームを作成する場合は、スナップショットのUUIDを指定します。新規ボリュームは、スナップショットと同じアベイラビリティゾーンとサイズで作成されます。 |
| id | string | ボリュームのUUID |
| size | integer | ボリュームのサイズ(GB単位） |
| user_id | string | ユーザーのUUID |
| os-vol-tenant-attr:tenant_id | string | ボリュームの所有者のプロジェクトID |
| metadata | object | ボリュームに関連付けられるメタデータのキーと値のペア |
| status | string | ボリュームのステータス |
| volume_image_metadata | object | イメージのメタデータ項目のリスト イメージから作成されるボリュームとそのボリュームのスナップショットの場合だけに表示します。 |
| description | string | ボリュームの説明 |
| multiattach | boolean | 「true」の場合は、このボリュームは複数の仮想サーバにアタッチすることができます。 |
| source_volid | string | 作成元ボリュームのUUID このAPIは、作成元と同じサイズの新規ボリュームを作成します。 |
| consistencygroup_id | string | 整合性グループのUUID |
| os-vol-mig-status-attr:name_id | string | バックエンドに存在する、このボリュームの作成元ボリュームのID |
| 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からのオフセットがある場合だけ表示されます。 |
| os-volume-replication:driver_data | string | ボリュームのレプリカ作成用のドライバー |
| volumes | array | volumeオブジェクトのリスト |
| volume_type | string | 関連付けられているボリュームのタイプ |
| count | integer | ページに分割される前の、リクエストされるリソースの総数 📒注: 表示するにはマイクロバージョン3.45以上を指定してください。 |
レスポンス例#
{ "volumes": [ { "migration_status": null, "attachments": [ { "server_id": "f4fda93b-06e0-4743-8117-bc8bcecd651b", "attachment_id": "3b4db356-253d-4fab-bfa0-e3626c0b8405", "host_name": null, "volume_id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38", "device": "/dev/vdb", "id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38" } ], "links": [ { "href": "http://23.253.248.171:8776/v3/bab7d5c60cd041a0a36f7c4b6e1dd978/volumes/6edbc2f4-1507-44f8-ac0d-eed1d2608d38", "rel": "self" }, { "href": "http://23.253.248.171:8776/bab7d5c60cd041a0a36f7c4b6e1dd978/volumes/6edbc2f4-1507-44f8-ac0d-eed1d2608d38", "rel": "bookmark" } ], "availability_zone": "nova", "encrypted": false, "os-volume-replication:extended_status": null, "replication_status": "disabled", "snapshot_id": null, "id": "6edbc2f4-1507-44f8-ac0d-eed1d2608d38", "size": 2, "user_id": "32779452fcd34ae1a53a797ac8a1e064", "os-vol-tenant-attr:tenant_id": "bab7d5c60cd041a0a36f7c4b6e1dd978", "metadata": { "readonly": false, "attached_mode": "rw" }, "status": "in-use", "description": null, "multiattach": true, "os-volume-replication:driver_data": null, "source_volid": null, "consistencygroup_id": null, "os-vol-mig-status-attr:name_id": null, "name": "test-volume-attachments", "bootable": "false", "created_at": "2015-11-29T03:01:44.000000", "volume_type": "lvmdriver-1" }, { "migration_status": null, "attachments": [], "links": [ { "href": "http://23.253.248.171:8776/v3/bab7d5c60cd041a0a36f7c4b6e1dd978/volumes/173f7b48-c4c1-4e70-9acc-086b39073506", "rel": "self" }, { "href": "http://23.253.248.171:8776/bab7d5c60cd041a0a36f7c4b6e1dd978/volumes/173f7b48-c4c1-4e70-9acc-086b39073506", "rel": "bookmark" } ], "availability_zone": "nova", "encrypted": false, "os-volume-replication:extended_status": null, "replication_status": "disabled", "snapshot_id": null, "id": "173f7b48-c4c1-4e70-9acc-086b39073506", "size": 1, "user_id": "32779452fcd34ae1a53a797ac8a1e064", "os-vol-tenant-attr:tenant_id": "bab7d5c60cd041a0a36f7c4b6e1dd978", "metadata": {}, "status": "available", "volume_image_metadata": { "kernel_id": "8a55f5f1-78f7-4477-8168-977d8519342c", "checksum": "eb9139e4942121f22bbc2afc0400b2a4", "min_ram": "0", "ramdisk_id": "5f6bdf8a-92db-4988-865b-60bdd808d9ef", "disk_format": "ami", "image_name": "cirros-0.3.4-x86_64-uec", "image_id": "b48c53e1-9a96-4a5a-a630-2e74ec54ddcc", "container_format": "ami", "min_disk": "0", "size": "25165824" }, "description": "", "multiattach": false, "os-volume-replication:driver_data": null, "source_volid": null, "consistencygroup_id": null, "os-vol-mig-status-attr:name_id": null, "name": "test-volume", "bootable": "true", "created_at": "2015-11-29T02:25:18.000000", "volume_type": "lvmdriver-1" } ], "count": 10 }