GetContainer

Prev Next

Classic/VPC環境で利用できます。

コンテナ(バケット)に属するオブジェクトリストとメタデータを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /v1/AUTH_{project_id}/{container}

リクエストヘッダ

ヘッダの説明は次の通りです。

フィールド タイプ 必須の有無 説明
X-Auth-Token String Required 発行したトークン(Token)の値
X-Newest Boolean Optional 最新のコピー情報でレスポンスするかどうかを設定
  • true | false
    • true: すべてのコピーに対してクエリを行い、最新のコピー情報でレスポンス
  • ヘッダが省略された場合、レスポンスが最も早い情報でレスポンス
Accept String Optional 呼び出し結果の形式を指定
  • application/json |application/xml |text/xml
X-Account-Meta-Temp-URL-Key String Optional temporary URLのための Secret Key値
X-Account-Meta-Temp-URL-Key-2 String Optional temporary URLのための2番目の Secret Key値

リクエストパスパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
project_id String Required プロジェクト ID
container String Required コンテナ(バケット)の名前

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
limit Integer Optional 呼び出し結果の最大数制限
marker String Optional 特定のコンテナ(バケット)以降のリストを返す
end_marker String Optional 特定のコンテナ(バケット)以前のリストを返す
prefix String Optional この文字列で始まるコンテナ(バケット)リストを返す
format String Optional 呼び出しの形式を指定(json、xml、plain)
delimiter String Optional この文字列を区切り文字として使用し、コンテナ(バケット)リストを階層構造で表現
path String Optional このパス内部のオブジェクトリストを返す
  • pathオプションよりはprefixか、delimiterオプションを推奨

リクエスト例

リクエストのサンプルコードは次の通りです。

formatクエリパラメータなしでリクエスト

formatクエリパラメータなしでリクエストするサンプルコードは次の通りです。

curl -X GET "https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}" 
-H "X-Auth-Token: $token"

formatクエリパラメータを JSONでリクエスト

formatクエリパラメータを JSONでリクエストするサンプルコードは次の通りです。

curl -X GET "https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}?format=json" 
-H "X-Auth-Token: $token"

formatクエリパラメータを XMLでリクエスト

formatクエリパラメータを JSONでリクエストするサンプルコードは次の通りです。

curl -X GET "https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}?format=xml" 
-H "X-Auth-Token: $token"

レスポンス

レスポンス形式を説明します。

レスポンスヘッダ

ヘッダの説明は次の通りです。

フィールド タイプ 必須の有無 説明
Content-Type String - レスポンス結果の MIMEタイプ
X-Container-Object-Count Integer - コンテナ(バケット)のオブジェクトの総数
X-Container-Bytes-Used Integer - コンテナ(バケット)が使用する全容量(Byte)
X-Timestamp Integer - コンテナ(バケット)が作成された時刻(Unix Timestamp)
Last-Modified String - コンテナ(バケット)の最終更新時間(UTC)
Accept-Ranges String - コンテナ(バケット)が対応する Rangeタイプ
Content-Length String - レスポンス結果の長さ(Bytes)
X-Storage-Policy String Optional コンテナ(バケット)の storage policy値
X-Trans-Id String - リクエストのトランザクション ID
X-Openstack-Request-Id String - リクエストのトランザクション ID
  • X-Trans-Idと同じ
X-Container-Meta-name String コンテナ(バケット)のメタデータ
  • ヘッダ名のname部分がメタデータのキーの役割を果たす
X-Container-Meta-Temp-URL-Key String Optional temporary URLのための Secret Key値
X-Container-Meta-Temp-URL-Key-2 String Optional temporary URLのための2番目の Secret Key値
X-Container-Meta-Quota-Count String Optional コンテナ(バケット)のオブジェクト数の制限値
X-Container-Meta-Quota-Bytes String Optional コンテナ(バケット)の容量制限値
X-Container-Read String Optional コンテナ(バケット)の READ ACL(アクセス権限)
X-Container-Write String Optional コンテナ(バケット)の WRITE ACL(アクセス権限)
X-Container-Sync-Key String Optional 使用しない
X-Container-Sync-To String Optional 使用しない
X-Versions-Location String Optional 使用しない
X-History-Location String Optional 使用しない
Date String - リクエストのレスポンスタイム(UTC)

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
200 - OK リクエスト成功
204 - No Content Content-Typeがplainで、リクエストに該当する内容がない場合に発生
404 - Not Found コンテナ(バケット)が存在しない場合に発生

レスポンス構文

レスポンス構文は次の通りです。

formatクエリパラメータなしでリクエストした場合、コンテナ(バケット)に属するオブジェクトの名前だけ plainテキスト形式で返します。

"string"

[
   {
      "hash":"string",
      "last_modified":"string",
      "bytes":"number",
      "name":"string",
      "content_type":"string"
   }
]

<?xml version="1.0" encoding="UTF-8"?>
<container name="string">
   
</container>

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
hash String - オブジェクトの MD5チェックサム値
name String - コンテナ(バケット)の名前
count Integer - コンテナ(バケット)にあるオブジェクト数
bytes Integer - コンテナ(バケット)にあるオブジェクトの全容量(Byte)
content_type String - レスポンス結果の MIMEタイプ
last_modified String - 最終更新日時

レスポンス例

レスポンスのサンプルコードは次の通りです。

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-test-object-0.txt
ncloud-test-object-1.txt

formatクエリパラメータを JSONでリクエストした場合のレスポンス

formatクエリパラメータを JSONでリクエストした場合、レスポンスのサンプルコードは次の通りです。

HTTP/1.1 200 OK
Content-Length: 352
X-Container-Object-Count: 2
X-Timestamp: 1536631895.01856
Accept-Ranges: bytes
X-Storage-Policy: standard01
Last-Modified: Tue, 11 Sep 2018 02:11:36 GMT
X-Container-Bytes-Used: 420024
Content-Type: application/json; charset=utf-8
X-Trans-Id: tx6bb706abe32b4ae5a49e8-005b978263
X-Openstack-Request-Id: tx6bb706abe32b4ae5a49e8-005b978263
Date: Tue, 11 Sep 2018 08:52:51 GMT

[
   {
      "hash":"9bd5b4f25faf491080654a34d57c3636",
      "last_modified":"2018-09-11T02:12:29.991410",
      "bytes":210012,
      "name":"ncloud-test-object-0.txt",
      "content_type":"text/plain"
   },
   {
      "hash":"9bd5b4f25faf491080654a34d57c3636",
      "last_modified":"2018-09-11T02:12:29.992600",
      "bytes":210012,
      "name":"ncloud-test-object-1.txt",
      "content_type":"text/plain"
   }
]

formatクエリパラメータを XMLでリクエストした場合のレスポンス

formatクエリパラメータを JSONでリクエストするサンプルコードは次の通りです。

HTTP/1.1 200 OK
Content-Length: 520
X-Container-Object-Count: 2
X-Timestamp: 1536631895.01856
Accept-Ranges: bytes
X-Storage-Policy: standard01
Last-Modified: Tue, 11 Sep 2018 02:11:36 GMT
X-Container-Bytes-Used: 420024
Content-Type: application/xml; charset=utf-8
X-Trans-Id: txfff4e8574d7e43f38b8e8-005b9782ef
X-Openstack-Request-Id: txfff4e8574d7e43f38b8e8-005b9782ef
Date: Tue, 11 Sep 2018 08:55:11 GMT

<?xml version="1.0" encoding="UTF-8"?>
<container name="ncloud-container-0">
   
   
</container>