Show a volume's 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/{volume_id}

HTTPステータスコード#

正常時：200

リクエストパラメータの説明#

名前 In Type デフォルト値
/必須指定		 Description
project_id path string 必須 プロジェクトのUUID
volume_id path string 必須 ボリュームのUUID

レスポンスボディ（正常系）の説明#

名前 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は、作成元と同じサイズの新規ボリュームを作成します。
volume object volumeオブジェクト
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 ボリュームのレプリカ作成用のドライバー
volume_type string 関連付けられているボリュームのタイプ
service_uuid string ボリュームのvolume-serviceを提供するノードを示すUUID
📒注: 表示するにはマイクロバージョン3.48以上を指定してください。
shared_targets boolean ボリュームをホストするバックエンドがshared_targetsを利用するかどうかを表現します。デフォルトは「true」です。

レスポンス例#

{
    "volume": {
        "status": "available",
        "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",
        "source_volid": null,
        "snapshot_id": null,
        "id": "5aa119a8-d25b-45a7-8d1b-88e127885635",
        "description": "Super volume.",
        "name": "vol-002",
        "created_at": "2013-02-25T02:40:21.000000",
        "volume_type": "None",
        "os-vol-tenant-attr:tenant_id": "0c2eba2c5af04d3f9e9d0d410b371fde",
        "size": 1,
        "os-volume-replication:driver_data": null,
        "os-volume-replication:extended_status": null,
        "metadata": {
            "contents": "not junk"
        }
    }
}