Description

イメージの一覧を取得します。

Request URL

Image API

GET /v2/images

Request Json

This operation does not accept a request body.

Request Parameters

Parameter Value Style Description
X-Auth-Token トークン header トークンの情報を指定します。
トークンの発行方法は、トークン発行 にてご確認ください。
limit
(Optional)
表示件数 query 取得する情報の表示件数を指定します。
marker
(Optional)
「limit」クエリで応答された情報の最後の項目のID query 「limit」クエリを実行後の応答結果から得られた最後の情報の次から改めて情報を取得したい場合に使用します。
使用する際は、「limit」クエリで実行後の応答結果で得られる最後の項目のIDを指定します。
「limit」と併せて使用します。
visibility
(Optional)
public
private
query イメージの公開状態の属性を指定します。
標準で用意されているイメージでフィルターをかける場合は、「public」を指定します。お客様独自で保存もしくは作成されたイメージでフィルターをかける場合は、「private」を指定します。
os_type
(Optional)
linux
windows
query OSタイプを指定します。
「linux」または「windows」が指定できます。
sort
(Optional)
項目・並び順 query ソート対象の項目と並び順を指定します。
指定する際は、「項目:並び順」の形式になります。
並び順は、「asc(昇順) 」または「desc(降順)」が指定できます。
sort_key
(Optional)
項目 query ソート対象の項目を指定します。
デフォルトの項目は「created_at」です。
sort_dir
(Optional)
asc
desc
query ソート対象の並び順を指定します。
並び順は、「asc(昇順) 」または「desc(降順)」が指定できます。デフォルトの項目は「desc」です。
name
(Optional)
イメージ名 query イメージ名を指定します。
status
(Optional)
イメージのステータス query イメージのステータスを指定します。
size_min
(Optional)
バイト数 query イメージの最小サイズ(バイト数)を指定します。
size_max
(Optional)
バイト数 query イメージの最大サイズ(バイト数)を指定します。
created_at
(Optional)
YYYY-MM-DDThh:mm:ss±hh:mm query イメージが作成された日時を指定します。
「2023-11-15T16:00:08-05:00」のように指定することができます。
updated_at
(Optional)
YYYY-MM-DDThh:mm:ss±hh:mm query イメージが更新された日時を指定します。
「2023-11-15T16:00:08-05:00」のように指定することができます。

Response Code

Success

200

Example

Request

curl -X GET \
-H "Accept: application/json" \
-H "X-Auth-Token: トークン" \
https://image-service.c3j1.conoha.io/v2/images?limit=200

Response

{
	"images": [
		{
			"status": "active",
			"name": "vmi-ubuntu-22.04-amd64",
			"tags": [
				"display_order=150",
				"service_type=vps",
				"dst_name=Ubuntu",
				"dst_version=22.04"
			],
			"container_format": "ovf",
			"created_at": "2023-10-25T09:55:09Z",
			"disk_format": "qcow2",
			"updated_at": "2023-11-22T03:06:57Z",
			"visibility": "public",
			"self": "/v2/images/イメージID",
			"min_disk": 100,
			"protected": false,
			"id": "イメージID",
			"file": "/v2/images/イメージID/file",
			"checksum": "3a0d3834019f4782c924050611e83a08",
			"os_type": "linux",
			"os_hash_algo": "sha512",
			"os_hash_value": "421b02a4d6be8d4dc3a575fef503a6289c782029cecd707e542f85431d6929ca97ec3a3f1d826b99f7f33bb3f48fe571b32e6188a2d172ca4ebf2d444a12870a",
			"os_hidden": false,
			"owner": "テナントID",
			"size": 6983843840,
			"min_ram": 1024,
			"schema": "/v2/schemas/image",
			"virtual_size": null,
			"architecture": "x86_64"
		}
	],
	"schema": "/v2/schemas/images",
	"first": "/v2/images?limit=200"
}

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