アカウントのオペレーション
アカウント及びコンテナ(バケット)リストの照会
構文
GET /v1/AUTH_{project_id}
リクエストの例
curl -i -X GET -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
レスポンスの例
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
リクエストの例 (JSON)
curl -i -X GET -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}?format=json
レスポンスの例
HTTP/1.1 200 OK
Content-Length: 206
Accept-Ranges: bytes
X-Timestamp: 1535685069.28154
X-Account-Bytes-Used: 0
X-Account-Container-Count: 2
Content-Type: application/json; charset=utf-8
X-Account-Object-Count: 0
x-account-project-domain-id: default
X-Trans-Id: txddbf20f97d1043128d032-005b97260f
X-Openstack-Request-Id: txddbf20f97d1043128d032-005b97260f
Date: Tue, 11 Sep 2018 02:18:55 GMT
[
{
"count":0,
"last_modified":"2018-09-11T02:11:35.010250",
"bytes":0,
"name":"ncloud-container-0"
},
{
"count":0,
"last_modified":"2018-09-11T02:11:41.481410",
"bytes":0,
"name":"ncloud-container-1"
}
]
リクエストの例 (XML)
curl -i -X GET -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}?format=xml
レスポンスの例
HTTP/1.1 200 OK
Content-Length: 392
Accept-Ranges: bytes
X-Timestamp: 1535685069.28154
X-Account-Bytes-Used: 0
X-Account-Container-Count: 2
Content-Type: application/xml; charset=utf-8
X-Account-Object-Count: 0
x-account-project-domain-id: default
X-Trans-Id: tx1a6fca0d191645c186b35-005b9726d3
X-Openstack-Request-Id: tx1a6fca0d191645c186b35-005b9726d3
Date: Tue, 11 Sep 2018 02:22:11 GMT
<?xml version="1.0" encoding="UTF-8"?>
<account name="AUTH_5942771066a0482bb6aaf7f5bc792b00">
<container>
<name>ncloud-container-0</name>
<count>0</count>
<bytes>0</bytes>
<last_modified>2018-09-11T02:11:35.010250</last_modified>
</container>
<container>
<name>ncloud-container-1</name>
<count>0</count>
<bytes>0</bytes>
<last_modified>2018-09-11T02:11:41.481410</last_modified>
</container>
</account>
リクエストが成功したら、OK (200)、No Content (204)のステータスコードを応答します。 No Content (204)の場合は、Content-Typeがplainであり、リクエストに該当する内容がない場合に発生します。
リクエストのパラメータ
Name | In | Type | Description |
---|---|---|---|
project_id (Optional) | path | string | プロジェクトIDを入力します。 |
limit (Optional) | query | integer | 呼出し結果に応じて最大の数を制限します。 |
marker (Optional) | query | string | 特定のコンテナ(バケット)以降のリストを取得します。 |
end_marker (Optional) | query | string | 特定のコンテナ(バケット)以前のリストを取得します。 |
format (Optional) | query | string | 呼出し結果のフォーマットを指定します。(json, xml, plain) |
prefix (Optional) | query | string | 該当の文字で始まるコンテナ(バケット)リストを呼び出します。 |
delimiter (Optional) | query | string | 該当の文字を区切りとして使い、コンテナ(バケット)名前に含まれる場合、sub-dirの結果を表示します。 |
X-Auth-Token (Optional) | header | string | 発行したTokenの値を入力します。 |
X-Newest (Optional) | header | boolean | trueの場合、全てのコピーに対して問い、もっとも最近のコピーの情報で応答します。該当のヘッダーが省略された場合、最もレスポンスが速い情報で応答します。 |
Accept (Optional) | header | string | 呼出し結果のフォーマットを指定します。(application/json, application/xml, text/xml) |
レスポンスのパラメータ
Name | In | Type | Description |
---|---|---|---|
Content-Length | header | string | レスポンス結果の長さです。(Bytes) |
X-Account-Meta-{name} (Optional) | header | string | アカウントのメタデータです。ヘッダー名のname部分がメタデータのキーの役割をします。 |
X-Account-Meta-Temp-URL-Key (Optional) | header | string | temporary URLのためのSecret Keyの値です。 |
X-Account-Meta-Temp-URL-Key-2 (Optional) | header | string | temporary URLのための2番目のSecret Keyの値です。 |
X-Timestamp | header | integer | Accountが初めて生成された時刻です。(UNIX Time) |
X-Trans-Id | header | string | 該当リクエストのトランザクションIDです。 |
X-Openstack-Request-Id | header | string | 該当リクエストのトランザクションIDです。(X-Trans-Idと同じです。) |
Date | header | string | 該当リクエストのレスポンス時間です。(UTC) |
X-Account-Bytes-Used | header | integer | 該当アカウントが使用する全体のサイズです。(Bytes) |
X-Account-Container-Count | header | integer | 該当アカウントにある全体のコンテナ(バケット)の数です。 |
X-Account-Object-Count | header | integer | 該当アカウントの全体のオブジェクトの数です。 |
X-Account-Storage-Policy-name-Bytes-Used | header | integer | not supported |
X-Account-Storage-Policy-name-Container-Count | header | integer | not supported |
X-Account-Storage-Policy-name-Object-Count | header | integer | not supported |
X-Account-Meta-Quota-Bytes (Optional) | header | string | 該当アカウントの容量の制限値です。(Bytes) |
Content-Type | header | string | レスポンス結果のMIMEタイプです。(text/plain, application/json, application/xml, text/xml ) |
count | body | integer | 該当コンテナにあるオブジェクトの数です。 |
bytes | body | integer | 該当コンテナにある全体のオブジェクトの大きさです。(Bytes) |
name | body | string | 該当コンテナの名前です。 |
アカウントメタデータの設定
構文
POST /v1/AUTH_{project_id}
POST request header contains | Result |
---|---|
リクエストヘッダーにアカウントメタデータの値がなく、キーだけが存在し、アカウントにキーは既に存在する場合 | APIは、該当のメタデータアイテムを削除します。 |
リクエストヘッダーにアカウントメタデータの値がなく、キーだけが存在し、アカウントにキーが存在しない場合 | APIは、該当のメタデータのキーを無視します。 |
リクエストヘッダーにアカウントメタデータのキーと値が両方とも存在し、アカウントにキーが既に存在する場合 | APIは、該当のメタデータをアップデートします。 |
リクエストヘッダーにアカウントメタデータのキーと値が両方とも存在し、アカウントにキーが存在しない場合 | APIは、該当のメタデータを追加します。 |
リクエストヘッダーにアカウントメタデータが省略されており、アカウントには既にメタデータが存在する場合 | APIは既に存在するメタデータを変更しません。 |
メタデータヘッダーに空の値を入力すると、削除のリクエストを行うことができるが、ヘッダーに空の値の入力を許可しないツールがある場合があります。
このような場合、X-Account-Meta-{name}で空の値をリクエストする代わりに、X-Remove-Account-Meta-{name}でリクエストします。
メタデータのキーは、大文字と小文字を区別せず、ASCII7-bit文字で構成することが可能です。(ASCII0〜31文字、DEL、文字などを除く)underscore文字(_)は、hyphen文字( - )に変換されます。 詳細については該当のドキュメントを参照 : HTTP/1.1
メタデータの値は、UTF-8でエンコードされたあと、次のURLをエンコードする必要があります。これはHTTP/1.1の基本ルールを直接違反することになります。
リクエストの例 (メタデータの生成)
curl -i -X POST -H "X-Auth-Token: $token" -H "X-Account-Meta-Book: ncloud-test-book" -H "X-Account-Meta-Subject: ncloud-test-subject" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: txad3702ae436640d1a9897-005b975c51
X-Openstack-Request-Id: txad3702ae436640d1a9897-005b975c51
Date: Tue, 11 Sep 2018 06:10:25 GMT
リクエストの例 (メタデータの修正)
curl -i -X POST -H "X-Auth-Token: $token" -H "X-Account-Meta-Subject: ncloud-test-sconedSubject" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: txc5a65e1d20074023912c6-005b975c97
X-Openstack-Request-Id: txc5a65e1d20074023912c6-005b975c97
Date: Tue, 11 Sep 2018 06:11:35 GMT
リクエストの例 (メタデータの削除)
curl -i -X POST -H "X-Auth-Token: $token" -H "X-Remove-Account-Meta-Subject: x" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
Content-Type: text/html; charset=UTF-8
X-Trans-Id: txf2874df785bd470eaf3b8-005b975d40
X-Openstack-Request-Id: txf2874df785bd470eaf3b8-005b975d40
Date: Tue, 11 Sep 2018 06:14:24 GMT
リクエストが成功することになれば、No Content (204)のステータスコードを応答します。
リクエストのパラメータ
Name | In | Type | Description |
---|---|---|---|
project_id (Optional) | path | string | プロジェクトIDを入力します。 |
X-Auth-Token (Optional) | header | string | 発行済みのTokenの値を入力します。発行したTokenの値を入力します。 |
X-Account-Meta-Temp-URL-Key (Optional) | header | string | temporary URLのためのSecret Keyの値を入力します。 |
X-Account-Meta-Temp-URL-Key-2 (Optional) | header | string | temporary URLのための2番目のSecret Keyの値を入力します。 |
X-Account-Meta-{name} (Optional) | header | string | アカウントのメタデータを設定します。ヘッダー名のname部分がメタデータのキーの役割をします。 |
X-Remove-Account-name (Optional) | header | string | アカウントのメタデータを削除します。ヘッダー名のname部分がメタデータのキーの役割をします。 |
レスポンスのパラメータ
Name | In | Type | Description |
---|---|---|---|
Date | header | string | 該当リクエストのレスポンス時間です。(UTC) |
X-Timestamp | header | integer | アカウントが初めて生成された時刻です。(UNIX Time) |
Content-Length | header | string | レスポンス結果の長さです。該当リクエストはResponse Bodyの内容がないため、リクエストが成功した際0です。 |
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}
リクエストの例
curl -i -X HEAD -H "X-Auth-Token: $token" https://kr.archive.ncloudstorage.com/v1/AUTH_{project_id}
レスポンスの例
HTTP/1.1 204 No Content
Content-Length: 0
Accept-Ranges: bytes
X-Account-Meta-Book: ncloud-test-book
X-Timestamp: 1535685069.28154
X-Account-Bytes-Used: 420024
X-Account-Container-Count: 2
Content-Type: text/plain; charset=utf-8
X-Account-Object-Count: 2
x-account-project-domain-id: default
X-Trans-Id: tx9001d378488c4e5dbc64a-005b975d96
X-Openstack-Request-Id: tx9001d378488c4e5dbc64a-005b975d96
Date: Tue, 11 Sep 2018 06:15:50 GMT
リクエストのパラメータ
Name | In | Type | Description |
---|---|---|---|
project_id (Optional) | path | string | プロジェクトIDを入力します。 |
X-Auth-Token (Optional) | header | string | 発行したTokenの値を入力します。 |
X-Newest (Optional) | header | boolean | trueの場合、すべてのコピーに対して問い、最も最近コピーされた情報で応答します。該当のヘッダーが省略された場合、最もレスポンスが速い情報で応答します。 |
レスポンスのパラメータ
Name | In | Type | Description |
---|---|---|---|
Content-Length | header | string | レスポンス結果の長さです。該当リクエストは、Response Bodyの内容がないため、リクエストが成功した際0です。 |
X-Account-Meta-name (Optional) | header | string | 該当アカウントのメタデータ情報です。ヘッダー名のname部分がメタデータのキーの役割をします。 |
X-Account-Meta-Temp-URL-Key (Optional) | header | string | temporary URのためのSecret Keyの値です。 |
X-Account-Meta-Temp-URL-Key-2 (Optional) | header | string | temporary URLのための2番目のSecret Keyの値です。 |
X-Timestamp | header | integer | アカウントが初めて生成された時刻です。(UNIX Time) |
X-Trans-Id | header | string | 該当リクエストのトランザクションIDです。 |
X-Openstack-Request-Id | header | string | 該当リクエストのトランザクションIDです。(X-Trans-Idと同じです。) |
Date | header | string | 該当リクエストのレスポンス時間です。(UTC) |
X-Account-Bytes-Used | header | integer | 該当Accountが使用する全体容量のサイズです。(Bytes) |
X-Account-Object-Count | header | integer | 該当Accountの全体オブジェクトの数です。 |
X-Account-Container-Count | header | integer | 該当Accountの全体コンテナ(バケット)の数です。 |
X-Account-Meta-Quota-Bytes (Optional) | header | string | 該当アカウントの容量制限の値です。(Bytes) |
Content-Type (Optional) | header | string | レスポンス結果のMIMEタイプです。 |