コンテナ一覧取得 GET /v1/{account}{?limit,marker,end_marker, format,prefix,delimiter}

アカウントの詳細とリストコンテナを取得する

形式を指定しない場合は、text/plain形式でコンテナ一覧が取得されます。

また、クエリパラメーターを使用すると、コンテナのリストをページに分けて取得できます。取得したコンテナの数が、limitパラメーターで指定した値より少ない場合、リストは最後まで取得されています。取得したコンテナの数が、limitパラメーターで指定した値と等しい場合、リストにはまだ未取得のコンテナが残っています。

コンテナの一覧取得に成功した場合、下記のステータスコードが返却されます：

200 OK. レスポンスボディにコンテナ一覧が含まれる場合に返却されます。
204 No Content コンテナが存在しない場合やlimit，marker，end_markerのクエリパラメーターを使ってフィルタリングしたコンテナ一覧のサブセットが空の場合に返却されます。

Request Headers

X-Auth-Token

認証トークン

Data Type	Cardinality
String	1..1

X-Newest

Trueを設定すると、オブジェクトストレージはすべてのレプリカから最新のレプリカを探して返却します。本ヘッダーを省略すると、オブジェクトストレージは正常なレプリカを一つ選んで返却します。本ヘッダーにTrueを指定すると、応答時間が長くなります。絶対に必要な場合にだけ使用してください。

Data Type	Cardinality
Boolean	0..1

Accept

application/json, application/xml, text/xmlを設定できます。

Data Type	Cardinality
String	0..*

Request Parameter

{account}

プロジェクト単位でユニークに割り当てられる名前

Data Type	Cardinality
String	1..1

limit

一度に取得できるコンテナの最大数

任意の数値(1～10000)を指定すると、その数値分の一覧を返却します。デフォルトは10000です。

Data Type	Cardinality
Int	0..1

marker

指定した文字列より後のコンテナ名一覧を返却します。

Data Type	Cardinality
String	0..1

end_marker

指定した文字列より前のコンテナ名一覧を返却します。

Data Type	Cardinality
String	0..1

format

レスポンスのフォーマットを指定します。json，xml，plainから選択できます。デフォルトはplainです。

format=xmlまたはformat=jsonをクエリパラメーターに追加すると、コンテナ名だけでなく、コンテナの詳細情報を含む結果を取得します。

format=plain をクエリパラメーターに指定すると、改行区切りでコンテナ名の一覧を取得します。

Data Type	Cardinality
String	0..1

prefix

この文字列から始まるコンテナの一覧を返却します。

Data Type	Cardinality
String	0..1

Response Headers

Content-Length

レスポンスボディのバイト数

Data Type	Cardinality
String	1..1

Content-Type

レスポンスボディのMIMEタイプ。

Data Type	Cardinality
String	1..1

X-Account-Object-Count

アカウント内オブジェクトの総数

Data Type	Cardinality
Int	1..1

X-Account-Bytes-Used

アカウントがオブジェクトストレージに格納したオブジェクトの合計バイトサイズ

Data Type	Cardinality
Int	1..1

X-Account-Container-Count

コンテナの総数

Data Type	Cardinality
Int	1..1

X-Account-Meta-name

アカウントメタデータ。{name}はメタデータ項目の名前。

Data Type	Cardinality
String	0..*

X-Account-Meta-Temp-URL-Key

Temporary URLsのために使用する秘密鍵。設定していない場合はこのヘッダーは返却されません。

Data Type	Cardinality
String	0..1

X-Account-Meta-Temp-URL-Key-2

Temporary URLsのために使用する2つ目の秘密鍵。設定していない場合はこのヘッダーは返却されません。

Data Type	Cardinality
String	0..1

X-Trans-Id

このリクエストに付与されるID。トラブルについて問い合わせる際に利用されます。

Data Type	Cardinality
Uuid	1..1

Date

トランザクションの実行された日付と時間

Data Type	Cardinality
Datetime	1..1

Response Elements

account

レスポンスのエンベロープ

Data Type	Cardinality	Parent Element	Child Element(s)
account	1..1	None	container

container

コンテナ情報の一式

Data Type	Cardinality	Parent Element	Child Element(s)
container	0..n	account	name count bytes

Data Type

Cardinality

Parent Element

Child Element(s)

container

0..n

account

name

count

bytes

name

コンテナ名

Data Type	Cardinality	Parent Element	Child Element(s)
string	0..n	container	None

count

コンテナが保有するオブジェクト数

Data Type	Cardinality	Parent Element	Child Element(s)
string	0..1	container	None

bytes

コンテナが保有するオブジェクト数の総サイズ

Data Type	Cardinality	Parent Element	Child Element(s)
string	0..1	container	None

Example List containers response: HTTP and JSON

Example of Request


curl -i $publicURL?format=json -X GET -H "X-Auth-Token: $token"

Example of Response


HTTP/1.1 200 OK
Content-Length: 96
X-Account-Object-Count: 1
X-Timestamp: 1389453423.35964
X-Account-Meta-Subject: Literature
X-Account-Bytes-Used: 14
X-Account-Container-Count: 2
Content-Type: application/json; charset=utf-8
Accept-Ranges: bytes
X-Trans-Id: tx274a77a8975c4a66aeb24-0052d95365
Date: Fri, 17 Jan 2014 15:59:33 GMT

[
	{
		"count": 0,
		"bytes": 0,
		"name": "janeausten"
	},
	{
		"count": 1,
		"bytes": 14,
		"name": "marktwain"
	}
]

Example List containers response: HTTP and XML

Example of Request


curl -i $publicURL?format=xml -X GET -H "X-Auth-Token: $token"

Example of Response


HTTP/1.1 200 OK
Content-Length: 262
X-Account-Object-Count: 1
X-Timestamp: 1389453423.35964
X-Account-Meta-Subject: Literature
X-Account-Bytes-Used: 14
X-Account-Container-Count: 2
Content-Type: application/xml; charset=utf-8
Accept-Ranges: bytes
X-Trans-Id: tx69f60bc9f7634a01988e6-0052d9544b
Date: Fri, 17 Jan 2014 16:03:23 GMT

<?xml version="1.0" encoding="UTF-8"?>
	<account name="my_account">
		<container>
			<name>janeausten</name>
			<count>0</count>
			<bytes>0</bytes>
		</container>
		<container>
		<name>marktwain</name>
		<count>1</count>
		<bytes>14</bytes>
	</container>
</account>