コンテナのオペレーション
コンテナ(バケット)及びオブジェクトリストの照会
構文
GET /v1/AUTH_{project_id}/{container}
リクエストの例 (JSON)
curl -i -X GET -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}?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"
}
]
リクエストの例 (XML)
curl -i -X GET -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}?format=XML
レスポンスの例
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">
<object>
<name>ncloud-test-object-0.txt</name>
<hash>9bd5b4f25faf491080654a34d57c3636</hash>
<bytes>210012</bytes>
<content_type>text/plain</content_type>
<last_modified>2018-09-11T02:12:29.991410</last_modified>
</object>
<object>
<name>ncloud-test-object-1.txt</name>
<hash>9bd5b4f25faf491080654a34d57c3636</hash>
<bytes>210012</bytes>
<content_type>text/plain</content_type>
<last_modified>2018-09-11T02:12:29.992600</last_modified>
</object>
</container>
リクエストが成功したら、OK (200)、No Content (204)のステータスコードをレスポンスします。 No Content (204)である場合は、Content-Typeがplainであり、リクエストに該当する内容がない場合に発生します。 コンテナ(バケット)が存在しない場合は、Not Found (404)のステータスコードをレスポンスします。
リクエストのパラメータ
Name | In | Type | Description |
---|---|---|---|
project_id (Optional) | path | string | プロジェクトIDを入力します。 |
container (Optional) | path | string | コンテナの名前を入力します。 |
limit (Optional) | query | integer | 呼び出しの結果の最大数を制限します。 |
marker (Optional) | query | string | 特定のオブジェクトの後のリストを取得します。 |
end_marker (Optional) | query | string | 特定のオブジェクト前のリストを取得します。 |
prefix (Optional) | query | string | 該当文字列で始まるオブジェクトのリストを呼び出します。 |
format (Optional) | query | string | 呼び出しの結果のフォーマットを指定します。(json, xml, plain) |
delimiter (Optional) | query | string | 該当文字列を区切り文字として使用して、オブジェクトの名前に含まれている場合は、sub-dirの結果を表示します。 |
path (Optional) | query | string | 該当パスの内部のオブジェクトのリストを表示します。 pathオプションよりprefix / delimiterクエリをお勧めします。 |
X-Auth-Token (Optional) | header | string | 発行したTokenの値を入力します。 |
X-Newest (Optional) | header | boolean | trueの場合、すべてのコピーについて問い、最も最新のコピー情報でレスポンスします。該当のヘッダーが省略された場合には、最もレスポンスが速い情報でレスポンスします。 |
Accept (Optional) | header | string | 呼び出しの結果のフォーマットを指定します。(application/json, application/xml, text/xml) |
X-Container-Meta-Temp-URL-Key (Optional) | header | string | temporary URLのためのSecret Keyの値を入力します。 |
X-Container-Meta-Temp-URL-Key-2 (Optional) | header | string | temporary URLのための2番目のSecret Keyの値を入力します。 |
X-Storage-Policy (Optional) | header | string | not supported |
レスポンスのパラメータ
Name | In | Type | Description |
---|---|---|---|
X-Container-Meta-name | header | string | 該当コンテナのメタデータ情報です。ヘッダー名のname部分がメタデータのキーの役割をします。 |
Content-Length | header | string | レスポンス結果の長さです。(Bytes) |
X-Container-Object-Count | header | integer | 該当コンテナ(バケット)のオブジェクトの数です。 |
X-Container-Bytes-Used | header | integer | 該当コンテナ(バケット)が使う全体のサイズです。(Bytes) |
Accept-Ranges | header | string | |
X-Container-Meta-Temp-URL-Key (Optional) | header | string | temporary URLのためのSecret Keyの値です。 |
X-Container-Meta-Temp-URL-Key-2 (Optional) | header | string | temporary URLのための2番目のSecret Keyの値です。 |
X-Container-Meta-Quota-Count (Optional) | header | string | 該当コンテナ(バケット)の容量の制限値です。 |
X-Container-Meta-Quota-Bytes (Optional) | header | string | 該当コンテナ(バケット)のオブジェクト数の制限値です。 |
X-Storage-Policy (Optional) | header | string | not supported |
X-Container-Read (Optional) | header | string | 該当コンテナのREAD ACLです。 |
X-Container-Write (Optional) | header | string | 該当コンテナのWRITE ACLです。 |
X-Container-Sync-Key (Optional) | header | string | not supported |
X-Container-Sync-To (Optional) | header | string | not supported |
X-Versions-Location (Optional) | header | string | not supported |
X-History-Location (Optional) | header | string | noet supported |
X-Timestamp | header | integer | 該当コンテナ(バケット)が初めて生成された時刻です。(UNIX Time) |
X-Trans-Id | header | string | 該当リクエストのトランザクションIDです。 |
X-Openstack-Request-Id | header | string | 該当リクエストのトランザクションIDです。(X-Trans-Idと同じです。) |
Content-Type | header | string | レスポンス結果のフォーマットです。(text/plain, application/json, application/xml, text/xml) |
Date | header | string | 該当リクエストのレスポンス時間です。(UTC) |
hash | body | string | 該当オブジェクトのMD5チェックサムの値です。 |
last_modified | body | string | 該当オブジェクトが最後に変更された時刻です。(UTC) |
content_type | body | string | 該当オブジェクトのタイプです。 |
bytes | body | integer | 該当オブジェクトの大きさです。(bytes) |
name | body | string | 該当オブジェクトの名前です。 |
コンテナ(バケット)の生成
構文
PUT /v1/AUTH_{project_id}/{container}
リクエストの例 (コンテナの生成)
curl -i -X PUT -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}
レスポンスの例
HTTP/1.1 201 Created
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: txa8b5404ac864437293727-005b9878d1
X-Openstack-Request-Id: txa8b5404ac864437293727-005b9878d1
Date: Wed, 12 Sep 2018 02:24:17 GMT
リクエストの例 (コンテナの生成、メタデータを含む)
curl -i -X PUT -H "X-Auth-Token: $token" -H "X-Container-Meta-Book: ncloud-book" -H "X-Container-Meta-Subject: ncloud-test-subject" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}
レスポンスの例
HTTP/1.1 201 Created
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx8282719a30554e2b8e0c7-005b987946
X-Openstack-Request-Id: tx8282719a30554e2b8e0c7-005b987946
Date: Wed, 12 Sep 2018 02:26:14 GMT
リクエストの例 (コンテナの生成、ACLを含む)
curl -i -X PUT -H "X-Auth-Token: $token" -H "X-Container-Read: .r:* https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}
レスポンスの例
HTTP/1.1 201 Created
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx691a8ed48a3f4152ae904-005b98799c
X-Openstack-Request-Id: tx691a8ed48a3f4152ae904-005b98799c
Date: Wed, 12 Sep 2018 02:27:41 GMT
リクエストが成功したら、Created (201), Accepted (202)のステータスコードをレスポンスします。 Accepted (202)である場合は、既に該当のコンテナ(バケット)が存在し、メタデータなどを変更する際に発生します。 コンテナ(バケット)が存在しない場合は、Not Found (404)のステータスコードをレスポンスします。
リクエストのパラメータ
Name | In | Type | Description |
---|---|---|---|
project_id (Optional) | path | string | プロジェクトIDを入力します。 |
container (Optional) | path | string | 生成するコンテナ(バケット)名を入力します。最低3文字以上、最大30文字まで入力可能です。slash(/)が含まれると、{container}/{object}に認知してしまうので注意 |
X-Auth-Token (Optional) | header | string | 発行したTokenの値を入力します。 |
X-Container-Read (Optional) | header | string | 該当コンテナのREAD ACLです。 |
X-Container-Write (Optional) | header | string | 該当コンテナのWRITE ACLです。 |
X-Container-Sync-Key (Optional) | header | string | not supported |
X-Container-Sync-To (Optional) | header | string | not supported |
X-Versions-Location (Optional) | header | string | not supported |
X-History-Location (Optional) | header | string | not supported |
X-Container-Meta-{name} (Optional) | header | string | 該当コンテナ(バケット)のメタデータを設定します。ヘッダー名のname部分がメタデータのキーの役割をします。追加、アップデート、削除が可能で、削除は空の値でリクエストすればよいです。 |
X-Container-Meta-Access-Control-Allow-Origin (Optional) | header | string | CORS |
X-Container-Meta-Access-Control-Max-Age (Optional) | header | string | CORS |
X-Container-Meta-Access-Control-Expose-Headers (Optional) | header | string | CORS |
X-Container-Meta-Quota-Bytes (Optional) | header | string | 該当コンテナ(バケット)の容量の制限値を入力します。(bytes) 容量が超えてから、制限をかけます。 |
X-Container-Meta-Quota-Count (Optional) | header | string | 該当コンテナ(バケット)のオブジェクト数の制限値を入力します。 |
X-Container-Meta-Temp-URL-Key (Optional) | header | string | temporary URLのためのSecret Keyの値を入力します。 |
X-Container-Meta-Temp-URL-Key-2 (Optional) | header | string | temporary URLのための2番目のSecret Keyの値を入力します。 |
レスポンスのパラメータ
Name | In | Type | Description |
---|---|---|---|
Date | header | string | 該当リクエストのレスポンス時間です。(UTC) |
X-Timestamp | header | integer | not supported |
Content-Length | header | string | レスポンス結果の長さです。(Bytes) |
Content-Type (Optional) | header | string | レスポンス結果のMIMEタイプです。 |
X-Trans-Id | header | string | 該当リクエストのトランザクションIDです。 |
X-Openstack-Request-Id | header | string | 該当リクエストのトランザクションIDです。(X-Trans-Idと同じです。) |
コンテナ(バケット) メタデータの設定
構文
POST /v1/AUTH_{project_id}/{container}
リクエストの例 (コンテナ メタデータの生成)
curl -i -X POST -H "X-Container-Meta-Book: ncloud-book" -H "X-Container-Meta-Subject: ncloud-test-subject" -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: txefe14b178c56469b8576f-005b987d66
X-Openstack-Request-Id: txefe14b178c56469b8576f-005b987d66
Date: Wed, 12 Sep 2018 02:43:50 GMT
リクエストの例 (コンテナ メタデータのアップデート)
curl -i -X POST -H "X-Container-Meta-Book: ncloud-book2" -H "X-Container-Meta-Subject: ncloud-test-subject2" -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx66932a917b854a458544a-005b987d78
X-Openstack-Request-Id: tx66932a917b854a458544a-005b987d78
Date: Wed, 12 Sep 2018 02:44:08 GMT
リクエストの例 (コンテナ メタデータの削除)
curl -i -X POST -H "X-Remove-Container-Meta-Book: x" -H "X-Remove-Container-Meta-Subject: x" -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx590d9493661147e780d99-005b987df5
X-Openstack-Request-Id: tx590d9493661147e780d99-005b987df5
Date: Wed, 12 Sep 2018 02:46:13 GMT
リクエストが成功すれば、No Content (204)のステータスコードをレスポンスします。
リクエストのパラメータ
Name | In | Type | Description |
---|---|---|---|
project_id (Optional) | path | string | プロジェクトIDを入力します。 |
container (Optional) | path | string | コンテナ(バケット)名を入力します。 |
X-Auth-Token (Optional) | header | string | 発行したTokenの値を入力します。 |
X-Container-Read (Optional) | header | string | 該当コンテナのREAD ACLです。 |
X-Container-Write (Optional) | header | string | 該当コンテナのWRITE ACLです。 |
X-Container-Sync-Key (Optional) | header | string | not supported |
X-Container-Sync-To (Optional) | header | string | not supported |
X-Versions-Location (Optional) | header | string | not supported |
X-History-Location (Optional) | header | string | not supported |
X-Remove-Versions-Location (Optional) | header | string | not supported |
X-Remove-History-Location (Optional) | header | string | not supported |
X-Container-Meta-{name} (Optional) | header | string | 該当コンテナ(バケット)のメタデータを設定します。ヘッダー名のname部分がメタデータのキーの役割をします。 |
X-Remove-Container-{name} (Optional) | header | string | 該当コンテナ(バケット)のメタデータを削除します。ヘッダー名のname部分がメタデータのキーの役割をします。X-Remove-Container-ReadあるいはX-Remove-Container-Meta-{name} |
X-Container-Meta-Access-Control-Allow-Origin (Optional) | header | string | CORS |
X-Container-Meta-Access-Control-Max-Age (Optional) | header | string | CORS |
X-Container-Meta-Access-Control-Expose-Headers (Optional) | header | string | CORS |
X-Container-Meta-Quota-Bytes (Optional) | header | string | 該当コンテナ(バケット)の容量の制限値を入力します。(bytes) 容量制限を超えてから、制限をかけます。 |
X-Container-Meta-Quota-Count (Optional) | header | string | 該当コンテナ(バケット)のオブジェクト数の制限値を入力します。 |
X-Container-Meta-Temp-URL-Key (Optional) | header | string | temporary URLのためのSecret Keyの値を入力します。 |
X-Container-Meta-Temp-URL-Key-2 (Optional) | header | string | temporary URLのための2番目のSecret Keyの値を入力します。 |
レスポンスのパラメータ
Name | In | Type | Description |
---|---|---|---|
Date | header | string | 該当リクエストのレスポンス時間です。(UTC) |
X-Timestamp | header | integer | not supported |
Content-Length | header | string | レスポンス結果の長さです。(Bytes) |
Content-Type (Optional) | header | string | レスポンス結果のMIMEタイプです。 |
X-Trans-Id | header | string | 該当リクエストのトランザクションIDです。 |
X-Openstack-Request-Id | header | string | 該当リクエストのトランザクションIDです。(X-Trans-Idと同じです。) |
コンテナ(バケット)メタデータの照会
構文
HEAD /v1/AUTH_{project_id}/{container}
リクエストの例 (コンテナメタデータの照会)
curl -i -X HEAD -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
X-Container-Object-Count: 3
X-Timestamp: 1536631895.01856
Accept-Ranges: bytes
Last-Modified: Tue, 11 Sep 2018 02:11:36 GMT
X-Container-Bytes-Used: 630036
Content-Type: text/plain; charset=utf-8
X-Trans-Id: tx51f8478e8e924403851a4-005b988014
X-Openstack-Request-Id: tx51f8478e8e924403851a4-005b988014
Date: Wed, 12 Sep 2018 02:55:16 GMT
リクエストに成功すれば、No Content (204) のステータスコードをレスポンスします。
リクエストのパラメータ
Name | In | Type | Description |
---|---|---|---|
project_id (Optional) | path | string | プロジェクトIDを入力します。 |
container (Optional) | path | string | 生成するコンテナ(バケット)の名前を入力します。最低3文字以上、最大30文字まで入力可能です。slash(/)が含まれると、{container}/{object}で認知してしまうので注意 |
X-Auth-Token (Optional) | header | string | 発行したTokenの値を入力します。 |
X-Newest (Optional) | header | boolean | trueの場合、全てのコピーに対して問い、最も最新のコピーの情報でレスポンスします。該当のヘッダーが省略された場合、最もレスポンスが速い情報でレスポンスします。 |
レスポンスのパラメータ
Name | In | Type | Description |
---|---|---|---|
X-Container-Meta-{name} | header | string | 該当コンテナ(バケット)のメタデータです。ヘッダー名のname部分がメタデータのキーの役割をします。 |
Content-Length | header | string | レスポンス結果の長さです。(Bytes) |
X-Container-Object-Count | header | integer | 該当コンテナ(バケット)のオブジェクトの数です。 |
X-Container-Bytes-Used | header | integer | 該当コンテナ(バケット)が使用する全体容量のサイズです。(Bytes) |
X-Container-Read (Optional) | header | string | 該当コンテナのREAD ACLです。 |
X-Container-Write (Optional) | header | string | 該当コンテナのWRITE ACLです。 |
X-Container-Meta-Quota-Bytes (Optional) | header | string | 該当コンテナ(バケット)の容量の制限値です。(bytes) |
X-Container-Meta-Quota-Count (Optional) | header | string | 該当コンテナ(バケット)のオブジェクト数の制限値です。 |
Accept-Ranges | header | string | |
X-Container-Meta-Access-Control-Allow-Origin (Optional) | header | string | CORS |
X-Container-Meta-Access-Control-Max-Age (Optional) | header | string | CORS |
X-Container-Meta-Access-Control-Expose-Headers (Optional) | header | string | CORS |
X-Container-Meta-Temp-URL-Key (Optional) | header | string | temporary URLのためのSecret Keyの値です。 |
X-Container-Meta-Temp-URL-Key-2 (Optional) | header | string | temporary URLのための2番目のSecret Keyの値です。 |
X-Timestamp | header | integer | 該当コンテナ(バケット)が初めて生成された時刻です。(UNIX Time) |
X-Container-Sync-Key (Optional) | header | string | not supported |
X-Container-Sync-To (Optional) | header | string | not supported |
Date | header | string | 該当リクエストのレスポンス時間です。(UTC) |
X-Trans-Id | header | string | 該当リクエストのトランザクションIDです。 |
X-Openstack-Request-Id | header | string | 該当リクエストのトランザクションIDです。(X-Trans-Idと同じです。) |
Content-Type (Optional) | header | string | レスポンス結果のMIMEタイプです。 |
X-Versions-Location (Optional) | header | string | not supported |
X-History-Location (Optional) | header | string | not supported |
コンテナ(バケット)の削除
構文
DELETE /v1/AUTH_{project_id}/{container}
リクエストの例
curl -i -X DELETE -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}/{container}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: tx762d33b115e748a29fb6e-005b98975b
X-Openstack-Request-Id: tx762d33b115e748a29fb6e-005b98975b
Date: Wed, 12 Sep 2018 04:34:35 GMT
リクエストに成功すれば、No Content (204) のステータスコードをレスポンスします。
リクエストのパラメータ
Name | In | Type | Description |
---|---|---|---|
project_id (Optional) | path | string | プロジェクトIDを入力します。 |
container (Optional) | path | string | コンテナ(バケット)名を入力します。 |
X-Auth-Token (Optional) | header | string | 発行したTokenの値を入力します。 |
レスポンスのパラメータ
Name | In | Type | Description |
---|---|---|---|
Date | header | string | 該当リクエストのレスポンス時間です。(UTC) |
X-Timestamp | header | integer | not supported |
Content-Length | header | string | レスポンス結果の長さです。 (Bytes) |
Content-Type (Optional) | header | string | レスポンス結果のMIMEタイプです。 |
X-Trans-Id | header | string | 該当リクエストのトランザクションIDです。 |
X-Openstack-Request-Id | header | string | 該当リクエストのトランザクションIDです。(X-Trans-Idと同じです。) |