GetContainerList
- 印刷する
- PDF
GetContainerList
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
Classic/VPC環境で利用できます。
コンテナ(バケット)のリストを照会します。
参考
Subaccountの場合、Subaccount専用の External API Gatewayを通じて使用できます。
詳細は、SubAccountのGetContainerList APIをご参照ください。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
メソッド | URI |
---|---|
GET | /v1/AUTH_{project_id} |
リクエストヘッダ
ヘッダの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
X-Auth-Token | String | Required | 発行したトークン(Token)の値 |
Accept | String | Optional | 呼び出し結果の形式を指定
|
リクエストパスパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
project_id | String | Required | プロジェクト ID
|
container | String | Required | 照会するコンテナ(バケット)の名前 |
リクエストクエリパラメータ
パラメータの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
limit | Integer | Optional | 呼び出し結果の最大数制限 |
marker | String | Optional | 特定のコンテナ(バケット)以降のリストを返す |
end_marker | String | Optional | 特定のコンテナ(バケット)以前のリストを返す |
prefix | String | Optional | この文字列で始まるコンテナ(バケット)リストを返す |
reverse | String | Optional | コンテナ名でソートしてリストを表示
|
リクエスト例
リクエストのサンプルコードは次の通りです。
formatクエリパラメータなしでリクエスト
format
クエリパラメータなしでリクエストするサンプルコードは次の通りです。
curl -X GET "https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}"
-H "X-Auth-Token: $token"
formatクエリパラメータを JSONでリクエスト
format
クエリパラメータを JSONでリクエストするサンプルコードは次の通りです。
curl -X GET "https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}?format=json"
-H "X-Auth-Token: $token"
formatクエリパラメータを XMLでリクエスト
format
クエリパラメータを XMLでリクエストするサンプルコードは次の通りです。
curl -X GET "https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}?format=xml"
-H "X-Auth-Token: $token"
レスポンス
レスポンス形式を説明します。
レスポンスヘッダ
ヘッダの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
Content-Type | String | - | レスポンス結果の MIMEタイプ |
X-Account-Container-Count | Integer | - | アカウントにあるのコンテナ(バケット)の総数 |
X-Account-Object-Count | Integer | - | アカウントのオブジェクトの総数 |
X-Account-Bytes-Used | Integer | - | アカウントが使用する全容量(Byte) |
X-Timestamp | Integer | - | コンテナ(バケット)が作成された時刻(Unix Timestamp) |
X-Account-Storage-Policy-name-Bytes-Used | Integer | - | ヘッダ名のname に該当する storage policyの全容量(Byte) |
X-Account-Storage-Policy-name-Container-Count | Integer | - | ヘッダ名のname に該当する storage policyのコンテナ(バケット)の総数 |
X-Account-Storage-Policy-name-Object-Count | Integer | - | ヘッダ名のname に該当する storage policyのオブジェクトの総数 |
X-Account-Meta-name | String | - | アカウントのメタデータ
|
X-Account-Meta-Temp-URL-Key | String | - | temporary URLのための Secret Key値 |
X-Account-Meta-Temp-URL-Key-2 | String | - | temporary URLのための2番目の Secret Key値 |
Accept-Ranges | String | - | コンテナ(バケット)が対応する Rangeタイプ |
Content-Length | String | - | レスポンス結果の長さ(Byte) |
x-account-project-domain-id | String | - | API利用時に必要な Domain ID |
X-Trans-Id | String | - | リクエストのトランザクション ID |
X-Openstack-Request-Id | String | - | リクエストのトランザクション ID
|
Date | String | - | リクエストのレスポンスタイム(UTC) |
レスポンス構文
レスポンス構文は次の通りです。
formatクエリパラメータなしでリクエストした場合、コンテナ(バケット)に属するオブジェクトの名前だけ plainテキスト形式で返します。
"string"
[
{
"count": "number",
"last_modified":"string",
"bytes":"number",
"name":"string"
}
]
<?xml version="1.0" encoding="UTF-8"?>
<account name="AUTH_5942771066a0482bb6aaf7f5bc792b00">
<container>
<name>"string"</name>
<count>"number"</count>
<bytes>"number"</bytes>
<last_modified>"string"</last_modified>
</container>
</account>
レスポンスボディ
レスポンスボディの説明は次の通りです。
フィールド | タイプ | 必須の有無 | 説明 |
---|---|---|---|
name | String | - | コンテナの名前 |
count | Integer | - | コンテナにあるオブジェクト数 |
bytes | Integer | - | コンテナにあるオブジェクトの全容量(Byte) |
last_modified | String | - | 最終更新日時 |
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
HTTPステータスコード | コード | メッセージ | 説明 |
---|---|---|---|
200 | - | OK | リクエスト成功 |
204 | - | No Content | Content-Typeがplain で、リクエストに該当する内容がない場合に発生 |
403 | - | Not Found | コンテナ(バケット)が存在しない場合に発生 |
レスポンス例
レスポンスのサンプルコードは次の通りです。
formatクエリパラメータなしでリクエストした場合のレスポンス
format
クエリパラメータなしでリクエストした場合、レスポンスのサンプルコードは次の通りです。
HTTP/1.1 200 OK
Content-Length: 38
Accept-Ranges: bytes
X-Timestamp: 1535685069.28154
X-Account-Bytes-Used: 0
X-Account-Container-Count: 2
Content-Type: text/plain; charset=utf-8
X-Account-Object-Count: 0
x-account-project-domain-id: default
X-Trans-Id: tx928992622dd248ee9b3e8-005b972569
X-Openstack-Request-Id: tx928992622dd248ee9b3e8-005b972569
Date: Tue, 11 Sep 2018 02:16:09 GMT
ncloud-container-0
ncloud-container-1
formatクエリパラメータを JSONでリクエストした場合のレスポンス
format
クエリパラメータを JSONでリクエストした場合、レスポンスのサンプルコードは次の通りです。
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
X-Openstack-Request-Id: tx274a77a8975c4a66aeb24-0052d95365
Date: Fri, 17 Jan 2014 15:59:33 GMT
[
{
"count": 0,
"bytes": 0,
"name": "janeausten",
"last_modified": "2013-11-19T20:08:13.283452"
},
{
"count": 1,
"bytes": 14,
"name": "marktwain",
"last_modified": "2016-04-29T16:23:50.460230"
}
]
formatクエリパラメータを XMLでリクエストした場合のレスポンス
format
クエリパラメータを XMLでリクエストした場合、レスポンスのサンプルコードは次の通りです。
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
X-Openstack-Request-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>
<last_modified>2013-11-19T20:08:13.283452</last_modified>
</container>
<container>
<name>marktwain</name>
<count>1</count>
<bytes>14</bytes>
<last_modified>2016-04-29T16:23:50.460230</last_modified>
</container>
</account>
この記事は役に立ちましたか?