Description

ボリュームの詳細情報を一覧で取得します。

Request URL

Volume API

GET /v3/{projectid}/volumes/detail

Request Json

This operation does not accept a request body.

Request Parameters

Parameter Value Style Description
X-Auth-Token トークン header トークンの情報を指定します。
トークンの発行方法は、トークン発行 にてご確認ください。
projectid テナントID path テナントIDを指定します。
指定する情報は、API情報を確認する にてご確認ください。
limit
(Optional)
表示件数 query 取得する情報の表示件数を指定します。
offset
(Optional)
開始位置 query 取得する情報の開始位置を指定します。
「limit」と併せて使用します。
marker
(Optional)
「limit」クエリで応答された情報の最後の項目のID query 「limit」クエリを実行後の応答結果から得られた最後の情報の次から改めて情報を取得したい場合に使用します。
使用する際は、「limit」クエリで実行後の応答結果で得られる最後の項目のIDを指定します。
「limit」と併せて使用します。
sort
(Optional)
項目・並び順 query ソート対象の項目と並び順を指定します。
指定する際は、「項目:並び順」の形式になります。
並び順は、「asc(昇順) 」または「desc(降順)」が指定できます。
with_count
(Optional)
true
false
query レスポンス結果に対象の個数を含めたい場合に使用します。
「true」もしくは「false」を指定します。
指定しない場合のデフォルトは「false」になるため、個数を表示させたい場合は「true」をご指定してください。

Response Code

Success

200

Example

Request

curl -X GET \
-H "Accept: application/json" \
-H "X-Auth-Token: トークン" \
https://block-storage.c3j1.conoha.io/v3/テナントID/volumes/detail

Response

{
	"volumes": [
		{
			"id": "ボリュームID",
			"status": "in-use",
			"size": 100,
			"availability_zone": "nova",
			"created_at": "2023-11-17T05:35:24.000000",
			"updated_at": "2023-11-17T05:45:51.000000",
			"name": "win-2023-11-17-14-33",
			"description": null,
			"volume_type": "c3j1-ds02-boot",
			"snapshot_id": null,
			"source_volid": null,
			"metadata": {
				"via_api": "int-api"
			},
			"links": [
				{
					"rel": "self",
					"href": "https://block-storage.c3j1.conoha.io/v3/テナントID/volumes/ボリュームID"
				},
				{
					"rel": "bookmark",
					"href": "https://block-storage.c3j1.conoha.io/テナントID/volumes/ボリュームID"
				}
			],
			"user_id": "ユーザーID",
			"bootable": "true",
			"encrypted": false,
			"replication_status": null,
			"consistencygroup_id": null,
			"multiattach": false,
			"attachments": [
				{
					"id": "ボリュームID",
					"attachment_id": "5dd8d995-c220-4f36-aa17-2f1015743f10",
					"volume_id": "ボリュームID",
					"server_id": "8d9d4a0c-4d69-4315-908e-bfaf28e73803",
					"host_name": null,
					"device": "/dev/vda",
					"attached_at": "2023-11-17T05:45:51.000000"
				}
			],
			"volume_image_metadata": {
				"hw_vif_multiqueue_enabled": "true",
				"hw_qemu_guest_agent": "yes",
				"hw_video_model": "vga",
				"architecture": "x86_64",
				"os_type": "windows",
				"bootable": "true",
				"os_version": "2022",
				"image_id": "243a0f63-0092-4f7f-ae79-d6d75d767f87",
				"image_name": "vmi-win-2022dce-amd64",
				"checksum": "d61e06773cecaa66c4111883d1d13aae",
				"container_format": "ovf",
				"disk_format": "qcow2",
				"min_disk": "100",
				"min_ram": "1024",
				"size": "13060538368"
			},
			"os-vol-tenant-attr:tenant_id": "テナントID"
		}
	]
}

ConoHaにて提供しておりますAPIにつきましては、クラウド基盤として採用しておりますOpenStackの機能にて実装しておりますので、詳細な情報や使い方はOpenStackのドキュメントにてご確認ください。