開発者ガイド
Red Hat Ceph Storage の各種アプリケーションプログラミングインターフェイスの使用
概要
第1章 Object Gateway Administration Application Programming Interface (API)
Ceph Object Gateway は、RESTful API の radosgw-admin
コマンドラインインターフェイスの機能も公開します。Red Hat は、Ceph Object Gateway の設定時にコマンドラインインターフェイスを使用することを推奨します。ユーザー、データ、クォータ、および使用状況を管理する際に、Ceph Object Gateway の管理 API は、他の管理プラットフォームと統合できる RESTful インターフェイスを提供します。管理 API は以下の機能を提供します。
- 認証要求
ユーザー/サブユーザーアカウントの管理
ユーザーのケーパビリティー管理
キー管理
バケット管理
オブジェクト管理
- 使用方法の取得
- 使用方法情報のトリミング
1.1. リクエストの認証
Amazon の S3 サービスは、アクセスキーと要求ヘッダーのハッシュと秘密鍵を使用して要求を認証します。この要求には、SSL オーバーヘッドなしで認証された要求(特に大きなアップロード)を提供する利点があります。
S3 API のほとんどのユースケースには、Java や Python Boto 用の Amazon SDK の AmazonS3Client
などのオープンソースの S3 クライアントを使用します。これらのライブラリーは、Ceph Object Gateway 管理 API をサポートしません。これらのライブラリーをサブクラス化および拡張して、Ceph Admin API をサポートすることができます。一意のゲートウェイクライアントを作成できます。
本セクションの CephAdminAPI のサンプルクラスでは、要求パラメーターの取得、リクエストの認証、Ceph 管理 API を呼び出してレスポンスを受け取ることができる execute()
メソッドの作成方法を説明します。CephAdminAPI
クラスの例は、商用としてはサポートされず、そのように意図されてもいません。これは説明のみを目的としています。クライアントコード には、CRUD 操作を示すために Ceph Object Gateway への 5 つの呼び出しが含まれます。
- ユーザーの作成
- ユーザーの取得
- ユーザーの変更
- サブユーザーの作成
- ユーザーを削除します。
この例を使用するには、httpcomponents-client-4.5.3
Apache HTTP コンポーネントを取得します。http://www.eu.apache.org/dist/httpcomponents/httpclient/binary/ などをダウンロードできます。その後、tar ファイルを展開して lib
ディレクトリーに移動し、JAVA_HOME
ディレクトリーの /jre/lib/ext
ディレクトリーまたはカスタムクラスパスにコピーします。
CephAdminAPI クラスの例を検査する際に、execute()
メソッドは HTTP メソッド、リクエストパス、オプションのサブリソース、未指定の場合は null
、およびパラメーターのマップを取得することに注意してください。サブリソース (例: subuser
、key
など) で実行するには、サブリソースを execute()
メソッドの引数として指定する必要があります。
方法の例を以下に示します。
- URI をビルドします。
- HTTP ヘッダー文字列をビルドします。
-
HTTP リクエストをインスタンス化します (例:
PUT
、POST
、GET
、DELETE
)。 -
Date
ヘッダーを HTTP ヘッダー文字列および要求ヘッダーに追加します。 -
Authorization
ヘッダーを HTTP リクエストヘッダーに追加します。 - HTTP クライアントをインスタンス化し、インスタンス化された HTTP リクエストを渡します。
- 要求を行います。
- レスポンスを返します。
ヘッダー文字列のビルドは、Amazon の S3 認証手順を伴うプロセスの一部です。特に、サンプルメソッドは以下を行います。
-
PUT
、POST
、GET
、DELETE
などのリスエストタイプを追加します。 - 日付を追加します。
- requestPath を追加します。
リクエストタイプは、先頭または最後の空白のない大文字である必要があります。空白を削除しないと、認証は失敗します。日付は GMT で表現される必要があります。さもないと、認証に失敗します。
例示的な方法には、他のヘッダーはありません。Amazon S3 認証手順は、x-amz
ヘッダーの辞書式に並べ替えられます。したがって、x-amz
ヘッダーを追加する場合は、必ず辞書式で追加する必要があります。詳細は、本ガイドの S3 認証 を参照してください。Amazon S3 認証手順の詳細は、Amazon Simple Storage Service ドキュメントの Signing and Authenticating REST Requests セクションを参照してください。
ヘッダー文字列をビルドしたら、次の手順は HTTP リクエストをインスタンス化し、URI を渡すことです。典型的なメソッドは、PUT
を使用してユーザーおよびサブユーザーを作成し、GET
を使用してユーザーを取得し、POST
を使用してユーザーを変更し、DELETE
を使用してユーザーを削除します。
リクエストをインスタンス化したら、Date
ヘッダーに続けて Authorization
ヘッダーを追加します。Amazon の S3 認証は標準の Authorization
ヘッダーを使用し、以下の構造を持ちます。
Authorization: AWS <access_key>:<hash_of_header_and_secret>
CephAdminAPI のサンプルクラスには base64Sha1Hmac()
メソッドがあります。これはヘッダー文字列と admin ユーザーの秘密鍵を取得し、SHA1 HMAC を base-64 でエンコードされた文字列として返します。それぞれの execute()
呼び出しは、同じコード行を呼び出して Authorization
ヘッダーをビルドします。
httpRequest.addHeader("Authorization", "AWS " + this.getAccessKey() + ":" + base64Sha1Hmac(headerString.toString(), this.getSecretKey()));
以下の CephAdminAPI
のサンプルクラスでは、アクセスキー、シークレットキー、およびエンドポイントをコンストラクターに渡す必要があります。クラスは実行時に変更するためのアクセスメソッドを提供します。
import java.io.IOException; import java.net.URI; import java.net.URISyntaxException; import java.time.OffsetDateTime; import java.time.format.DateTimeFormatter; import java.time.ZoneId; import org.apache.http.HttpEntity; import org.apache.http.NameValuePair; import org.apache.http.Header; import org.apache.http.client.entity.UrlEncodedFormEntity; import org.apache.http.client.methods.CloseableHttpResponse; import org.apache.http.client.methods.HttpRequestBase; import org.apache.http.client.methods.HttpGet; import org.apache.http.client.methods.HttpPost; import org.apache.http.client.methods.HttpPut; import org.apache.http.client.methods.HttpDelete; import org.apache.http.impl.client.CloseableHttpClient; import org.apache.http.impl.client.HttpClients; import org.apache.http.message.BasicNameValuePair; import org.apache.http.util.EntityUtils; import org.apache.http.client.utils.URIBuilder; import java.util.Base64; import java.util.Base64.Encoder; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import javax.crypto.spec.SecretKeySpec; import javax.crypto.Mac; import java.util.Map; import java.util.Iterator; import java.util.Set; import java.util.Map.Entry; public class CephAdminAPI { /* * Each call must specify an access key, secret key, endpoint and format. */ String accessKey; String secretKey; String endpoint; String scheme = "http"; //http only. int port = 80; /* * A constructor that takes an access key, secret key, endpoint and format. */ public CephAdminAPI(String accessKey, String secretKey, String endpoint){ this.accessKey = accessKey; this.secretKey = secretKey; this.endpoint = endpoint; } /* * Accessor methods for access key, secret key, endpoint and format. */ public String getEndpoint(){ return this.endpoint; } public void setEndpoint(String endpoint){ this.endpoint = endpoint; } public String getAccessKey(){ return this.accessKey; } public void setAccessKey(String accessKey){ this.accessKey = accessKey; } public String getSecretKey(){ return this.secretKey; } public void setSecretKey(String secretKey){ this.secretKey = secretKey; } /* * Takes an HTTP Method, a resource and a map of arguments and * returns a CloseableHTTPResponse. */ public CloseableHttpResponse execute(String HTTPMethod, String resource, String subresource, Map arguments) { String httpMethod = HTTPMethod; String requestPath = resource; StringBuffer request = new StringBuffer(); StringBuffer headerString = new StringBuffer(); HttpRequestBase httpRequest; CloseableHttpClient httpclient; URI uri; CloseableHttpResponse httpResponse = null; try { uri = new URIBuilder() .setScheme(this.scheme) .setHost(this.getEndpoint()) .setPath(requestPath) .setPort(this.port) .build(); if (subresource != null){ uri = new URIBuilder(uri) .setCustomQuery(subresource) .build(); } for (Iterator iter = arguments.entrySet().iterator(); iter.hasNext();) { Entry entry = (Entry)iter.next(); uri = new URIBuilder(uri) .setParameter(entry.getKey().toString(), entry.getValue().toString()) .build(); } request.append(uri); headerString.append(HTTPMethod.toUpperCase().trim() + "\n\n\n"); OffsetDateTime dateTime = OffsetDateTime.now(ZoneId.of("GMT")); DateTimeFormatter formatter = DateTimeFormatter.RFC_1123_DATE_TIME; String date = dateTime.format(formatter); headerString.append(date + "\n"); headerString.append(requestPath); if (HTTPMethod.equalsIgnoreCase("PUT")){ httpRequest = new HttpPut(uri); } else if (HTTPMethod.equalsIgnoreCase("POST")){ httpRequest = new HttpPost(uri); } else if (HTTPMethod.equalsIgnoreCase("GET")){ httpRequest = new HttpGet(uri); } else if (HTTPMethod.equalsIgnoreCase("DELETE")){ httpRequest = new HttpDelete(uri); } else { System.err.println("The HTTP Method must be PUT, POST, GET or DELETE."); throw new IOException(); } httpRequest.addHeader("Date", date); httpRequest.addHeader("Authorization", "AWS " + this.getAccessKey() + ":" + base64Sha1Hmac(headerString.toString(), this.getSecretKey())); httpclient = HttpClients.createDefault(); httpResponse = httpclient.execute(httpRequest); } catch (URISyntaxException e){ System.err.println("The URI is not formatted properly."); e.printStackTrace(); } catch (IOException e){ System.err.println("There was an error making the request."); e.printStackTrace(); } return httpResponse; } /* * Takes a uri and a secret key and returns a base64-encoded * SHA-1 HMAC. */ public String base64Sha1Hmac(String uri, String secretKey) { try { byte[] keyBytes = secretKey.getBytes("UTF-8"); SecretKeySpec signingKey = new SecretKeySpec(keyBytes, "HmacSHA1"); Mac mac = Mac.getInstance("HmacSHA1"); mac.init(signingKey); byte[] rawHmac = mac.doFinal(uri.getBytes("UTF-8")); Encoder base64 = Base64.getEncoder(); return base64.encodeToString(rawHmac); } catch (Exception e) { throw new RuntimeException(e); } } }
後続の CephAdminAPIClient
の例は、CephAdminAPI
クラスをインスタンス化する方法、リクエストパラメーターのマップをビルドし、execute()
メソッドを使用してユーザーを作成、取得、更新、および削除する方法を示しています。
import java.io.IOException; import org.apache.http.client.methods.CloseableHttpResponse; import org.apache.http.HttpEntity; import org.apache.http.util.EntityUtils; import java.util.*; public class CephAdminAPIClient { public static void main (String[] args){ CephAdminAPI adminApi = new CephAdminAPI ("FFC6ZQ6EMIF64194158N", "Xac39eCAhlTGcCAUreuwe1ZuH5oVQFa51lbEMVoT", "ceph-client"); /* * Create a user */ Map requestArgs = new HashMap(); requestArgs.put("access", "usage=read, write; users=read, write"); requestArgs.put("display-name", "New User"); requestArgs.put("email", "new-user@email.com"); requestArgs.put("format", "json"); requestArgs.put("uid", "new-user"); CloseableHttpResponse response = adminApi.execute("PUT", "/admin/user", null, requestArgs); System.out.println(response.getStatusLine()); HttpEntity entity = response.getEntity(); try { System.out.println("\nResponse Content is: " + EntityUtils.toString(entity, "UTF-8") + "\n"); response.close(); } catch (IOException e){ System.err.println ("Encountered an I/O exception."); e.printStackTrace(); } /* * Get a user */ requestArgs = new HashMap(); requestArgs.put("format", "json"); requestArgs.put("uid", "new-user"); response = adminApi.execute("GET", "/admin/user", null, requestArgs); System.out.println(response.getStatusLine()); entity = response.getEntity(); try { System.out.println("\nResponse Content is: " + EntityUtils.toString(entity, "UTF-8") + "\n"); response.close(); } catch (IOException e){ System.err.println ("Encountered an I/O exception."); e.printStackTrace(); } /* * Modify a user */ requestArgs = new HashMap(); requestArgs.put("display-name", "John Doe"); requestArgs.put("email", "johndoe@email.com"); requestArgs.put("format", "json"); requestArgs.put("uid", "new-user"); requestArgs.put("max-buckets", "100"); response = adminApi.execute("POST", "/admin/user", null, requestArgs); System.out.println(response.getStatusLine()); entity = response.getEntity(); try { System.out.println("\nResponse Content is: " + EntityUtils.toString(entity, "UTF-8") + "\n"); response.close(); } catch (IOException e){ System.err.println ("Encountered an I/O exception."); e.printStackTrace(); } /* * Create a subuser */ requestArgs = new HashMap(); requestArgs.put("format", "json"); requestArgs.put("uid", "new-user"); requestArgs.put("subuser", "foobar"); response = adminApi.execute("PUT", "/admin/user", "subuser", requestArgs); System.out.println(response.getStatusLine()); entity = response.getEntity(); try { System.out.println("\nResponse Content is: " + EntityUtils.toString(entity, "UTF-8") + "\n"); response.close(); } catch (IOException e){ System.err.println ("Encountered an I/O exception."); e.printStackTrace(); } /* * Delete a user */ requestArgs = new HashMap(); requestArgs.put("format", "json"); requestArgs.put("uid", "new-user"); response = adminApi.execute("DELETE", "/admin/user", null, requestArgs); System.out.println(response.getStatusLine()); entity = response.getEntity(); try { System.out.println("\nResponse Content is: " + EntityUtils.toString(entity, "UTF-8") + "\n"); response.close(); } catch (IOException e){ System.err.println ("Encountered an I/O exception."); e.printStackTrace(); } } }
1.2. 管理ユーザーの作成
Ceph Object Gateway ノードから radosgw-admin
コマンドを実行するには、ノードに admin キー(任意のモニターノードからコピーできる)があることを確認します。
Ceph Object Gateway 管理 API を使用するには、以下の手順に従います。
Object Gateway ユーザーを作成します。
構文
radosgw-admin user create --uid="<user_name>" --display-name="<display_name>"
例
radosgw-admin user create --uid="admin-api-user" --display-name="Admin API User"
radosgw-admin
コマンドラインインターフェイスはユーザーを返します。以下に例を示します。{ "user_id": "admin-api-user", "display_name": "Admin API User", "email": "", "suspended": 0, "max_buckets": 1000, "auid": 0, "subusers": [], "keys": [ { "user": "admin-api-user", "access_key": "NRWGT19TWMYOB1YDBV1Y", "secret_key": "gr1VEGIV7rxcP3xvXDFCo4UDwwl2YoNrmtRlIAty" } ], "swift_keys": [], "caps": [], "op_mask": "read, write, delete", "default_placement": "", "placement_tags": [], "bucket_quota": { "enabled": false, "max_size_kb": -1, "max_objects": -1 }, "user_quota": { "enabled": false, "max_size_kb": -1, "max_objects": -1 }, "temp_url_keys": [] }
作成するユーザーに管理ケイパビリティーを割り当てます。
構文
radosgw-admin caps add --uid="<user_name>" --caps="users=*"
例
radosgw-admin caps add --uid=admin-api-user --caps="users=*"
radosgw-admin
コマンドラインインターフェイスはユーザーを返します。"caps":
には、ユーザーに割り当てられたケイパビリティーがあります。{ "user_id": "admin-api-user", "display_name": "Admin API User", "email": "", "suspended": 0, "max_buckets": 1000, "auid": 0, "subusers": [], "keys": [ { "user": "admin-api-user", "access_key": "NRWGT19TWMYOB1YDBV1Y", "secret_key": "gr1VEGIV7rxcP3xvXDFCo4UDwwl2YoNrmtRlIAty" } ], "swift_keys": [], "caps": [ { "type": "users", "perm": "*" } ], "op_mask": "read, write, delete", "default_placement": "", "placement_tags": [], "bucket_quota": { "enabled": false, "max_size_kb": -1, "max_objects": -1 }, "user_quota": { "enabled": false, "max_size_kb": -1, "max_objects": -1 }, "temp_url_keys": [] }
これで、管理者権限を持つユーザーが作成されます。
1.3. 管理操作
管理アプリケーションプログラミングインターフェイス (API) リクエストは、設定可能な管理者リソースエントリーポイントで開始する URI で実行されます。管理 API の認可は S3 認可メカニズムを複製します。一部の操作では、ユーザーが特別な管理機能を保持する必要があります。XML または JSON のいずれかのレスポンスエンティティータイプはリクエストの format オプションとして指定され、指定されていないとデフォルトは JSON に設定されます。
1.3.1. 使用方法の取得
帯域幅の使用情報の要求。
- caps
-
usage=read
構文
GET /admin/usage?format=json HTTP/1.1 Host: <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 必須 |
---|---|---|---|
| 情報が要求されるユーザー。 | 文字列。 | はい |
|
要求されたデータの開始時間を指定する日付および (任意の) 時間。(例: | 文字列 | いいえ |
|
要求されたデータの終了時間を指定する日付および (任意の) 時間。(例: | 文字列 | いいえ |
| データエントリーを返すかどうかを指定します。 | ブール値 | いいえ |
| データ要約を返すかどうかを指定します。 | ブール値 | No |
名前 | 説明 | 型 |
---|---|---|
| 使用方法に関する情報用のコンテナー。 | コンテナー |
| 使用方法エントリー情報のコンテナー。 | コンテナー |
| ユーザーデータ情報のコンテナー | コンテナー |
| バケットを所有するユーザーの名前。 | 文字列 |
| バケット名。 | 文字列 |
| データが指定されている時間の下限 (最初の関連する時間の開始に丸められます)。 | 文字列 |
|
| 文字列 |
| 統計情報カテゴリーのコンテナー。 | コンテナー |
| stats エントリーのコンテナー。 | コンテナー |
| 統計が提供される要求カテゴリーの名前。 | 文字列 |
| Ceph Object Gateway によって送信されるバイト数。 | 整数 |
| Ceph Object Gateway が受け取るバイト数。 | 整数 |
| 演算の数。 | 整数 |
| 成功した操作の数。 | 整数 |
| 統計情報の概要のコンテナー。 | コンテナー |
| 統計情報の概要集計合計のコンテナー。 | コンテナー |
成功すると、レスポンスには要求された情報が含まれます。
1.3.2. トリムの使用方法
使用方法に関する情報を削除します。日付を指定しないと、すべての使用情報が削除されます。
- caps
-
usage=write
構文
DELETE /admin/usage?format=json HTTP/1.1 Host: <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 情報が要求されるユーザー。 | 文字列 |
| いいえ |
| 要求されたデータの開始時間を指定する日付および (任意の) 時間。 | 文字列 |
| いいえ |
| 要求されたデータの終了時間を指定する日付および 時間 (非包括的)。 | 文字列 |
| いいえ |
|
マルチユーザーデータの削除を確認するために | ブール値 | True [False] | いいえ |
1.3.3. ユーザー情報の取得
ユーザーの情報の取得
- caps
- users=read
構文
GET /admin/user?format=json HTTP/1.1 Host: <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 情報が要求されるユーザー。 | 文字列 |
| はい |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| ユーザーデータ情報のコンテナー | コンテナー | 該当なし |
| ユーザー ID。 | 文字列 |
|
| ユーザーの表示名。 | 文字列 |
|
| ユーザーが一時停止した場合は True。 | ブール値 |
|
| ユーザーが所有するバケットの最大数。 | 整数 |
|
| このユーザーアカウントに関連付けられたサブユーザー。 | コンテナー |
|
| このユーザーアカウントに関連付けられた S3 キー。 | コンテナー |
|
| このユーザーアカウントに関連付けられた Swift 鍵。 | コンテナー |
|
| ユーザーケイパビリティー。 | コンテナー |
|
成功すると、応答にはユーザー情報が含まれます。
特別なエラーレスポンス
なし。
1.3.4. ユーザーの作成
新しいユーザーを作成します。デフォルトでは、S3 キーペアが自動的に作成され、レスポンスで返されます。access-key
または secret-key
のいずれかのみを指定すると、省略キーが自動的に生成されます。デフォルトでは、生成されたキーは、既存のキーペアを置き換えることなくキーリングに追加されます。access-key
が指定され、ユーザーが所有する既存のキーを参照すると、そのキーは変更されます。
- caps
-
users=write
構文
PUT /admin/user?format=json HTTP/1.1 Host: <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 作成されるユーザー ID。 | 文字列 |
| はい |
| 作成するユーザーの表示名。 | 文字列 |
| はい |
| ユーザーに関連付けられたメールアドレス。 | 文字列 |
| いいえ |
| 生成されるキータイプ。オプションは swift、s3 (デフォルト) です。 | 文字列 |
| いいえ |
| アクセスキーを指定します。 | 文字列 |
| いいえ |
| シークレットキーを指定します。 | 文字列 |
| いいえ |
| ユーザーケイパビリティー。 | 文字列 |
| いいえ |
| 新しいキーペアを生成し、既存のキーリングに追加します。 | ブール値 | True [True] | いいえ |
| ユーザーが所有できるバケットの最大数を指定します。 | 整数 | 500 [1000] | いいえ |
| ユーザーが一時停止されるかどうかを指定します。 | ブール値 | False [False] | No |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| ユーザーデータ情報のコンテナー | コンテナー | 該当なし |
| ユーザー ID。 | 文字列 |
|
| ユーザーの表示名。 | 文字列 |
|
| ユーザーが一時停止した場合は True。 | ブール値 |
|
| ユーザーが所有するバケットの最大数。 | 整数 |
|
| このユーザーアカウントに関連付けられたサブユーザー。 | コンテナー |
|
| このユーザーアカウントに関連付けられた S3 キー。 | コンテナー |
|
| このユーザーアカウントに関連付けられた Swift 鍵。 | コンテナー |
|
| ユーザーケイパビリティー。 | コンテナー |
|
成功すると、応答にはユーザー情報が含まれます。
名前 | 説明 | コード |
---|---|---|
| 既存のユーザーの作成を試行。 | 409 Conflict |
| 無効なアクセスキーが指定されている。 | 400 Bad Request |
| 無効なキータイプが指定されている。 | 400 Bad Request |
| 無効なシークレットキーが指定されている。 | 400 Bad Request |
| 無効なキータイプが指定されている。 | 400 Bad Request |
| 提供されたアクセスキーが存在し、別のユーザーに属している。 | 409 Conflict |
| 提供されるメールアドレスが存在する。 | 409 Conflict |
| 無効な管理者ケイパビリティーの付与を試行。 | 400 Bad Request |
サブユーザーの作成については、「サブユーザーの作成」 を参照してください。
1.3.5. ユーザーの変更
既存ユーザーの変更
- caps
-
users=write
構文
POST /admin/user?format=json HTTP/1.1 Host: <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 変更するユーザー ID。 | 文字列 |
| はい |
| 変更されるユーザーの表示名。 | 文字列 |
| いいえ |
| ユーザーに関連付けるメールアドレス。 | 文字列 |
| いいえ |
| 新しいキーペアを生成し、既存のキーリングに追加します。 | ブール値 | True [False] | いいえ |
| アクセスキーを指定します。 | 文字列 |
| いいえ |
| シークレットキーを指定します。 | 文字列 |
| いいえ |
| 生成されるキータイプ。オプションは swift、s3 (デフォルト) です。 | 文字列 |
| いいえ |
| ユーザーケイパビリティー。 | 文字列 |
| いいえ |
| ユーザーが所有できるバケットの最大数を指定します。 | 整数 | 500 [1000] | いいえ |
| ユーザーが一時停止されるかどうかを指定します。 | ブール値 | False [False] | No |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| ユーザーデータ情報のコンテナー | コンテナー | 該当なし |
| ユーザー ID。 | 文字列 |
|
| ユーザーの表示名。 | 文字列 |
|
| ユーザーが一時停止した場合は True。 | ブール値 |
|
| ユーザーが所有するバケットの最大数。 | 整数 |
|
| このユーザーアカウントに関連付けられたサブユーザー。 | コンテナー |
|
| このユーザーアカウントに関連付けられた S3 キー。 | コンテナー |
|
| このユーザーアカウントに関連付けられた Swift 鍵。 | コンテナー |
|
| ユーザーケイパビリティー。 | コンテナー |
|
成功すると、応答にはユーザー情報が含まれます。
名前 | 説明 | コード |
---|---|---|
| 無効なアクセスキーが指定されている。 | 400 Bad Request |
| 無効なキータイプが指定されている。 | 400 Bad Request |
| 無効なシークレットキーが指定されている。 | 400 Bad Request |
| 提供されたアクセスキーが存在し、別のユーザーに属している。 | 409 Conflict |
| 提供されるメールアドレスが存在する。 | 409 Conflict |
| 無効な管理者ケイパビリティーの付与を試行。 | 400 Bad Request |
サブユーザーの変更については、「サブユーザーの変更」 を参照してください。
1.3.6. ユーザーの削除
既存のユーザーを削除します。
- caps
-
users=write
構文
DELETE /admin/user?format=json HTTP/1.1 Host: <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 削除するユーザー ID。 | 文字列 |
| はい。 |
| 指定すると、ユーザーに属するバケットとオブジェクトも削除されます。 | ブール値 | True | No |
レスポンスエンティティー
なし。
特別なエラーレスポンス
なし。
サブユーザーの削除については、「サブユーザーの削除」 を参照してください。
1.3.7. サブユーザーの作成
Swift API を使用するクライアントに主に役立つ新しいサブユーザーを作成します。有効なリクエストには、gen-subuser
または subuser
のいずれかが必要であることに注意してください。また、通常、サブユーザーには access
を指定してパーミッションを付与する必要があることに注意してください。ユーザー作成 (subuser
が secret
なしで指定されている場合) と同様に、シークレットキーは自動的に生成されます。
- caps
-
users=write
構文
PUT /admin/user?subuser&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| サブユーザーを作成するユーザー ID。 | 文字列 |
| はい |
| 作成するサブユーザー ID を指定します。 | 文字列 |
|
必須 (または |
| 作成するサブユーザー ID を指定します。 | 文字列 |
|
はい (または |
| シークレットキーを指定します。 | 文字列 |
| いいえ |
| 生成されるキータイプ。オプションは swift (デフォルト)、s3 です。 | 文字列 |
| いいえ |
|
サブユーザーのアクセスパーミッションを設定する場合は、 | 文字列 |
| いいえ |
| 秘密鍵を生成します。 | ブール値 | True [False] | No |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| ユーザーアカウントに関連付けられたサブユーザー | コンテナー | 該当なし |
| サブユーザー ID。 | 文字列 |
|
| ユーザーアカウントへのサブユーザーアクセス | 文字列 |
|
成功すると、レスポンスにはサブユーザー情報が含まれます。
名前 | 説明 | コード |
---|---|---|
| 指定したサブユーザーが存在する。 | 409 Conflict |
| 無効なキータイプが指定されている。 | 400 Bad Request |
| 無効なシークレットキーが指定されている。 | 400 Bad Request |
| 無効なサブユーザーアクセスが指定されている。 | 400 Bad Request |
1.3.8. サブユーザーの変更
既存のサブユーザーを変更します。
- caps
-
users=write
構文
POST /admin/user?subuser&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| サブユーザーを変更するユーザー ID。 | 文字列 |
| はい |
| 変更するサブユーザー ID。 | 文字列 |
| はい |
| サブユーザーの新しい秘密鍵を生成し、既存のキーを置き換えます。 | ブール値 | True [False] | いいえ |
| シークレットキーを指定します。 | 文字列 |
| いいえ |
| 生成されるキータイプ。オプションは swift (デフォルト)、s3 です。 | 文字列 |
| いいえ |
|
サブユーザーのアクセスパーミッションを設定する場合は、 | 文字列 |
| いいえ |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| ユーザーアカウントに関連付けられたサブユーザー | コンテナー | 該当なし |
| サブユーザー ID。 | 文字列 |
|
| ユーザーアカウントへのサブユーザーアクセス | 文字列 |
|
成功すると、レスポンスにはサブユーザー情報が含まれます。
名前 | 説明 | コード |
---|---|---|
| 無効なキータイプが指定されている。 | 400 Bad Request |
| 無効なシークレットキーが指定されている。 | 400 Bad Request |
| 無効なサブユーザーアクセスが指定されている。 | 400 Bad Request |
1.3.9. サブユーザーの削除
既存のサブユーザーを削除します。
- caps
-
users=write
構文
DELETE /admin/user?subuser&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| サブユーザーを削除するユーザー ID。 | 文字列 |
| はい |
| 削除されるサブユーザー ID。 | 文字列 |
| はい |
| サブユーザーに属する鍵を削除します。 | ブール値 | True [True] | No |
レスポンスエンティティー
なし。
特別なエラーレスポンス
なし。
1.3.10. キーの作成
新規のキーを作成します。subuser
を指定すると、デフォルトで作成されたキーは swift タイプになります。access-key
または secret-key
のいずれかのみが指定された場合、コミットされたキーは自動的に生成されます。secret-key
のみが指定されている場合、access-key
は自動的に生成されます。デフォルトでは、生成されたキーは、既存のキーペアを置き換えることなくキーリングに追加されます。access-key
が指定され、ユーザーが所有する既存のキーを参照すると、そのキーは変更されます。レスポンスは、作成された鍵と同じタイプの鍵をすべて一覧表示するコンテナーです。swift キーの作成時には、access-key
オプションを指定しても効果はありません。また、ユーザーまたはサブユーザーごとに 1 つの swift キーのみを保持することができます。
- caps
-
users=write
構文
PUT /admin/user?key&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 新しいキーを受け取るユーザー ID。 | 文字列 |
| はい |
| 新しいキーを受け取るサブユーザー ID。 | 文字列 |
| いいえ |
| 生成されるキータイプ。オプションは swift、s3 (デフォルト) です。 | 文字列 |
| いいえ |
| アクセスキーを指定します。 | 文字列 |
| いいえ |
| 秘密鍵を指定します。 | 文字列 |
| いいえ |
| 新しいキーペアを生成し、既存のキーリングに追加します。 | ブール値 |
True [ | いいえ |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| このユーザーアカウントに関連付けられたタイプのキー。 | コンテナー | 該当なし |
| キーに関連付けられたユーザーアカウント。 | 文字列 |
|
| アクセスキー。 | 文字列 |
|
| シークレットキー | 文字列 |
|
名前 | 説明 | コード |
---|---|---|
| 無効なアクセスキーが指定されている。 | 400 Bad Request |
| 無効なキータイプが指定されている。 | 400 Bad Request |
| 無効なシークレットキーが指定されている。 | 400 Bad Request |
| 無効なキータイプが指定されている。 | 400 Bad Request |
| 提供されたアクセスキーが存在し、別のユーザーに属している。 | 409 Conflict |
1.3.11. キーの削除
既存のキーを削除します。
- caps
-
users=write
構文
DELETE /admin/user?key&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 削除する S3 キーペアに属する S3 アクセスキー。 | 文字列 |
| はい |
| キーの削除元のユーザー。 | 文字列 |
| いいえ |
| キーの削除元のサブユーザー。 | 文字列 |
| いいえ |
| 削除するキータイプ。オプションは swift、s3 です。注記: swift キーを削除するために必要です。 | 文字列 |
| いいえ |
特別なエラーレスポンス
なし。
レスポンスエンティティー
なし。
1.3.12. バケット情報の取得
既存バケットのサブセットに関する情報を取得します。uid
が bucket
なしで指定されると、そのユーザーに属するすべてのバケットが返されます。bucket
のみが指定されている場合は、その特定のバケットの情報を取得します。
- caps
-
buckets=read
構文
GET /admin/bucket?format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 情報を返すバケット。 | 文字列 |
| いいえ |
| バケット情報を取得するユーザー。 | 文字列 |
| いいえ |
| バケットの統計を返します。 | ブール値 | True [False] | No |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| バケットごとの情報 | コンテナー | 該当なし |
| 1 つ以上のバケットコンテナーの一覧が含まれます。 | コンテナー |
|
単一バケット情報用のコンテナー。 | コンテナー |
|
|
バケットの名前。 | 文字列 |
|
|
バケットが保存されているプール。 | 文字列 |
|
|
一意のバケット ID。 | 文字列 |
|
|
内部バケットタグ。 | 文字列 |
|
|
バケット所有者のユーザー ID。 | 文字列 |
|
|
ストレージの使用情報。 | コンテナー |
|
|
要求に成功すると、必要なバケット情報が含まれるバケットコンテナーが返されます。
名前 | 説明 | コード |
---|---|---|
| バケットのインデックスが失敗しました。 | 409 Conflict |
1.3.13. バケットインデックスの確認
既存のバケットのインデックスを確認します。
check-objects
で複数パートオブジェクトアカウンティングを確認するには、fix
を True に設定する必要があります。
- caps
-
buckets=write
構文
GET /admin/bucket?index&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 情報を返すバケット。 | 文字列 |
| はい |
| 複数パートオブジェクトアカウンティングを確認します。 | ブール値 | True [False] | いいえ |
| また、チェック時にバケットインデックスも修正します。 | ブール値 | False [False] | No |
名前 | 説明 | 型 |
---|---|---|
| バケットインデックスのステータス。 | 文字列 |
名前 | 説明 | コード |
---|---|---|
| バケットのインデックスが失敗しました。 | 409 Conflict |
1.3.14. バケットの削除
既存のバケットを削除します。
- caps
-
buckets=write
構文
DELETE /admin/bucket?format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 削除するバケット。 | 文字列 |
| はい |
| 削除前にバケットオブジェクトを削除します。 | ブール値 | True [False] | No |
レスポンスエンティティー
なし。
名前 | 説明 | コード |
---|---|---|
| 空でないバケットの削除を試行しました。 | 409 Conflict |
| オブジェクトを削除できません。 | 409 Conflict |
1.3.15. バケットのリンク
バケットを指定ユーザーにリンクし、直前のユーザーからバケットのリンクを解除します。
- caps
-
buckets=write
構文
PUT /admin/bucket?format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| リンクを解除するバケット。 | 文字列 |
| はい |
| バケットをリンクするユーザー ID。 | 文字列 |
| はい |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| 単一バケット情報用のコンテナー。 | コンテナー | 該当なし |
| バケットの名前。 | 文字列 |
|
| バケットが保存されているプール。 | 文字列 |
|
| 一意のバケット ID。 | 文字列 |
|
| 内部バケットタグ。 | 文字列 |
|
| バケット所有者のユーザー ID。 | 文字列 |
|
| ストレージの使用情報。 | コンテナー |
|
| バケットインデックスのステータス。 | 文字列 |
|
名前 | 説明 | コード |
---|---|---|
| 指定のユーザーからバケットのリンクを解除できません。 | 409 Conflict |
| バケットを指定されたユーザーにリンクできません。 | 409 Conflict |
1.3.16. バケットのリンク解除
指定されたユーザーからバケットのリンクを解除します。主にバケットの所有権を変更するのに役立ちます。
- caps
-
buckets=write
構文
POST /admin/bucket?format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| リンクを解除するバケット。 | 文字列 |
| はい |
| バケットのリンクを解除するユーザー ID。 | 文字列 |
| はい |
レスポンスエンティティー
なし。
名前 | 説明 | コード |
---|---|---|
| 指定のユーザーからバケットのリンクを解除できません。 | 409 Conflict |
1.3.17. オブジェクトの削除
既存のオブジェクトを削除します。
所有者を一時停止せずに指定する必要はありません。
- caps
-
buckets=write
構文
DELETE /admin/bucket?object&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 削除されるオブジェクトを含むバケット。 | 文字列 |
| はい |
| 削除するオブジェクト。 | 文字列 |
| はい |
レスポンスエンティティー
なし。
名前 | 説明 | コード |
---|---|---|
| 指定されたオブジェクトは存在しません。 | 404 Not Found |
| オブジェクトを削除できません。 | 409 Conflict |
1.3.18. バケットまたはオブジェクトポリシーの取得
オブジェクトまたはバケットのポリシーを読み取ります。
- caps
-
buckets=read
構文
GET /admin/bucket?policy&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| ポリシーを読み取るバケット。 | 文字列 |
| はい |
| ポリシーの読み取り元となるオブジェクト。 | 文字列 |
| いいえ |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| アクセス制御ポリシー。 | コンテナー | 該当なし |
成功した場合には、オブジェクトまたはバケットポリシーを返します。
名前 | 説明 | コード |
---|---|---|
| バケットポリシー要求にバケットが指定されていないか、またはオブジェクトがオブジェクトポリシー要求に指定されていません。 | 400 Bad Request |
1.3.19. 既存ユーザーへの機能の追加
指定したユーザーに管理ケイパビリティーを追加します。
- caps
-
users=write
構文
PUT /admin/user?caps&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 管理機能を追加するユーザー ID。 | 文字列 |
| はい |
| ユーザーに追加する管理キャパシティー。 | 文字列 |
| はい |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| ユーザーデータ情報のコンテナー | コンテナー | 該当なし |
| ユーザー ID。 | 文字列 |
|
| ユーザーケイパビリティー。 | コンテナー |
|
成功すると、レスポンスにはユーザーのケイパビリティーが含まれます。
名前 | 説明 | コード |
---|---|---|
| 無効な管理者ケイパビリティーの付与を試行。 | 400 Bad Request |
1.3.19.1. 要求の例
PUT /admin/user?caps&format=json HTTP/1.1 Host: <Fully_Qualified_Domain_Name> Content-Type: text/plain Authorization: <Authorization_Token> usage=read
1.3.20. 既存ユーザーからの機能の削除
指定したユーザーから管理ケイパビリティーを削除します。
- caps
-
users=write
構文
DELETE /admin/user?caps&format=json HTTP/1.1 Host <Fully_Qualified_Domain_Name>
名前 | 説明 | 型 | 例 | 必須 |
---|---|---|---|---|
| 管理ケイパビリティーを削除するユーザー ID。 | 文字列 |
| はい |
| ユーザーから削除する管理ケイパビリティー。 | 文字列 |
| はい |
名前 | 説明 | タイプ | 親 |
---|---|---|---|
| ユーザーデータ情報のコンテナー | コンテナー | 該当なし |
| ユーザー ID。 | 文字列 |
|
| ユーザーケイパビリティー。 | コンテナー |
|
成功すると、レスポンスにはユーザーのケイパビリティーが含まれます。
名前 | 説明 | コード |
---|---|---|
| 無効な管理ケイパビリティーの削除を試行します。 | 400 Bad Request |
| ユーザーは、指定されていないケイパビリティーです。 | 404 Not Found |
1.3.21. Quotas
管理操作 API を使用すると、ユーザーおよびユーザーが所有するバケットにクォータを設定できます。詳細は、クォータ管理 を参照してください。クォータには、バケットのオブジェクトの最大数と、メガバイト単位のストレージの最大サイズが含まれます。
クォータを表示するには、ユーザーに users=read
ケイパビリティーが必要です。クォータを設定、変更、または無効にするには、ユーザーに users=write
ケイパビリティーが必要です。詳細は、管理(CLI)を参照してください。
クォータの有効なパラメーターには以下が含まれます。
-
Bucket:
bucket
オプションでは、ユーザーが所有するバケットのクォータを指定できます。 -
Maximum Objects:
max-objects
設定では、オブジェクトの最大数を指定できます。負の値を設定すると、この設定が無効になります。 -
Maximum Size:
max-size
オプションでは、バイトの最大数のクォータを指定できます。負の値を設定すると、この設定が無効になります。 -
Quota Scope:
quota-scope
オプションは、クォータのスコープを設定します。オプションはbucket
とuser
です。
1.3.21.1. ユーザークォータの取得
クォータを取得するには、read
パーミッションを持つ users
ケイパビリティーが設定されている必要があります。
構文
GET /admin/user?quota&uid=<uid>"a-type=user
1.3.21.2. ユーザークォータの設定
クォータを設定するには、ユーザーに write
パーミッションを持つ users
ケイパビリティーを設定する必要があります。
構文
PUT /admin/user?quota&uid=<uid>"a-type=user
コンテンツには、対応する読み取り操作でエンコードされているクォータ設定の JSON 表現が含まれている必要があります。
1.3.21.3. バケットクォータの取得
クォータを取得するには、read
パーミッションを持つ users
ケイパビリティーが設定されている必要があります。
構文
GET /admin/user?quota&uid=<uid>"a-type=bucket
1.3.21.4. バケットクォータの設定
クォータを設定するには、ユーザーに write
パーミッションを持つ users
ケイパビリティーを設定する必要があります。
構文
PUT /admin/user?quota&uid=<uid>"a-type=bucket
コンテンツには、対応する読み取り操作でエンコードされているクォータ設定の JSON 表現が含まれている必要があります。
1.3.22. 標準エラーレスポンス
名前 | 説明 | コード |
---|---|---|
| アクセスが拒否されました。 | 403 forbidden |
| 内部サーバーエラー。 | 500 Internal Server Error |
| ユーザーが存在しない。 | 404 Not Found |
| バケットが存在しません。 | 404 Not Found |
| そのようなアクセスキーはありません。 | 404 Not Found |
第2章 Object Gateway S3 アプリケーションプログラミングインターフェイス(API)
Red Hat Ceph Object Gateway は、Amazon S3 API の基本的なデータアクセスモデルと互換性のある RESTful API をサポートします。
以下の表は、現在の Amazon S3 機能機能のサポートステータスについて説明しています。
機能 | 状態 | 備考 |
---|---|---|
サポート対象 | ||
サポート対象 | 固定 ACL のさまざまなセット | |
一部サポート対象 |
| |
サポート対象 | ||
一部サポート対象 |
| |
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | 固定 ACL のさまざまなセット | |
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
一部サポート対象 |
| |
一部サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 |
以下の表は、サポートされていない一般的なリクエストヘッダーフィールドの一覧です。
名前 | 型 |
---|---|
x-amz-security-token | リクエスト |
Server | レスポンス |
x-amz-delete-marker | レスポンス |
x-amz-id-2 | レスポンス |
x-amz-request-id | レスポンス |
x-amz-version-id | 応答 |
2.1. S3 API サーバー側の暗号化
Ceph Object Gateway は、S3 API のアップロードされたオブジェクトのサーバー側の暗号化をサポートしています。サーバー側の暗号化とは、S3 クライアントが暗号化されていない形式で HTTP 経由でデータを送信し、Ceph Object Gateway はそのデータを暗号化した形式で Ceph Storage Cluster に保存することを意味します。
Red Hat は、SLO(Static Large Object) または DLO(Dynamic Large Object) の S3 オブジェクト暗号化をサポートしません。
暗号化を使用するには、クライアントリクエストは、SSL 接続上でリクエストを送信する 必要があります。Red Hat は、Ceph Object Gateway が SSL を使用しない限り、クライアントからの S3 暗号化をサポートしません。ただし、テスト目的で、管理者は、ランタイム時に rgw_crypt_require_ssl
設定を false
に設定し、Ceph 設定ファイルで false
に設定して、Ansible 設定ファイルで false
に設定し、Ceph Object Gateway の Ansible Playbook を再生して、テスト中に SSL を無効にすることができます。
暗号化キーの管理には、以下の 2 つのオプションがあります。
お客様提供のキー
お客様が提供する鍵を使用する場合、S3 クライアントは暗号鍵を各リクエストと共に渡して、暗号化されたデータの読み取りまたは書き込みを行います。これらのキーを管理するのは、お客様の責任です。各オブジェクトの暗号化に使用する Ceph Object Gateway の鍵を覚えておく必要があります。
Ceph Object Gateway は、Amazon SSE-C 仕様に従って、S3 API で顧客提供のキー動作を実装します。
お客様がキー管理を処理し、S3 クライアントはキーを Ceph Object Gateway に渡すため、Ceph Object Gateway ではこの暗号化モードをサポートするための特別な設定は必要ありません。
キー管理サービス
キー管理サービスを使用する場合、セキュアなキー管理サービスはキーを格納し、Ceph Object Gateway はデータの暗号化または復号の要求に対応するためにキーをオンデマンドで取得します。
Ceph Object Gateway は、Amazon SSE-KMS 仕様に従って S3 API にキー管理サービスの動作を実装します。
現在、テスト済みの唯一のキー管理実装は OpenStack Barbican を使用します。ただし、OpenStack Barbican はテクノロジープレビューであるため、実稼働システムでの使用はサポートされません。
2.2. バケットポリシー
Ceph Object Gateway は、バケットに適用される Amazon S3 ポリシー言語のサブセットをサポートします。
作成および削除
Ceph Object Gateway は、CLI ツール radosgw-admin
を使用するのではなく、標準の S3 操作を使用して S3 バケットポリシーを管理します。
管理者は、s3cmd
コマンドを使用してポリシーを設定または削除できます。以下に例を示します。
$ cat > examplepol { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow", "Principal": {"AWS": ["arn:aws:iam::usfolks:user/fred"]}, "Action": "s3:PutObjectAcl", "Resource": [ "arn:aws:s3:::happybucket/*" ] }] } $ s3cmd setpolicy examplepol s3://happybucket $ s3cmd delpolicy s3://happybucket
制限事項
Ceph Object Gateway がサポートするのは以下の S3 アクションだけです。
-
s3:AbortMultipartUpload
-
s3:CreateBucket
-
s3:DeleteBucketPolicy
-
s3:DeleteBucket
-
s3:DeleteBucketWebsite
-
s3:DeleteObject
-
s3:DeleteObjectVersion
-
s3:GetBucketAcl
-
s3:GetBucketCORS
-
s3:GetBucketLocation
-
s3:GetBucketPolicy
-
s3:GetBucketRequestPayment
-
s3:GetBucketVersioning
-
s3:GetBucketWebsite
-
s3:GetLifecycleConfiguration
-
s3:GetObjectAcl
-
s3:GetObject
-
s3:GetObjectTorrent
-
s3:GetObjectVersionAcl
-
s3:GetObjectVersion
-
s3:GetObjectVersionTorrent
-
s3:ListAllMyBuckets
-
s3:ListBucketMultiPartUploads
-
s3:ListBucket
-
s3:ListBucketVersions
-
s3:ListMultipartUploadParts
-
s3:PutBucketAcl
-
s3:PutBucketCORS
-
s3:PutBucketPolicy
-
s3:PutBucketRequestPayment
-
s3:PutBucketVersioning
-
s3:PutBucketWebsite
-
s3:PutLifecycleConfiguration
-
s3:PutObjectAcl
-
s3:PutObject
-
s3:PutObjectVersionAcl
Ceph Object Gateway は、ユーザー、グループ、またはロールへのポリシー設定をサポートしません。
Ceph Object Gateway は、Amazon の 12 桁のアカウント ID の代わりに RGW の tenant 識別子を使用します。Amazon Web Service (AWS) S3 と Ceph Object Gateway S3 との間でポリシーを使用する場合、Ceph Object Gateway は、ユーザーの作成時に Amazon アカウント ID をテナント ID として使用する必要があります。
AWS S3 では、すべてのテナントが単一の名前空間を共有します。対照的に、Ceph Object Gateway はすべてのテナントにバケットの独自の名前空間を提供します。現在、別のテナントに属するバケットにアクセスしようとしている Ceph Object Gateway クライアントは、S3 リクエストの tenant:bucket
としてそれを処理する必要があります。
AWS では、バケットポリシーは別のアカウントへのアクセスを許可し、そのアカウントの所有者はユーザーパーミッションを持つ個々のユーザーにアクセス権限を付与できます。Ceph Object Gateway はユーザー、ロール、およびグループのパーミッションをサポートしていません。そのため、アカウントの所有者は個々のユーザーに直接アクセスを付与する必要があります。
アカウント全体のアクセスをバケットに付与すると、そのアカウントのすべてのユーザーにアクセス権限が付与されます。
バケットポリシーは文字列の補正を サポートしません。
Ceph Object Gateway では、以下の条件キーがサポートされます。
-
aws:CurrentTime
-
aws:EpochTime
-
aws:PrincipalType
-
aws:Referer
-
aws:SecureTransport
-
aws:SourceIp
-
aws:UserAgent
-
aws:username
Ceph Object Gateway のみ は、ListBucket
アクションの以下の条件キーをサポートします。
-
s3:prefix
-
s3:delimiter
-
s3:max-keys
Swift への影響
Ceph Object Gateway は、Swift API にバケットポリシーを設定する機能はありません。ただし、S3 API で設定されているバケットポリシーは Swift と S3 のいずれの操作も管理します。
Ceph Object Gateway は、ポリシーで指定されたプリンシパルに対して Swift の認証情報と一致します。
2.3. 認証およびアクセス制御リスト
Ceph Object Gateway への要求は、認証または認証解除のいずれかになります。Ceph Object Gateway は、認証されていないリクエストが匿名ユーザーによって送信されることを前提としています。Ceph Object Gateway は、固定 ACL をサポートしています。
2.3.1. 認証
ほとんどのユースケースでは、クライアントは Java 用の Amazon SDK の AmazonS3Client
などの既存のオープンソースライブラリーを使用し、Python Boto ではアクセスキーとシークレットキーを渡すだけで、ライブラリーは要求ヘッダーと認証署名をビルドします。ただし、リクエストを作成して署名することもできます。
リクエストの認証には、Ceph Object Gateway サーバーに送信される前に、アクセスキーとベース 64 でエンコードされた Hash-based Message Authentication Code (HMAC)をリクエストに含める必要があります。Ceph Object Gateway は S3 互換の認証を使用します。
例
HTTP/1.1 PUT /buckets/bucket/object.mpeg Host: cname.domain.com Date: Mon, 2 Jan 2012 00:01:01 +0000 Content-Encoding: mpeg Content-Length: 9999999 Authorization: AWS <access_key>:<hash_of_header_and_secret>
前述の例では、< access_key> を
アクセスキー ID の値に置き換え、その後にコロン()を追加 します
。< ;hash_of_header_and_secret
> を、正規化されたヘッダー文字列のハッシュおよびアクセスキー ID に対応するシークレットに置き換えます。
ヘッダー文字列およびシークレットのハッシュを生成するには、以下を行う必要があります。
- ヘッダー文字列の値を取得します。
- 要求ヘッダー文字列を正規形式に正規化します。
- SHA-1 ハッシュアルゴリズムを使用して HMAC を生成します。
-
hmac
の結果を base-64 としてエンコードします。
ヘッダーを正規の形式に正規化するには、以下を行います。
-
すべての
content-
ヘッダーを取得します。 -
content-type
およびcontent-md5
以外のcontent-
ヘッダーをすべて削除します。 -
content-
ヘッダー名が小文字であることを確認します。 -
content-
ヘッダーの辞書式で並べ替えます。 -
Date
ヘッダー AND があることを確認します。指定した日付が、オフセットではなく GMT を使用していることを確認してください。 -
x-amz-
で始まるヘッダーをすべて取得します。 -
x-amz-
ヘッダーがすべて小文字であることを確認します。 -
x-amz-
ヘッダーの辞書式で並べ替えます。 - 同じフィールド名の複数のインスタンスを単一のフィールドに組み合わせ、フィールド値をコンマで区切ります。
- ヘッダー値の空白文字および改行文字を、単一スペースに置き換えます。
- コロンの前後に空白を削除します。
- 各ヘッダーの後に新しい行を追加します。
- ヘッダーを要求ヘッダーにマージします。
< hash_of_header_and_secret
> を base-64 でエンコードされた HMAC 文字列に置き換えます。
詳細は、Amazon Simple Storage Service ドキュメントの Signing and Authenticating REST Requests セクションを参照してください。
2.3.2. アクセス制御リスト(ACL)
Ceph Object Gateway は S3 互換の ACL 機能をサポートします。ACL は、ユーザーがバケットまたはオブジェクトで実行できる操作を指定するアクセス権限の一覧です。それぞれの付与は、バケットに適用するか、またはオブジェクトに適用される場合の異なる意味を持ちます。
パーミッション | バケット | Object |
---|---|---|
| パーミッションを得たユーザーは、バケットのオブジェクトを一覧表示できます。 | パーミッションを得たユーザーは、オブジェクトを読み取りできます。 |
| パーミッションを得たユーザーは、バケットのオブジェクトを書き込みまたは削除できます。 | 該当なし |
| パーミッションを得たユーザーは、バケット ACL を読み取ることができます。 | パーミッションを得たユーザーは、オブジェクト ACL を読み取ることができます。 |
| パーミッションを得たユーザーは、バケット ACL を書き込めます。 | パーミッションを得たユーザーは、オブジェクト ACL に書き込めます。 |
| Grantee にはバケットのオブジェクトに対する完全なパーミッションがあります。 | パーミッションを得たユーザーは、オブジェクト ACL に読み取りまたは書き込みできます。 |
2.3.3. STS Lite API を使用した認証(テクノロジープレビュー)
Ceph Object Gateway は、Amazon Secure Token Service (STS) REST API のサブセットのサポートを提供します。STS Lite は、アイデンティティーおよびアクセス管理の一時的な認証情報のセットへのアクセスを提供します。
STS Lite 認証メカニズムは、Ceph Object Gateway の Keystone と統合されます。Amazon Web Services (AWS)の認証情報のセットを Keystone で認証した後に、一時的なセキュリティー認証情報のセットが返されます。STS エンジンは、後続の S3 呼び出しによって行われるこれらの一時的なセキュリティー認証情報を認証し、Keystone サーバーへの負荷が少なくなります。
Ceph Object Gateway は、以下の STS Lite REST API を実装します。
- GetSessionToken
AWS 認証情報のセットの一時的なセキュリティー認証情報のセットを返します。Keystone での初期認証にはこの API を使用し、返された一時的な認証情報を使用して後続の S3 呼び出しを実行できます。一時的な認証情報には、AWS 認証情報と同じパーミッションがあります。
パラメーター:
- DurationSeconds (整数/オプション)
-
認証情報が有効でなければならない期間(秒単位)。デフォルト値は 3600 秒です。最大値は 43200 秒です。この値は、Ceph 設定ファイルの
rgw_sts_max_session
オプションを使用して設定できます(デフォルトでは/etc/ceph/ceph.conf
ファイル)。 - serialNumber (文字列/オプション)
- GetSessionToken 呼び出しを行うユーザーに関連付けられた Multi-Factor Authentication (MFA)デバイスの ID 番号。
- TokenCode (文字列/オプション)
- MFA デバイスが提供する値(MFA が必要な場合)。
- AssumeRole
アカウント間のアクセスに使用できる一時的な認証情報のセットを返します。一時的な認証情報には、Role に割り当てられたパーミッションと AssumeRole API で割り当てられたポリシーとポリシーの両方が許可されるパーミッションがあります。
パラメーター:
- RoleArn (文字列/必須)
- アサートするロールの Amazon Resource Name (ARN)。
- RoleSessionName (文字列/必須)
想定されるロールセッションの識別子。
- Policy (文字列/オプション):
- JSON 形式の IAM ポリシー。
- DurationSeconds (整数/オプション)
- セッションの期間(秒単位)。デフォルト値は 3600 です。
- externalID (文字列/オプション)
- ロールが別のアカウントで仮定される際に使用される一意の ID。
- serialNumber (文字列/オプション)
- AssumeRole 呼び出しを行うユーザーに関連付けられた MFA デバイスの識別子番号。
- TokenCode (文字列/オプション)
- MFA デバイスによって提供される値(想定されているロールの信頼ポリシーに MFA が必要な場合)。
関連情報
- 詳細は、AWS Security Token Service API Reference ドキュメントを参照してください。
- 詳細は、AWS Identity and Access Management User Guide を参照してください。
2.4. ゲートウェイへのアクセス
さまざまなプログラミング言語を使用してゲートウェイサーバーとの接続を作成し、バケット管理タスクを実行できます。ゲートウェイでの認証に使用されるこれらのプログラミング言語には、さまざまなオープンソースライブラリーを利用できます。
以下のセクションでは、一般的なプログラミング言語の手順を説明します。
2.4.1. 前提条件
ゲートウェイサーバーにアクセスする前に、Ceph Object Gateway ノードの前提条件に従う必要があります。前提条件は以下のとおりです。
オペレーティングシステムに基づく指示に従って、ゲートウェイサーバーを適切に設定します。
- Red Hat Enterprise Linux の場合は、Red hat Enterprise Linux Installation Guide の Ceph Object Gateway Installation の 章を参照してください。
- Ubuntu の場合は、Installation Guide for Ubuntu の Ceph Object Gateway Installation の章を参照してください。
-
Ceph 設定ファイルを変更してポート
80
を使用するようにし、Civetweb
がデフォルトの Ansible に設定されたポートである8080
を使用することは変更 しないでください。 root
で、ファイアウォールのポート8080
を開きます。# firewall-cmd --zone=public --add-port=8080/tcp --permanent # firewall-cmd --reload
オブジェクトゲートウェイガイド で説明されているように、ゲートウェイに使用する DNS サーバーにワイルドカードを追加します。
ローカル DNS キャッシュ用のゲートウェイノードを設定することもできます。これを実行するには、以下の手順を実行します。
root
でdnsmasq
をインストールおよび設定します。# yum install dnsmasq # echo "address=/.<FQDN_of_gateway_node>/<IP_of_gateway_node>" | tee --append /etc/dnsmasq.conf # systemctl start dnsmasq # systemctl enable dnsmasq
<
;IP_of_gateway_node
> および <FQDN_of_gateway_node
> をゲートウェイノードの IP アドレスと FQDN に置き換えます。root
で NetworkManager を停止します。# systemctl stop NetworkManager # systemctl disable NetworkManager
root
として、ゲートウェイサーバーの IP を名前空間として設定します。# echo "DNS1=<IP_of_gateway_node>" | tee --append /etc/sysconfig/network-scripts/ifcfg-eth0 # echo "<IP_of_gateway_node> <FQDN_of_gateway_node>" | tee --append /etc/hosts # systemctl restart network # systemctl enable network # systemctl restart dnsmasq
<
;IP_of_gateway_node
> および <FQDN_of_gateway_node
> をゲートウェイノードの IP アドレスと FQDN に置き換えます。サブドメイン要求を確認します。
$ ping mybucket.<FQDN_of_gateway_node>
<
;FQDN_of_gateway_node>
をゲートウェイノードの FQDN に置き換えます。警告ローカルの DNS キャッシュ用にゲートウェイサーバーを設定することは、テスト目的のみを目的としています。これを行った後は、外部ネットワークにはアクセスできなくなります。Ceph クラスターおよびゲートウェイノードに適切な DNS サーバーを使用することを強く推奨します。
-
Ubuntu の Object Gateway Guide for Red Hat Enterprise Linux または Object Gateway Guide に記載のとおり、
S3
アクセスのradosgw
ユーザーを慎重に作成し、生成されたaccess_key
およびsecret_key
をコピーします。S3
アクセス、およびそれ以降のバケット管理タスクには、これらのキーが必要です。
2.4.2. Ruby AWS::S3 Examples (aws-s3 gem)
Ruby プログラミング言語は、S3
アクセスに aws-s3
gem と共に使用できます。Ruby AWS::S3
で Ceph Object Gateway サーバーにアクセスするために使用されるノードで以下の手順を実行します。
Ruby の設定
以下の手順を実行して Ruby を設定します。
root
としてruby
をインストールします。# yum install ruby
注記上記のコマンドは
ruby
と、rubygems
やruby-libs
などの基本的な依存関係もインストールします。コマンドによってすべての依存関係がインストールされない場合は、個別にインストールします。root
として、aws-s3
をインストールします。# gem install aws-s3
コネクションの作成
プロジェクトディレクトリーを作成します。
$ mkdir ruby_aws_s3 $ cd ruby_aws_s3
コネクションファイルを作成します。
$ vim conn.rb
conn.rb
ファイルに以下のコンテンツを貼り付けます。#!/usr/bin/env ruby require 'aws/s3' require 'resolv-replace' AWS::S3::Base.establish_connection!( :server => '<FQDN_of_gateway_node>', :port => '8080', :access_key_id => 'my-access-key', :secret_access_key => 'my-secret-key' )
<
;FQDN_of_gateway_node>
をゲートウェイノードの FQDN に置き換えます。Red Hat Enterprise Linux のオブジェクトゲートウェイガイド または Ubuntu のオブジェクトゲートウェイガイド で説明されているように、my-access-key
およびmy-secret-key
は、S3
アクセスのradosgw
が作成されたときに生成されたaccess_key
およびsecret_key
に置き換えます。コネクションファイルの例を以下に示します。
#!/usr/bin/env ruby require 'aws/s3' require 'resolv-replace' AWS::S3::Base.establish_connection!( :server => 'testclient.englab.pnq.redhat.com', :port => '8080', :access_key_id => '98J4R9P22P5CDL65HKP8', :secret_access_key => '6C+jcaP0dp0+FZfrRNgyGA9EzRy25pURldwje049' )
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
$ chmod +x conn.rb
コマンドを実行します。
$ ./conn.rb | echo $?
ファイルに正しく値を指定した場合は、コマンドの出力は
0
になります。
バケットの作成
新しいファイルを作成します。
$ vim create_bucket.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' AWS::S3::Bucket.create('my-new-bucket1')
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
$ chmod +x create_bucket.rb
コマンドを実行します。
$ ./create_bucket.rb
コマンドの出力が
true
の場合は、バケットmy-new-bucket1
が正常に作成されたことを意味します。
所有するバケットの一覧表示
新しいファイルを作成します。
$ vim list_owned_buckets.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' AWS::S3::Service.buckets.each do |bucket| puts "#{bucket.name}\t#{bucket.creation_date}" end
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
$ chmod +x list_owned_buckets.rb
コマンドを実行します。
$ ./list_owned_buckets.rb
出力は以下のようになります。
my-new-bucket1 2016-01-21 10:33:19 UTC
オブジェクトの作成
新しいファイルを作成します。
$ vim create_object.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' AWS::S3::S3Object.store( 'hello.txt', 'Hello World!', 'my-new-bucket1', :content_type => 'text/plain' )
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
$ chmod +x create_object.rb
コマンドを実行します。
$ ./create_object.rb
これで、文字列
Hello World!
でhello.txt
が作成されます。
バケットの内容の一覧表示
新しいファイルを作成します。
$ vim list_bucket_content.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' new_bucket = AWS::S3::Bucket.find('my-new-bucket1') new_bucket.each do |object| puts "#{object.key}\t#{object.about['content-length']}\t#{object.about['last-modified']}" end
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
$ chmod +x list_bucket_content.rb
コマンドを実行します。
$ ./list_bucket_content.rb
出力は以下のようになります。
hello.txt 12 Fri, 22 Jan 2016 15:54:52 GMT
空のバケットの削除
新しいファイルを作成します。
$ vim del_empty_bucket.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' AWS::S3::Bucket.delete('my-new-bucket1')
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
$ chmod +x del_empty_bucket.rb
コマンドを実行します。
$ ./del_empty_bucket.rb | echo $?
バケットが正常に削除されると、コマンドは
0
を出力として返します。注記create_bucket.rb
ファイルを編集して、my-new-bucket9
、my-new-bucket10
などの空のバケットを作成し、空のバケットの削除を試みる前に上記のdel_empty_bucket.rb
ファイルを適宜編集してください。
空でないバケットの削除(強制的に実行)
新しいファイルを作成します。
$ vim del_non_empty_bucket.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' AWS::S3::Bucket.delete('my-new-bucket1', :force => true)
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
$ chmod +x del_non_empty_bucket.rb
コマンドを実行します。
$ ./del_non_empty_bucket.rb | echo $?
バケットが正常に削除されると、コマンドは
0
を出力として返します。
オブジェクトの削除
新しいファイルを作成します。
$ vim delete_object.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' AWS::S3::S3Object.delete('hello.txt', 'my-new-bucket1')
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
$ chmod +x delete_object.rb
コマンドを実行します。
$ ./delete_object.rb
これにより、オブジェクト
hello.txt
が削除されます。
2.4.3. Ruby AWS::SDK Examples (aws-sdk gem ~>2)
Ruby プログラミング言語は、S3
アクセスに aws-sdk
gem と共に使用できます。Ruby AWS::SDK
を使用して Ceph Object Gateway サーバーにアクセスするために使用されるノードで以下の手順を実行します。
Ruby の設定
以下の手順を実行して Ruby を設定します。
root
としてruby
をインストールします。# yum install ruby
注記上記のコマンドは ruby と、
rubygems
やruby
-libsroot
として、aws-sdk
をインストールします。# gem install aws-sdk
コネクションの作成
プロジェクトディレクトリーを作成します。
$ mkdir ruby_aws_sdk $ cd ruby_aws_sdk
コネクションファイルを作成します。
$ vim conn.rb
conn.rb
ファイルに以下のコンテンツを貼り付けます。#!/usr/bin/env ruby require 'aws-sdk' require 'resolv-replace' Aws.config.update( endpoint: 'http://<FQDN_of_gateway_node>:8080', access_key_id: 'my-access-key', secret_access_key: 'my-secret-key', force_path_style: true, region: 'us-east-1' )
<
;FQDN_of_gateway_node>
をゲートウェイノードの FQDN に置き換えます。Red Hat Ceph Storage オブジェクトゲートウェイガイド で説明されているように、my-access-key
およびmy-secret-key
は、S3
アクセスのradosgw
が作成されたときに生成されたaccess_key
およびsecret_key
に置き換えます。コネクションファイルの例を以下に示します。
#!/usr/bin/env ruby require 'aws-sdk' require 'resolv-replace' Aws.config.update( endpoint: 'http://testclient.englab.pnq.redhat.com:8080', access_key_id: '98J4R9P22P5CDL65HKP8', secret_access_key: '6C+jcaP0dp0+FZfrRNgyGA9EzRy25pURldwje049', force_path_style: true, region: 'us-east-1' )
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
chmod +x conn.rb
コマンドを実行します。
./conn.rb | echo $?
ファイルに正しく値を指定した場合は、コマンドの出力は
0
になります。
バケットの作成
新しいファイルを作成します。
vim create_bucket.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' s3_client = Aws::S3::Client.new s3_client.create_bucket(bucket: 'my-new-bucket2')
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
chmod +x create_bucket.rb
コマンドを実行します。
./create_bucket.rb
コマンドの出力が
true
の場合は、バケットmy-new-bucket2
が正常に作成されていることを意味します。
所有するバケットの一覧表示
新しいファイルを作成します。
vim list_owned_buckets.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' s3_client = Aws::S3::Client.new s3_client.list_buckets.buckets.each do |bucket| puts "#{bucket.name}\t#{bucket.creation_date}" end
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
chmod +x list_owned_buckets.rb
コマンドを実行します。
./list_owned_buckets.rb
出力は以下のようになります。
my-new-bucket2 2016-01-21 10:33:19 UTC
オブジェクトの作成
新しいファイルを作成します。
vim create_object.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' s3_client = Aws::S3::Client.new s3_client.put_object( key: 'hello.txt', body: 'Hello World!', bucket: 'my-new-bucket2', content_type: 'text/plain' )
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
chmod +x create_object.rb
コマンドを実行します。
./create_object.rb
これで、文字列
Hello World!
でhello.txt
が作成されます。
バケットの内容の一覧表示
新しいファイルを作成します。
vim list_bucket_content.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' s3_client = Aws::S3::Client.new s3_client.list_objects(bucket: 'my-new-bucket2').contents.each do |object| puts "#{object.key}\t#{object.size}" end
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
chmod +x list_bucket_content.rb
コマンドを実行します。
./list_bucket_content.rb
出力は以下のようになります。
hello.txt 12 Fri, 22 Jan 2016 15:54:52 GMT
空のバケットの削除
新しいファイルを作成します。
vim del_empty_bucket.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' s3_client = Aws::S3::Client.new s3_client.delete_bucket(bucket: 'my-new-bucket2')
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
chmod +x del_empty_bucket.rb
コマンドを実行します。
./del_empty_bucket.rb | echo $?
バケットが正常に削除されると、コマンドは
0
を出力として返します。注記create_bucket.rb
ファイルを編集し、my-new-bucket6
、my-new-bucket7
などの空のバケットを作成し、空のバケットの削除を試みる前に上記のdel_empty_bucket.rb
ファイルを適宜編集してください。
空でないバケットの削除(強制的に実行)
新しいファイルを作成します。
vim del_non_empty_bucket.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' s3_client = Aws::S3::Client.new Aws::S3::Bucket.new('my-new-bucket2', client: s3_client).clear! s3_client.delete_bucket(bucket: 'my-new-bucket2')
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
chmod +x del_non_empty_bucket.rb
コマンドを実行します。
./del_non_empty_bucket.rb | echo $?
バケットが正常に削除されると、コマンドは
0
を出力として返します。
オブジェクトの削除
新しいファイルを作成します。
vim delete_object.rb
以下のコンテンツをファイルに貼り付けます。
#!/usr/bin/env ruby load 'conn.rb' s3_client = Aws::S3::Client.new s3_client.delete_object(key: 'hello.txt', bucket: 'my-new-bucket2')
ファイルを保存して、エディターを終了します。
ファイルを実行可能にします。
chmod +x delete_object.rb
コマンドを実行します。
./delete_object.rb
これにより、オブジェクト
hello.txt
が削除されます。
2.4.4. PHP S3 の例
S3 アクセスには PHP スクリプトを使用することもできます。PHP を使用して Ceph Object Gateway サーバーにアクセスするために使用されるノードで以下の手順を実行します。
以下は、php v5.4.16
および aws-sdk v2.8.24
に対してテストされています。php >= 5.5+ が必要なため、
ない でください。php
には aws-sdk
の最新バージョンを使用しPHP 5.5
は、RHEL 7
のデフォルトリポジトリーでは利用できません。php 5.5
を使用する場合は、epel
およびその他のサードパーティーのリポジトリーを有効にする必要があります。また、php 5.5
および最新バージョンの aws-sdk
の設定オプションも異なります。
PHP/AWS SDK の設定
PHP を設定するには、以下の手順を実行します。
root
として、php
をインストールします。# yum install php
php の
aws-sdk
をインストールします。php 用に
aws-sdk
の zip アーカイブを ダウンロード し、展開します。
コネクションの作成
プロジェクトディレクトリーを作成します。
$ mkdir php_s3 $ cd php_s3
展開した
aws
ディレクトリーをプロジェクトのディレクトリーにコピーします。以下に例を示します。$ cp -r ~/Downloads/aws/ ~/php_s3/
コネクションファイルを作成します。
$ vim conn.php
conn.php
ファイルに以下のコンテンツを貼り付けます。<?php define('AWS_KEY', 'my_access_key'); define('AWS_SECRET_KEY', 'my_secret_key'); define('HOST', '<FQDN_of_gateway_node>'); define('PORT', '8080'); // require the AWS SDK for php library require '/path_to_aws/aws-autoloader.php'; use Aws\S3\S3Client; // Establish connection with host using S3 Client $client = S3Client::factory(array( 'base_url' => HOST, 'port' => PORT, 'key' => AWS_KEY, 'secret' => AWS_SECRET_KEY )); ?>
<
;FQDN_of_gateway_node>
をゲートウェイノードの FQDN に置き換えます。Red Hat Ceph Storage オブジェクトゲートウェイガイド で説明されているように、my-access-key
およびmy-secret-key
は、S3
アクセスのradosgw
が作成されたときに生成されたaccess_key
およびsecret_key
に置き換えます。また、path_to_aws
を、php
プロジェクトディレクトリーにコピーした展開したaws
ディレクトリーへの絶対パスに置き換えます。接続ファイルの例を以下に示します。
<?php define('AWS_KEY', '{key}'); define('AWS_SECRET_KEY', '{secret}'); define('HOST', 'http://{hostname}'); // require the AWS SDK for php library require '/home/ceph/php_s3/aws/aws-autoloader.php'; use Aws\S3\S3Client; // Establish connection with host using S3 Client $client = S3Client::factory(array( 'base_url' => HOST, 'port' => PORT, 'key' => AWS_KEY, 'secret' => AWS_SECRET_KEY )); ?>
ファイルを保存して、エディターを終了します。
コマンドを実行します。
$ php -f conn.php | echo $?
ファイルに正しく値を指定した場合は、コマンドの出力は
0
になります。
バケットの作成
新しいファイルを作成します。
vim create_bucket.php
以下のコンテンツをファイルに貼り付けます。
<?php include 'conn.php'; $client->createBucket(array('Bucket' => 'my-new-bucket3')); ?>
ファイルを保存して、エディターを終了します。
コマンドを実行します。
php -f create_bucket.php
所有するバケットの一覧表示
新しいファイルを作成します。
vim list_owned_buckets.php
以下のコンテンツをファイルに貼り付けます。
<?php include 'conn.php'; $blist = $client->listBuckets(); echo " Buckets belonging to " . $blist['Owner']['ID'] . ":\n"; foreach ($blist['Buckets'] as $b) { echo "{$b['Name']}\t{$b['CreationDate']}\n"; } ?>
ファイルを保存して、エディターを終了します。
コマンドを実行します。
php -f list_owned_buckets.php
出力は以下のようになります。
my-new-bucket3 2016-01-21 10:33:19 UTC
オブジェクトの作成
ソースファイル
hello.txt
を作成します。echo "Hello World!" > hello.txt
新しい php ファイルを作成します。
vim create_object.php
以下のコンテンツをファイルに貼り付けます。
<?php include 'conn.php'; $key = 'hello.txt'; $source_file = './hello.txt'; $acl = 'private'; $bucket = 'my-new-bucket3'; $client->upload($bucket, $key, fopen($source_file, 'r'), $acl); ?>
ファイルを保存して、エディターを終了します。
コマンドを実行します。
php -f create_object.php
これにより、バケット
my-new-bucket3
でオブジェクトhello.txt
が作成されます。
バケットの内容の一覧表示
新しいファイルを作成します。
vim list_bucket_content.php
以下のコンテンツをファイルに貼り付けます。
<?php include 'conn.php'; $o_iter = $client->getIterator('ListObjects', array( 'Bucket' => 'my-new-bucket3' )); foreach ($o_iter as $o) { echo "{$o['Key']}\t{$o['Size']}\t{$o['LastModified']}\n"; } ?>
ファイルを保存して、エディターを終了します。
コマンドを実行します。
php -f list_bucket_content.php
出力は以下のようになります。
hello.txt 12 Fri, 22 Jan 2016 15:54:52 GMT
空のバケットの削除
新しいファイルを作成します。
vim del_empty_bucket.php
以下のコンテンツをファイルに貼り付けます。
<?php include 'conn.php'; $client->deleteBucket(array('Bucket' => 'my-new-bucket3')); ?>
ファイルを保存して、エディターを終了します。
コマンドを実行します。
php -f del_empty_bucket.php | echo $?
バケットが正常に削除されると、コマンドは
0
を出力として返します。注記create_bucket.php
ファイルを編集し、my-new-bucket4
、my-new-bucket5
などの空のバケットを作成し、空のバケットの削除を試みる前に、del_empty_bucket.php
ファイルを適宜編集します。
空でないバケットの削除(強制的に実行)
現在、空でないバケットの削除は、php 2
以降のバージョンの aws-sdk
ではサポートされていません。
オブジェクトの削除
新しいファイルを作成します。
vim delete_object.php
以下のコンテンツをファイルに貼り付けます。
<?php include 'conn.php'; $client->deleteObject(array( 'Bucket' => 'my-new-bucket3', 'Key' => 'hello.txt', )); ?>
ファイルを保存して、エディターを終了します。
コマンドを実行します。
php -f delete_object.php
これにより、オブジェクト
hello.txt
が削除されます。
2.4.5. Keystone での STS Lite の設定および使用 (テクノロジープレビュー)
Amazon Secure Token Service (STS) と S3 API は、同じ名前空間に共存します。STS オプションは、Keystone オプションと組み合わせて設定できます。
S3 と STS の API の両方に、Ceph Object Gateway の同じエンドポイントを使用してアクセスできます。
前提条件
- Red Hat Ceph Storage 3.2 以降
- 実行中の Ceph Object Gateway。
- Boto Python モジュールのバージョン 3 以降のインストール
手順
group_vars/rgws.yml
ファイルを以下のオプションで開き、編集します。rgw_sts_key = $STS_KEY_FOR_ENCRYPTING_SESSION_TOKEN rgw_s3_auth_use_sts = true
Ansible Playbook を再実行します。
[user@admin ceph-ansible]$ ansible-playbook site.yml --limit rgws
EC2 認証情報を生成します。
例
$ openstack ec2 credentials create +------------+--------------------------------------------------------+ | Field | Value | +------------+--------------------------------------------------------+ | access | b924dfc87d454d15896691182fdeb0ef | | links | {u'self': u'http://192.168.0.15/identity/v3/users/ | | | 40a7140e424f493d8165abc652dc731c/credentials/ | | | OS-EC2/b924dfc87d454d15896691182fdeb0ef'} | | project_id | c703801dccaf4a0aaa39bec8c481e25a | | secret | 6a2142613c504c42a94ba2b82147dc28 | | trust_id | None | | user_id | 40a7140e424f493d8165abc652dc731c | +------------+--------------------------------------------------------+
生成された認証情報を使用して、GetSessionToken API を使用して一時的なセキュリティー認証情報のセットを取得します。
例
import boto3 access_key = b924dfc87d454d15896691182fdeb0ef secret_key = 6a2142613c504c42a94ba2b82147dc28 client = boto3.client('sts', aws_access_key_id=access_key, aws_secret_access_key=secret_key, endpoint_url=https://www.example.com/rgw, region_name='', ) response = client.get_session_token( DurationSeconds=43200 )
一時認証情報の取得は、S3 呼び出しの作成に使用できます。
例
s3client = boto3.client('s3', aws_access_key_id = response['Credentials']['AccessKeyId'], aws_secret_access_key = response['Credentials']['SecretAccessKey'], aws_session_token = response['Credentials']['SessionToken'], endpoint_url=https://www.example.com/s3, region_name='') bucket = s3client.create_bucket(Bucket='my-new-shiny-bucket') response = s3client.list_buckets() for bucket in response["Buckets"]: print "{name}\t{created}".format( name = bucket['Name'], created = bucket['CreationDate'], )
新しい S3Access ロールを作成し、ポリシーを設定します。
管理 CAPS でユーザーを割り当てます。
radosgw-admin caps add --uid="$USER" --caps="roles=*"
例
[user@client]$ radosgw-admin caps add --uid="gwadmin" --caps="roles=*"
S3Access ロールを作成します。
radosgw-admin role create --role-name=$ROLE_NAME --path=$PATH --assume-role-policy-doc=$TRUST_POLICY_DOC
例
[user@client]$ radosgw-admin role create --role-name=S3Access --path=/application_abc/component_xyz/ --assume-role-policy-doc=\{\"Version\":\"2012-10-17\",\"Statement\":\[\{\"Effect\":\"Allow\",\"Principal\":\{\"AWS\":\[\"arn:aws:iam:::user/TESTER\"\]\},\"Action\":\[\"sts:AssumeRole\"\]\}\]\}
S3Access ロールにパーミッションポリシーを割り当てます。
radosgw-admin role-policy put --role-name=$ROLE_NAME --policy-name=$POLICY_NAME --policy-doc=$PERMISSION_POLICY_DOC
例
[user@client]$ radosgw-admin role-policy put --role-name=S3Access --policy-name=Policy --policy-doc=\{\"Version\":\"2012-10-17\",\"Statement\":\[\{\"Effect\":\"Allow\",\"Action\":\[\"s3:*\"\],\"Resource\":\"arn:aws:s3:::example_bucket\"\}\]\}
-
別のユーザーが
gwadmin
ユーザーのロールを想定できるようになりました。たとえば、gwuser
ユーザーは、gwadmin
ユーザーのパーミッションを想定できます。 仮定ユーザーの
access_key
およびsecret_key
の値を書き留めておきます。例
[user@client]$ radosgw-admin user info --uid=gwuser | grep -A1 access_key
AssumeRole API 呼び出しを使用し、仮定のユーザーから
access_key
およびsecret_key
の値を提供します。例
import boto3 access_key = 11BS02LGFB6AL6H1ADMW secret_key = vzCEkuryfn060dfee4fgQPqFrncKEIkh3ZcdOANY client = boto3.client('sts', aws_access_key_id=access_key, aws_secret_access_key=secret_key, endpoint_url=https://www.example.com/rgw, region_name='', ) response = client.assume_role( RoleArn='arn:aws:iam:::role/application_abc/component_xyz/S3Access', RoleSessionName='Bob', DurationSeconds=3600 )
重要AssumeRole API には S3Access ロールが必要です。
関連情報
- Boto Python モジュールのインストールに関する詳細は、Red Hat Ceph Storage Object Gateway ガイド の S3 アクセスのテスト セクションを参照してください。
- 詳細は、Red Hat Ceph Storage Object Gateway ガイド の ユーザーの作成 セクションを参照してください。
2.4.6. Keystone で STS Lite を使用するための制限の回避 (テクノロジープレビュー)
Keystone の制限は、STS リクエストをサポートしないことです。もう 1 つの制限は、ペイロードハッシュがリクエストに含まれていないことです。この 2 つの制限を回避するには、Boto 認証コードを変更する必要があります。
前提条件
- Red Hat Ceph Storage 3.2 以降
- 実行中の Ceph Object Gateway。
- Boto Python モジュールのバージョン 3 以降のインストール
手順
Boto の
auth.py
ファイルを開いて編集します。以下の 4 つの行をコードブロックに追加します。
class SigV4Auth(BaseSigner): """ Sign a request with Signature V4. """ REQUIRES_REGION = True def __init__(self, credentials, service_name, region_name): self.credentials = credentials # We initialize these value here so the unit tests can have # valid values. But these will get overriden in ``add_auth`` # later for real requests. self._region_name = region_name if service_name == 'sts': 1 self._service_name = 's3' 2 else: 3 self._service_name = service_name 4
以下の 2 つの行をコードブロックに追加します。
def _modify_request_before_signing(self, request): if 'Authorization' in request.headers: del request.headers['Authorization'] self._set_necessary_date_headers(request) if self.credentials.token: if 'X-Amz-Security-Token' in request.headers: del request.headers['X-Amz-Security-Token'] request.headers['X-Amz-Security-Token'] = self.credentials.token if not request.context.get('payload_signing_enabled', True): if 'X-Amz-Content-SHA256' in request.headers: del request.headers['X-Amz-Content-SHA256'] request.headers['X-Amz-Content-SHA256'] = UNSIGNED_PAYLOAD 1 else: 2 request.headers['X-Amz-Content-SHA256'] = self.payload(request)
関連情報
- Boto Python モジュールのインストールに関する詳細は、Red Hat Ceph Storage Object Gateway ガイド の S3 アクセスのテスト セクションを参照してください。
2.5. 一般的な操作
2.5.1. バケットおよびホスト名
バケットにアクセスするモードは 2 つあります。最初のメソッドは推奨されるメソッドで、バケットを URI の最上位ディレクトリーとして識別します。
例
GET /mybucket HTTP/1.1 Host: cname.domain.com
2 番目のメソッドは、仮想バケットのホスト名経由でバケットを識別します。
例
GET / HTTP/1.1 Host: mybucket.cname.domain.com
2 番目の方法では高価なドメイン認定と DNS ワイルドカードが必要なため、Red Hat は最初の方法を推奨します。
2.5.2. 一般的なリクエストヘッダー
以下の表には、有効な一般的なリクエストヘッダーとその説明をまとめています。
リクエストヘッダー | 詳細 |
---|---|
| リクエストボディーの長さ。 |
| 要求の日時と日付 (UTC 単位)。 |
| ホストサーバーの名前。 |
| 承認トークン。 |
2.5.3. 一般的な応答ステータス
以下の表は、有効な一般的な HTTP レスポンスステータスと対応するコードを示しています。
HTTP ステータス | レスポンスコード |
---|---|
| Continue |
| Success |
| Created |
| Accepted |
| NoContent |
| Partial content |
| NotModified |
| InvalidArgument |
| InvalidDigest |
| BadDigest |
| InvalidBucketName |
| InvalidObjectName |
| UnresolvableGrantByEmailAddress |
| InvalidPart |
| InvalidPartOrder |
| RequestTimeout |
| EntityTooLarge |
| AccessDenied |
| UserSuspended |
| RequestTimeTooSkewed |
| NoSuchKey |
| NoSuchBucket |
| NoSuchUpload |
| MethodNotAllowed |
| RequestTimeout |
| BucketAlreadyExists |
| BucketNotEmpty |
| MissingContentLength |
| PreconditionFailed |
| InvalidRange |
| UnprocessableEntity |
| InternalError |
2.6. サービス操作
2.6.1. バケットの一覧表示
GET /
は、ユーザーがリクエストを行うユーザーが作成するバケットの一覧を返します。GET /
は、認証ユーザーが作成したバケットのみを返します。匿名のリクエストを行うことはできません。
構文
GET / HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | バケットの一覧用のコンテナー。 |
| コンテナー | バケット情報用のコンテナー |
| 文字列 | バケット名。 |
| Date | バケットが作成された時点の UTC 時間。 |
| コンテナー | 結果のコンテナー。 |
| コンテナー |
バケット所有者の |
| 文字列 | バケット所有者の ID。 |
| 文字列 | バケットの所有者の表示名。 |
2.7. バケット操作
2.7.1. マルチテナントによるバケット操作
クライアントアプリケーションがバケットにアクセスする場合は、常に特定ユーザーの認証情報で動作します。Red Hat Ceph Storage 3 では、すべてのユーザーがテナントに属します。詳細は 、マルチテナンシー を 参照してください。そのため、テナントが明示的に指定されていない場合は、すべてのバケット操作のコンテキストに暗黙的なテナントがあります。したがって、マルチテナンシーは、参照されるバケットと参照ユーザーが同じテナントに属する限り、以前のリリースと完全に後方互換性があります。
明示的なテナントの指定に使用される拡張機能は、使用されるプロトコルおよび認証システムによって異なります。
以下の例では、コロン文字はテナントとバケットを分離します。そのため、URL のサンプルは以下のようになります。
https://rgw.domain.com/tenant:bucket
一方、単純な Python の例は、バケットメソッド自体でテナントとバケットを分離します。
from boto.s3.connection import S3Connection, OrdinaryCallingFormat c = S3Connection( aws_access_key_id="TESTER", aws_secret_access_key="test123", host="rgw.domain.com", calling_format = OrdinaryCallingFormat() ) bucket = c.get_bucket("tenant:bucket")
ホスト名に、コロンや、バケット名では有効ではない他の区切り文字を含めることができないため、マルチテナンシーを使用して S3 形式のサブドメインを使用することはできません。期間を使用するとあいまいな構文が作成されます。そのため、bucket-in-URL-path
形式をマルチテナンシーと併用する必要があります。
2.7.2. バケットライフサイクル
バケットのライフサイクル設定を使用してオブジェクトを管理し、そのオブジェクトが有効期間中効果的に保存されるようにすることができます。Ceph Object Gateway の S3 API は、AWS バケットライフサイクルアクションのサブセットをサポートします。
-
Expiration
: これはバケット内のオブジェクトの有効期間を定義します。オブジェクトが存続する日数または有効期限がかかり、その時点で Ceph Object Gateway がオブジェクトを削除します。バケットがバージョン管理を有効にしない場合、Ceph Object Gateway はオブジェクトを永続的に削除します。バケットがバージョン管理を有効化する場合、Ceph Object Gateway は現行バージョンの削除マーカーを作成し、現行バージョンを削除します。 -
NoncurrentVersionExpiration
: これはバケット内の最新バージョン以外のオブジェクトバージョンのライフサイクルを定義します。この機能を使用するには、バケットがバージョン管理を有効にする必要があります。最新バージョン以外のオブジェクトが存続する日数を取ります。この時点では、Ceph Object Gateway が最新バージョン以外のオブジェクトを削除します。 -
AbortIncompleteMultipartUpload
: これは、非完全なマルチパートアップロードが中止されるまでの日数を定義します。
ライフサイクル設定には、<Rule>
要素を使用した 1 つ以上のルールが含まれます。以下に例を示します。
<LifecycleConfiguration> <Rule> <Prefix/> <Status>Enabled</Status> <Expiration> <Days>10</Days> </Expiration> </Rule> </LifecycleConfiguration>
ライフサイクルルールは、ライフサイクルルールに指定する <Filter>
要素に基づいてバケットの全オブジェクトまたはサブセットに適用できます。フィルターは複数の方法を指定できます。
- キーの接頭辞
- オブジェクトタグ
- キー接頭辞と 1 つ以上のオブジェクトタグの両方
キーの接頭辞
ライフサイクルルールは、キー名の接頭辞に基づいてオブジェクトのサブセットに適用できます。たとえば、<keypre/>
を指定すると、keypre/
で始まるオブジェクトに適用されます。
<LifecycleConfiguration> <Rule> <Status>Enabled</Status> <Filter> <Prefix>keypre/</Prefix> </Filter> </Rule> </LifecycleConfiguration>
異なるキー接頭辞を持つオブジェクトに、異なるライフサイクルルールを適用することもできます。
<LifecycleConfiguration> <Rule> <Status>Enabled</Status> <Filter> <Prefix>keypre/</Prefix> </Filter> </Rule> <Rule> <Filter> <Prefix>mypre/</Prefix> </Filter> </Rule> </LifecycleConfiguration>
オブジェクトタグ
ライフサイクルルールは、<Key>
要素および <Value>
要素を使用して、特定のタグを持つオブジェクトにのみ適用できます。
<LifecycleConfiguration> <Rule> <Status>Enabled</Status> <Filter> <Tag> <Key>key</Key> <Value>value</Value> </Tag> </Filter> </Rule> </LifecycleConfiguration>
接頭辞および 1 つ以上のタグの両方
ライフサイクルルールでは、キーの接頭辞と 1 つ以上のタグの両方に基づいてフィルターを指定できます。これらは <And>
要素でラップする必要があります。フィルターには 1 つの接頭辞と、ゼロまたは複数のタグのみを使用できます。
<LifecycleConfiguration> <Rule> <Status>Enabled</Status> <Filter> <And> <Prefix>key-prefix</Prefix> <Tag> <Key>key1</Key> <Value>value1</Value> </Tag> <Tag> <Key>key2</Key> <Value>value2</Value> </Tag> ... </And> </Filter> <Status>Enabled</Status> </Rule> </LifecycleConfiguration>
詳細は、以下を参照してください。
2.7.3. HEAD バケット
バケットで HEAD を呼び出して、存在する場合は、呼び出し元にアクセス権限があるかどうかを判断します。バケットが存在し、呼び出し元にパーミッションがある場合は 200 OK
を返します。バケットが存在しない場合は 404 Not Found
、バケットが存在しますが呼び出し元にはアクセスパーミッションがない場合は 403 Forbidden
を返します。
構文
HEAD /<bucket> HTTP/1.1 Host: cname.domain.com Date: date Authorization: AWS <access_key>:<hash_of_header_and_secret>
2.7.4. PUT バケット
新規バケットを作成します。バケットを作成するには、要求を認証するためにユーザー ID および有効な AWS アクセスキー ID が必要です。バケットを匿名ユーザーとして作成することはできません。
制約
通常、バケット名はドメイン名の制約に従う必要があります。
- バケット名は一意である必要があります。
- バケット名は最初に指定し、小文字で終了する必要があります。
- バケット名にはダッシュ (-) を含めることができます。
構文
PUT /<bucket> HTTP/1.1 Host: cname.domain.com x-amz-acl: public-read-write Authorization: AWS <access_key>:<hash_of_header_and_secret>
名前 | 説明 | 有効な値 | 必須 |
---|---|---|---|
| 固定 ACL。 |
| いいえ |
HTTP レスポンス
バケット名が一意で、制約内で未使用であると、操作は成功します。同じ名前のバケットがすでに存在し、ユーザーがバケット所有者である場合は、操作が成功します。バケット名が使用中の場合は、操作が失敗します。
HTTP ステータス | ステータスコード | 詳細 |
---|---|---|
| BucketAlreadyExists | バケットは、異なるユーザーの所有権に存在します。 |
2.7.5. Put Bucket Lifecycle
バケットライフサイクルを作成または置き換えるには、PUT
を使用して宛先バケットとライフサイクル設定を指定します。Ceph Object Gateway は、S3 ライフサイクル機能のサブセットのみをサポートします。詳細は、S3 API バケットライフサイクル を参照してください。
構文
PUT /<bucket>?lifecycle HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret> <LifecycleConfiguration> <Rule> <Expiration> <Days>10</Days> </Expiration> </Rule> ... <Rule> </Rule> </LifecycleConfiguration>
名前 | 説明 | 有効な値 | 必須 |
---|---|---|---|
content-md5 | メッセージの base64 でエンコードされた MD-5 ハッシュ | 文字列。デフォルトや制約はありません。 | いいえ |
一般的なリクエストヘッダーも参照してください。
2.7.6. DELETE バケット
バケットを削除します。バケットの削除が正常に行われた後にバケット名を再利用できます。
構文
DELETE /<bucket> HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
HTTP ステータス | ステータスコード | 詳細 |
---|---|---|
| コンテンツなし | バケットが削除されました。 |
2.7.7. バケットライフサイクルの削除
バケットライフサイクルを削除するには、DELETE
を使用し、宛先バケットを指定します。
構文
DELETE /<bucket>?lifecycle HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
リクエストヘッダー
リクエストには特別な要素が含まれません。
一般的なリクエストヘッダーを参照してください。
応答
レスポンスは、一般的なレスポンスのステータスを返します。
詳細は、一般的な応答ステータス を参照してください。
2.7.8. GET バケット
バケットオブジェクトの一覧を返します。
構文
GET /<bucket>?max-keys=25 HTTP/1.1 Host: cname.domain.com
名前 | 型 | 詳細 |
---|---|---|
| 文字列 | 指定された接頭辞が含まれるオブジェクトのみを返します。 |
| 文字列 | 接頭辞と他のオブジェクト名の間に挿入される区切り文字。 |
| 文字列 | 返されるオブジェクトリストの開始インデックス。 |
| 整数 | 返すキーの最大数。デフォルトは 1000 です。 |
HTTP ステータス | ステータスコード | 詳細 |
---|---|---|
| OK | 取得されるバケット |
GET /<bucket>
; は、以下のフィールドを持つバケットのコンテナーを返します。
名前 | 型 | 詳細 |
---|---|---|
| エンティティー | オブジェクト一覧のコンテナー。 |
| 文字列 | コンテンツが返されるバケットの名前。 |
| 文字列 | オブジェクトキーの接頭辞。 |
| 文字列 | 返されるオブジェクトリストの開始インデックス。 |
| 整数 | 返されるキーの最大数。 |
| 文字列 |
設定されている場合は、同じ接頭辞を持つオブジェクトが |
| ブール値 |
|
| コンテナー | 複数のオブジェクトに同じ接頭辞が含まれる場合は、この一覧に表示されます。 |
ListBucketResult
にはオブジェクトが含まれ、各オブジェクトは Contents
コンテナー内にあります。
名前 | 型 | 詳細 |
---|---|---|
| Object | オブジェクトのコンテナー。 |
| 文字列 | オブジェクトのキー。 |
| Date | オブジェクトの最後に変更した日時。 |
| 文字列 | オブジェクトの MD-5 ハッシュ (entity タグ) |
| 整数 | オブジェクトのサイズ。 |
| 文字列 |
常に |
2.7.9. バケットライフサイクルの取得
バケットのライフサイクルを取得するには、GET
を使用して宛先バケットを指定します。
構文
GET /<bucket>?lifecycle HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
リクエストヘッダー
一般的なリクエストヘッダーを参照してください。
応答
レスポンスには、バケットライフサイクルとその要素が含まれます。
2.7.10. バケットの場所の取得
バケットのゾーングループを取得します。これを呼び出すには、ユーザーはバケット所有者である必要があります。PUT 要求時に LocationConstraint
を指定して、バケットをゾーングループに制限できます。
以下のように location
サブリソースをバケットリソースに追加します。
構文
GET /<bucket>?location HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
名前 | 型 | 詳細 |
---|---|---|
| String | バケットが存在するゾーングループ(ゾーングループのための空の文字列) |
2.7.11. バケットバージョン管理の取得
バケットのバージョン状態を取得します。これを呼び出すには、ユーザーはバケット所有者である必要があります。
以下のように、versioning
サブリソースをバケットリソースに追加します。
構文
GET /<bucket>?versioning HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
2.7.12. PUT バケットバージョン管理
このサブリソースは、既存のバケットのバージョン管理状態を設定します。バージョン管理状態を設定するには、バケット所有者である必要があります。バージョン管理状態がバケットに設定されていないと、バージョンは管理されていません。GET バージョン管理リクエストを実行しても、バージョン管理状態の値は返されません。
バケットによるバージョン管理の状態を設定します。
Enabled
: バケットのオブジェクトのバージョン管理を有効にします。バケットに追加したすべてのオブジェクトは、一意のバージョン ID を受信します。Suspended
: バケットのオブジェクトのバージョン管理を無効にします。バケットに追加したすべてのオブジェクトは、バージョン ID の Null を受け取ります。
構文
PUT /<bucket>?versioning HTTP/1.1
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | 要求のコンテナー。 |
| 文字列 | バケットのバージョン状態を設定します。有効な値: Suspended/Enabled |
2.7.13. バケット ACL の取得
バケットのアクセス制御リストを取得します。ユーザーはバケットの所有者である必要があります。または、バケットで READ_ACP
パーミッションが付与されている必要があります。
以下のように、acl
サブリソースをバケット要求に追加します。
構文
GET /<bucket>?acl HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | レスポンスのコンテナー。 |
| コンテナー | ACL 情報用のコンテナー |
| コンテナー |
バケット所有者の |
| 文字列 | バケット所有者の ID。 |
| 文字列 | バケットの所有者の表示名。 |
| コンテナー |
|
| コンテナー |
パーミッションを付与されるユーザーの |
| 文字列 |
|
2.7.14. PUT バケット ACL
既存のバケットへのアクセス制御を設定します。ユーザーはバケットの所有者である必要があります。または、バケットの WRITE_ACP
パーミッションが付与されている必要があります。
以下のように、acl
サブリソースをバケット要求に追加します。
構文
PUT /<bucket>?acl HTTP/1.1
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | 要求のコンテナー。 |
| コンテナー | ACL 情報用のコンテナー |
| コンテナー |
バケット所有者の |
| 文字列 | バケット所有者の ID。 |
| 文字列 | バケットの所有者の表示名。 |
| コンテナー |
|
| コンテナー |
パーミッションを付与されるユーザーの |
| 文字列 |
|
2.7.15. GET バケット CORS
バケットに設定された CORS 設定情報を取得します。ユーザーはバケットの所有者である必要があります。または、バケットで READ_ACP
パーミッションが付与されている必要があります。
以下に示すように、cors
サブリソースをバケット要求に追加します。
構文
GET /<bucket>?cors HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
2.7.16. PUT バケット CORS
バケットの CORS 設定を設定します。ユーザーはバケットの所有者である必要があります。または、バケットで READ_ACP
パーミッションが付与されている必要があります。
以下に示すように、cors
サブリソースをバケット要求に追加します。
構文
PUT /<bucket>?cors HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
2.7.17. DELETE バケット CORS
バケットに設定された CORS 設定情報を削除します。ユーザーはバケットの所有者である必要があります。または、バケットで READ_ACP
パーミッションが付与されている必要があります。
以下に示すように、cors
サブリソースをバケット要求に追加します。
構文
DELETE /<bucket>?cors HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
2.7.18. バケットオブジェクトバージョンの一覧表示
バケット内のすべてのバージョンのオブジェクトに関するメタデータの一覧を返します。バケットへの READ アクセスが必要です。
以下のように versions
サブリソースをバケット要求に追加します。
構文
GET /<bucket>?versions HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
GET /<bucket>?versions
のパラメーターを指定できますが、いずれも不要です。
名前 | 型 | 詳細 |
---|---|---|
| 文字列 | 指定の接頭辞が含まれるキーが含まれる進行中のアップロードを返します。 |
| 文字列 | 接頭辞と他のオブジェクト名の間に挿入される区切り文字。 |
| 文字列 | アップロード一覧の最初のマーカー。 |
| 整数 | 進行中のアップロードの最大数。デフォルト値は 1000 です。 |
| 文字列 | リストを開始するオブジェクトバージョンを指定します。 |
名前 | 型 | 詳細 |
---|---|---|
| 文字列 |
|
| 文字列 |
|
| 文字列 |
|
| ブール値 |
|
| 整数 | アップロードした部分のサイズ。 |
| 文字列 | 所有者の表示名。 |
| 文字列 | 所有者の ID。 |
| コンテナー |
オブジェクトを所有するユーザーの |
| 文字列 |
作成されるオブジェクトを保存するために使用されるメソッド。 |
| コンテナー | バージョン情報のコンテナー |
| 文字列 | オブジェクトのバージョン ID。 |
| 文字列 | 省略されたレスポンスのキーの最後のバージョン。 |
2.7.19. バケットマルチパートアップロードの一覧表示
GET /?uploads
は、現在の進行中のマルチパートアップロードの一覧を返します。つまり、アプリケーションは複数パートごとのアップロードを開始しますが、サービスがすべてのアップロードを完了しているわけではありません。
構文
GET /<bucket>?uploads HTTP/1.1
GET /<bucket>?uploads
のパラメーターを指定できますが、いずれも必要ありません。
名前 | 型 | 詳細 |
---|---|---|
| 文字列 | 指定の接頭辞が含まれるキーが含まれる進行中のアップロードを返します。 |
| 文字列 | 接頭辞と他のオブジェクト名の間に挿入される区切り文字。 |
| 文字列 | アップロード一覧の最初のマーカー。 |
| 整数 | 進行中のアップロードの最大数。デフォルト値は 1000 です。 |
| 整数 | マルチパートアップロードの最大数。1-1000 の範囲。デフォルト値は 1000 です。 |
| 文字列 |
|
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | 結果のコンテナー |
| 文字列 |
|
| 文字列 | バケットのコンテンツを受け取るバケット。 |
| 文字列 |
|
| 文字列 |
|
| 文字列 |
|
| 文字列 |
|
| 整数 |
|
| 文字列 |
設定されている場合は、同じ接頭辞を持つオブジェクトが |
| ブール値 |
|
| コンテナー |
|
| 文字列 | マルチパートアップロードが完了した後のオブジェクトのキー。 |
| 文字列 |
マルチパートアップロードを識別する |
| コンテナー |
アップロードを開始したユーザーの |
| 文字列 | イニシエーターの表示名。 |
| 文字列 | イニシエーターの ID。 |
| コンテナー |
アップロードしたオブジェクトを所有するユーザーの |
| 文字列 |
作成されるオブジェクトを保存するために使用されるメソッド。 |
| Date | ユーザーがアップロードを開始した日時。 |
| コンテナー | 複数のオブジェクトに同じ接頭辞が含まれる場合は、この一覧に表示されます。 |
| 文字列 |
|
2.7.20. PUT バケット要求の支払い
requestPayment
サブリソースを使用してバケットの要求支払い設定を設定します。デフォルトでは、バケットの所有者はバケットからのダウンロードに対して支払います。この設定パラメーターにより、バケットの所有者は、ダウンロードを要求するすべてのユーザーが要求に対して要求およびバケットからダウンロードに対して課金されることを指定できます。
以下のように requestPayment
サブリソースをバケット要求に追加します。
構文
PUT /<bucket>?requestPayment HTTP/1.1 Host: cname.domain.com
名前 | 型 | 詳細 |
---|---|---|
| 列挙 | ダウンロードおよびリクエストの費用の課金を指定します。 |
| コンテナー |
|
2.7.21. GET バケットリクエストの支払い
requestPayment
サブリソースを使用してバケットの要求支払い設定を返します。ユーザーはバケットの所有者である必要があります。または、バケットで READ_ACP
パーミッションが付与されている必要があります。
以下のように requestPayment
サブリソースをバケット要求に追加します。
構文
GET /<bucket>?requestPayment HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
2.8. オブジェクト操作
2.8.1. PUT オブジェクト
オブジェクトをバケットに追加します。この操作を実行するには、バケットに書き込みパーミッションが必要です。
構文
PUT /<bucket>/<object> HTTP/1.1
名前 | 説明 | 有効な値 | 必須 |
---|---|---|---|
content-md5 | メッセージの base64 でエンコードされた MD-5 ハッシュ | 文字列。デフォルトや制約はありません。 | No |
content-type | 標準の MIME タイプ。 |
MIME タイプ。デフォルト: | いいえ |
x-amz-meta-<…> | ユーザーのメタデータ。オブジェクトとともに保存されます。 | 8kb までの文字列。デフォルトはありません。 | No |
x-amz-acl | 固定 ACL。 |
| いいえ |
名前 | 説明 |
---|---|
x-amz-version-id | バージョン ID または Null を返します。 |
2.8.2. オブジェクトのコピー
オブジェクトをコピーするには、PUT
を使用して宛先バケットとオブジェクト名を指定します。
構文
PUT /<dest_bucket>/<dest_object> HTTP/1.1 x-amz-copy-source: <source_bucket>/<source_object>
名前 | 説明 | 有効な値 | 必須 |
---|---|---|---|
x-amz-copy-source | ソースバケット名 + オブジェクト名。 | <bucket>/<object> | Yes |
x-amz-acl | 固定 ACL。 |
| いいえ |
x-amz-copy-if-modified-since | タイムスタンプ以降に変更された場合のみコピーします。 | タイムスタンプ | No |
x-amz-copy-if-unmodified-since | タイムスタンプ以降変更されていない場合にのみコピーします。 | タイムスタンプ | No |
x-amz-copy-if-match | オブジェクトの ETag が ETag と一致する場合に限りコピーします。 | エンティティータグ | No |
x-amz-copy-if-none-match | オブジェクトの ETag が一致しない場合にのみコピーします。 | エンティティータグ | No |
名前 | 型 | 説明 |
---|---|---|
CopyObjectResult | コンテナー | レスポンス要素のコンテナー。 |
LastModified | Date | ソースオブジェクトを最後に変更した日付。 |
Etag | 文字列 | 新規オブジェクトの ETag。 |
2.8.3. POST オブジェクト
HTML フォームを使用してオブジェクトをバケットに追加します。この操作を実行するには、バケットに書き込みパーミッションが必要です。
構文
POST /<bucket>/<object> HTTP/1.1
2.8.4. OPTIONS オブジェクト
特定の送信元、HTTP メソッド、およびヘッダーを使用して実際のリクエストを送信できるかどうかを判断するための事前要求です。
構文
OPTIONS /<object> HTTP/1.1
2.8.5. 複数オブジェクトの削除
バケットから複数のオブジェクトを削除します。
構文
POST /<bucket>/<object>?delete HTTP/1.1
2.8.6. オブジェクトの削除
オブジェクトを削除します。含まれるバケットに WRITE パーミッションを設定する必要があります。
オブジェクトを削除します。オブジェクトのバージョン管理が有効なの場合、マーカーが作成されます。
構文
DELETE /<bucket>/<object> HTTP/1.1
バージョン管理が有効な場合にオブジェクトを削除するには、versionId
サブリソースおよび削除するオブジェクトのバージョンを指定する必要があります。
DELETE /<bucket>/<object>?versionId=<versionID> HTTP/1.1
2.8.7. オブジェクトの取得
バケットからオブジェクトを取得します。
構文
GET /<bucket>/<object> HTTP/1.1
versionId
サブリソースを追加して、オブジェクトの特定のバージョンを取得します。
構文
GET /<bucket>/<object>?versionId=<versionID> HTTP/1.1
名前 | 説明 | 有効な値 | 必須 |
---|---|---|---|
範囲 | 取得するオブジェクトの範囲。 | 範囲: bytes=beginbyte-endbyte | No |
if-modified-since | タイムスタンプ以降に変更した場合にのみ取得します。 | タイムスタンプ | No |
if-unmodified-since | タイムスタンプ以降変更されていない場合にのみ取得します。 | タイムスタンプ | No |
if-match | オブジェクトの ETag が ETag と一致する場合にのみ取得します。 | エンティティータグ | No |
if-none-match | オブジェクトの ETag が ETag と一致する場合にのみ取得します。 | エンティティータグ | No |
名前 | 説明 |
---|---|
Content-Range | データ範囲 (範囲ヘッダーフィールドがリクエストに指定された場合のみを返します)。 |
x-amz-version-id | バージョン ID または Null を返します。 |
2.8.8. オブジェクト情報の取得
オブジェクトに関する情報を返します。この要求は Get Object 要求と同じヘッダー情報を返しますが、オブジェクトデータペイロードではなくメタデータのみが含まれます。
オブジェクトの現行バージョンを取得します。
構文
HEAD /<bucket>/<object> HTTP/1.1
versionId
サブリソースを追加して、特定バージョンの情報を取得します。
構文
HEAD /<bucket>/<object>?versionId=<versionID> HTTP/1.1
名前 | 説明 | 有効な値 | 必須 |
---|---|---|---|
範囲 | 取得するオブジェクトの範囲。 | 範囲: bytes=beginbyte-endbyte | No |
if-modified-since | タイムスタンプ以降に変更した場合にのみ取得します。 | タイムスタンプ | No |
if-unmodified-since | タイムスタンプ以降変更されていない場合にのみ取得します。 | タイムスタンプ | No |
if-match | オブジェクトの ETag が ETag と一致する場合にのみ取得します。 | エンティティータグ | No |
if-none-match | オブジェクトの ETag が ETag と一致する場合にのみ取得します。 | エンティティータグ | No |
名前 | 説明 |
---|---|
x-amz-version-id | バージョン ID または Null を返します。 |
2.8.9. Get Object ACL
オブジェクトの現行バージョンの ACL を返します。
構文
GET /<bucket>/<object>?acl HTTP/1.1
versionId
サブリソースを追加して、特定バージョンの ACL を取得します。
構文
GET /<bucket>/<object>versionId=<versionID>&acl HTTP/1.1
名前 | 説明 |
---|---|
x-amz-version-id | バージョン ID または Null を返します。 |
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | レスポンスのコンテナー。 |
| コンテナー | ACL 情報用のコンテナー |
| コンテナー |
オブジェクトの所有者の |
| 文字列 | オブジェクトの所有者の ID。 |
| 文字列 | オブジェクトの所有者の表示名。 |
| コンテナー |
|
| コンテナー |
パーミッションを付与されるユーザーの |
| 文字列 |
|
2.8.10. オブジェクト ACL の設定
オブジェクトの現行バージョンのオブジェクト ACL を設定します。
構文
PUT /<bucket>/<object>?acl
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | レスポンスのコンテナー。 |
| コンテナー | ACL 情報用のコンテナー |
| コンテナー |
オブジェクトの所有者の |
| 文字列 | オブジェクトの所有者の ID。 |
| 文字列 | オブジェクトの所有者の表示名。 |
| コンテナー |
|
| コンテナー |
パーミッションを付与されるユーザーの |
| 文字列 |
|
2.8.11. Initiate Multipart Upload
複数パートからなるアップロードプロセスを開始します。追加部分の追加、パーツの一覧表示、および複数パートアップロードの完了または破棄時に指定できる UploadId
を返します。
構文
POST /<bucket>/<object>?uploads
名前 | 説明 | 有効な値 | 必須 |
---|---|---|---|
| メッセージの base64 でエンコードされた MD-5 ハッシュ | 文字列。デフォルトや制約はありません。 | No |
| 標準の MIME タイプ。 |
MIME タイプ。デフォルト: | いいえ |
| ユーザーのメタデータ。オブジェクトとともに保存されます。 | 8kb までの文字列。デフォルトはありません。 | No |
| 固定 ACL。 |
| いいえ |
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | 結果のコンテナー |
| 文字列 | オブジェクトの内容を受け取るバケット。 |
| 文字列 |
|
| 文字列 |
|
2.8.12. マルチパートアップロードパート
マルチパートアップロードに部分を追加します。
複数パートのアップロードに部分を追加するために uploadId
サブリソースとアップロード ID を指定します。
構文
PUT /<bucket>/<object>?partNumber=&uploadId=<upload_id> HTTP/1.1
以下の HTTP レスポンスが返されます。
HTTP ステータス | ステータスコード | 詳細 |
---|---|---|
| NoSuchUpload | 指定した upload-id がこのオブジェクトで開始されたアップロードと一致しません。 |
2.8.13. List Multipart Upload Parts
マルチパートアップロードの一部を一覧表示するために uploadId
サブリソースとアップロード ID を指定します。
構文
GET /<bucket>/<object>?uploadId=<upload-id> HTTP/1.1
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | 結果のコンテナー |
| 文字列 | オブジェクトの内容を受け取るバケット。 |
| 文字列 |
|
| 文字列 |
|
| コンテナー |
アップロードを開始したユーザーの |
| 文字列 | イニシエーターの ID。 |
| 文字列 | イニシエーターの表示名。 |
| コンテナー |
アップロードしたオブジェクトを所有するユーザーの |
| 文字列 |
作成されるオブジェクトを保存するために使用されるメソッド。 |
| 文字列 |
|
| 文字列 |
|
| 整数 |
|
| ブール値 |
|
| コンテナー |
|
| 整数 | 部分の識別番号。 |
| 文字列 | コンポーネントのエンティティータグです。 |
| 整数 | アップロードした部分のサイズ。 |
2.8.14. complete Multipart Upload
アップロードした部分を組み立て、新規オブジェクトを作成します。これにより、複数パートのアップロードが実行されます。
複数パートからなるアップロードを完了するには、uploadId
サブリソースとアップロード ID を指定します。
構文
POST /<bucket>/<object>?uploadId= HTTP/1.1
名前 | 型 | 説明 | 必須 |
---|---|---|---|
| コンテナー | 1 つ以上の部分で設定されるコンテナー。 | はい |
| コンテナー |
| はい |
| 整数 | 部分の識別子。 | はい |
| 文字列 | コンポーネントのエンティティータグです。 | Yes |
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | レスポンスのコンテナー。 |
| URI | 新規オブジェクトのリソース識別子 (パス)。 |
| 文字列 | 新規オブジェクトが含まれるバケットの名前。 |
| 文字列 | オブジェクトのキー。 |
| 文字列 | 新規オブジェクトのエンティティータグ。 |
2.8.15. Abort Multipart Upload
複数パートアップロードを中止します。
マルチパートによるアップロードを中止するために uploadId
サブリソースとアップロード ID を指定します。
構文
DELETE /<bucket>/<object>?uploadId=<upload_id> HTTP/1.1
2.8.16. Copy Multipart Upload
既存のオブジェクトからデータをデータソースとしてコピーして、パーツをアップロードします。
複数パートからなるアップロードコピーを実行するには、uploadId
サブリソースとアップロード ID を指定します。
構文
PUT /<bucket>/<object>?partNumber=PartNumber&uploadId=UploadId HTTP/1.1 Host: cname.domain.com Authorization: AWS <access_key>:<hash_of_header_and_secret>
名前 | 説明 | 有効な値 | 必須 |
---|---|---|---|
| ソースバケット名およびオブジェクト名。 | <bucket>/<object> | はい |
| ソースオブジェクトからコピーするバイトの範囲。 |
範囲: | いいえ |
名前 | 型 | 詳細 |
---|---|---|
| コンテナー | すべてのレスポンス要素のコンテナー。 |
| 文字列 | 新しい部分の ETag を返します。 |
| 文字列 | 最後に変更した日付を返します。 |
この機能の詳細は、Amazon S3 のサイト を参照してください。
2.9. Hadoop S3A の相互運用性
HDFS (Hadoop Distributed File System) のアクセスを必要とするデータ解析アプリケーションは、Hadoop 用の Apache S3A コネクターを使用して Ceph Object Gateway にアクセスできます。S3A コネクターは、データが Ceph Object Gateway に保存される一方で、HDFS ファイルシステムがアプリケーションへのセマンティクスを読み取りおよび書き込みする S3 互換のオブジェクトストレージを HDFS ファイルシステムとして表示するオープンソースツールです。
Ceph Object Gateway は、Hadoop 2.7.3 に同梱される S3A コネクターと完全に互換性があります。
2.10. S3 の制限
以下の制限事項を使用してください。お使いのハードウェアの選択には影響があるため、この要件を Red Hat アカウントチームと常に相談してください。
-
Amazon S3 を使用する場合の最大オブジェクトサイズ: 個別の Amazon S3 オブジェクトは、最小の 0B から最大 5TB のサイズに制限できます。1 つの
PUT
でアップロードできる最大オブジェクトは 5 GB です。100MB を超えるオブジェクトの場合は、Multipart Upload ケイパビリティーの使用を検討してください。 - Amazon S3 を使用する場合の最大メタデータサイズ: オブジェクトに適用できるユーザーメタデータの合計サイズに定義された制限はありませんが、単一の HTTP リクエストは 16,000 に制限されます。
- S3 オブジェクトおよびメタデータを保存するために Red Hat Ceph Storage が生成するデータオーバーヘッドの量: 推定値は 200-300 バイトとオブジェクト名の長さです。バージョン管理されたオブジェクトは、バージョン数に比例する領域を追加で使用します。また、マルチパートアップロードなどのトランザクション更新中に一時的なオーバーヘッドが発生しますが、これらのオーバーヘッドはガベージコレクション中にリカバリーされます。
第3章 Object Gateway Swift Application Programming Interface (API)
Ceph は、Swift API の基本データアクセスモデルと互換性のある RESTful API をサポートします。
以下の表は、現在の Swift 機能機能のサポート状況を示しています。
機能 | 状態 | 備考 |
---|---|---|
サポート対象 | ||
アカウントメタデータの取得 | サポート対象 | カスタムメタデータなし |
サポート対象 | Swift ACL のサブセットに対応 | |
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
コンテナーメタデータの取得 | サポート対象 | |
サポート対象 | ||
コンテナーメタデータの削除 | サポート対象 | |
サポート対象 | ||
静的な Web サイト | サポート対象外 | |
サポート対象 | ||
サポート対象 | ||
大規模オブジェクトの作成 | サポート対象 | |
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
サポート対象 | ||
オブジェクトの期限設定 | サポート対象 | |
オブジェクトのバージョン管理 | サポート対象外 | |
CORS | サポート対象外 |
3.1. 認証
認証を必要とする Swift API リクエストには、要求ヘッダーに X-Storage-Token
認証トークンが含まれている必要があります。トークンは、Ceph Object Gateway から別のオーセンティケーターから取得できます。Ceph Object Gateway からトークンを取得するには、ユーザーを作成する必要があります。
構文
# radosgw-admin user create --uid="<user_name>" --display-name="<display_name>"
例
# radosgw-admin user create --uid="swift1" --display-name="First Swift User"
3.1.1. authentication GET
ユーザーを認証するには、X-Auth-User
および X-Auth-Key
を含むリクエストを作成します。
構文
GET /auth HTTP/1.1 Host: swift.radosgwhost.com X-Auth-User: johndoe X-Auth-Key: R7UUOLFDI2ZI9PRCQ53K
名前 | 説明 | 型 | 必須 |
---|---|---|---|
| 認証するキーの Ceph Object Gateway のユーザー名。 | 文字列 | はい |
| Ceph Object Gateway のユーザー名に関連付けられたキー。 | 文字列 | はい |
サーバーからのレスポンスには、X-Auth-Token
の値が含まれている必要があります。応答には、API ドキュメント全体で他の要求で指定した < api_version>/<account
> 接頭辞を提供する X-Storage-Url
が含まれる場合があります。
名前 | 説明 | 型 |
---|---|---|
|
要求に指定された | 文字列 |
|
ユーザーの URL および | String |
レスポンスの例
HTTP/1.1 204 No Content Date: Mon, 16 Jul 2012 11:05:33 GMT Server: swift X-Storage-Url: https://swift.radosgwhost.com/v1/ACCT-12345 X-Storage-Token: UOlCCC8TahFKlWuv9DB09TWHF0nDjpPElha0kAa Content-Length: 0 Content-Type: text/plain; charset=UTF-8
3.2. サービス操作
Swift 互換サービスに関するデータを取得するには、認証中に取得した X-Storage-Url
値を使用して GET
要求を実行できます。
3.2.1. コンテナーの一覧表示
API バージョンを指定し、アカウントは特定のユーザーアカウントのコンテナーの一覧を返す GET
リクエスト。リクエストは特定のユーザーのコンテナーを返すため、リクエストには認証トークンが必要です。リクエストは匿名で行われません。
構文
GET /<api_version>/<account> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token>
名前 | 説明 | 型 | 必須 | 有効な値 |
---|---|---|---|---|
| 結果の数を指定の値に制限します。 | 整数 | No | 該当なし |
| 結果の形式を定義します。 | 文字列 | いいえ |
|
| マーカー値よりも大きな結果の一覧を返します。 | 文字列 | No | 該当なし |
レスポンスにはコンテナーの一覧が含まれるか、または HTTP 204 レスポンスコードで返されます。
名前 | 説明 | 型 |
---|---|---|
| アカウント情報の一覧。 | コンテナー |
| コンテナーの一覧。 | コンテナー |
| コンテナーの名前。 | 文字列 |
| コンテナーのサイズ。 | Integer |
3.3. コンテナー操作
コンテナーは、データオブジェクトを格納するメカニズムです。アカウントには多くのコンテナーを持たせることができますが、コンテナー名は一意でなければなりません。この API により、クライアントはコンテナーの作成、アクセス制御およびメタデータの設定、コンテナーのコンテンツの取得、およびコンテナーの削除を行うことができます。この API は特定のユーザーのアカウントの情報に関連するリクエストを行うため、コンテナーのアクセス制御が意図的に公開されていない限り、つまり匿名のリクエストを許可しない限り、この API のすべてのリクエストを認証する必要があります。
Amazon S3 API はバケットという用語を使用してデータコンテナーを記述します。Swift API 内のバケットを参照すると、バケットという用語はコンテナーという用語と同じものになります。
オブジェクトストレージの 1 つは、階層パスやディレクトリーをサポートしないことです。代わりに、各コンテナーにオブジェクトがある 1 つ以上のコンテナーで設定される 1 つのレベルをサポートします。RADOS Gateway の Swift 互換 API は、疑似階層コンテナーの概念をサポートします。これは、オブジェクトの命名を使用してコンテナーをエミュレートする手段で、ストレージシステムで実際には実装されません。たとえば、photos/buildings/empire-state.jpg のように、疑似階層名でオブジェクトに名前を付けることができますが、コンテナー名にスラッシュ (/
) 文字を含めることはできません。
バージョン付けされた Swift コンテナーに大規模なオブジェクトをアップロードする場合は、python-swiftclient
ユーティリティーで --leave-segments
オプションを使用します。--leave-segments
を使用しないと、マニフェストファイルが上書きされます。したがって、既存のオブジェクトは上書きされ、データが失われることになります。
3.3.1. マルチテナントによるコンテナー操作
クライアントアプリケーションがコンテナーにアクセスする場合は、常に特定ユーザーの認証情報で動作します。Red Hat Ceph Storage 3 では、すべてのユーザーがテナントに属します。詳細は 、マルチテナンシー を 参照してください。そのため、テナントが明示的に指定されていない場合、すべてのコンテナー操作のコンテキストに暗黙的なテナントがあります。したがって、マルチテナンシーは、参照されるコンテナーと、参照しているユーザーが同じテナントに属する限り、以前のリリースと完全に後方互換性があります。
明示的なテナントの指定に使用される拡張機能は、使用されるプロトコルおよび認証システムによって異なります。
テナントとコンテナーはコロンで区切ります。したがって、URL は以下のようになります。
例
https://rgw.domain.com/tenant:container
一方、create_container()
メソッドでは、コンテナーメソッド自体でテナントとコンテナーを分離します。
例
create_container("tenant:container")
3.3.2. コンテナーの作成
新規コンテナーを作成するには、API バージョン、アカウント、および新規コンテナーの名前で PUT
要求を行います。コンテナー名は一意である必要があります。スラッシュ ( /) を含めることはできず、256 バイト未満でなければなりません。リクエストには、アクセス制御ヘッダーおよびメタデータヘッダーを含めることができます。また、配置プールのセットのキーを識別するストレージポリシーを含めることもできます。たとえば、radosgw-admin zone get
を実行して、placement_pools
の下に利用可能なキーの一覧を表示することもできます。ストレージポリシーを使用すると、SSD ベースのストレージなど、コンテナーの特別なプールセットを指定できます。操作はべき等です。つまり、すでに存在するコンテナーを作成する要求を行うと、HTTP 202 の戻りコードが返されますが、別のコンテナーは作成されません。
構文
PUT /<api_version>/<account>/<tenant>:<container> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token> X-Container-Read: <comma_separated_uids> X-Container-Write: <comma_separated_uids> X-Container-Meta-<key>: <value> X-Storage-Policy: <placement_pools_key>
名前 | 説明 | 型 | 必須 |
---|---|---|---|
| コンテナーの読み取りパーミッションを持つユーザー ID。 | ユーザー ID のコンマ区切りの文字列値。 | いいえ |
| コンテナーの書き込みパーミッションを持つユーザー ID。 | ユーザー ID のコンマ区切りの文字列値。 | いいえ |
| 任意の文字列の値を取得するユーザー定義のメタデータキー。 | 文字列 | いいえ |
|
Ceph Object Gateway の | 文字列 | No |
同じ名前のコンテナーがすでに存在し、ユーザーがコンテナー所有者である場合、操作は成功します。そうでないと、操作は失敗します。
名前 | 説明 | ステータスコード |
---|---|---|
| コンテナーは、別のユーザーの所有権にすでに存在します。 |
|
3.3.3. コンテナーのオブジェクトの一覧表示
コンテナー内のオブジェクトを一覧表示するには、API バージョン、アカウント、およびコンテナーの名前を使用して GET
リクエストを行います。クエリーパラメーターを指定して完全なリストをフィルターリングしたり、パラメーターを除外してコンテナーに保存されている最初の 10,000 オブジェクト名の一覧を返すこともできます。
構文
GET /<api_version>/<tenant>:<container> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token>
名前 | 説明 | タイプ | 有効な値 | 必須 |
---|---|---|---|---|
| 結果の形式を定義します。 | 文字列 |
| いいえ |
| 結果を、指定した接頭辞で始まるオブジェクトに制限します。 | 文字列 | 該当なし | いいえ |
| マーカー値よりも大きな結果の一覧を返します。 | 文字列 | 該当なし | いいえ |
| 結果の数を指定の値に制限します。 | 整数 | 0 - 10,000 | いいえ |
| 接頭辞と他のオブジェクト名の間に挿入される区切り文字。 | 文字列 | 該当なし | いいえ |
| オブジェクトの擬似階層パス。 | 文字列 | 該当なし | No |
名前 | 説明 | 型 |
---|---|---|
| コンテナー | コンテナー |
| コンテナー内のオブジェクト。 | コンテナー |
| コンテナー内のオブジェクトの名前。 | 文字列 |
| オブジェクトのコンテンツのハッシュコード。 | 文字列 |
| オブジェクトの内容を最後に変更した時間。 | Date |
| オブジェクト内のコンテンツのタイプ。 | String |
3.3.4. コンテナーのアクセス制御リスト(ACL)の更新
ユーザーがコンテナーを作成すると、ユーザーはデフォルトでコンテナーへの読み取り/書き込みアクセスを持ちます。その他のユーザーがコンテナーのコンテンツを読み取りしたり、コンテナーに書き込むことを許可するには、ユーザーを明示的に有効にする必要があります。X-Container-Read
または X-Container-Write
に *
を指定することもできます。これにより、すべてのユーザーがコンテナーから読み取るか、またはコンテナーへの書き込みが可能になります。*
を設定すると、コンテナーが公開されます。これにより、匿名ユーザーがコンテナーから読み込むか、またはコンテナーに書き込むことができます。
構文
POST /<api_version>/<account>/<tenant>:<container> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token> X-Container-Read: * X-Container-Write: <uid1>, <uid2>, <uid3>
名前 | 説明 | 型 | 必須 |
---|---|---|---|
| コンテナーの読み取りパーミッションを持つユーザー ID。 | ユーザー ID のコンマ区切りの文字列値。 | いいえ |
| コンテナーの書き込みパーミッションを持つユーザー ID。 | ユーザー ID のコンマ区切りの文字列値。 | いいえ |
3.3.5. コンテナーメタデータの追加/更新
コンテナーにメタデータを追加するには、API バージョン、アカウント、およびコンテナー名で POST
要求を行います。メタデータを追加または更新するには、コンテナーに対する書き込み権限が必要です。
構文
POST /<api_version>/<account>/<tenant>:<container> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token> X-Container-Meta-Color: red X-Container-Meta-Taste: salty
名前 | 説明 | 型 | 必須 |
---|---|---|---|
| 任意の文字列の値を取得するユーザー定義のメタデータキー。 | 文字列 | いいえ |
3.3.6. コンテナーを削除します。
コンテナーを削除するには、API バージョン、アカウント、およびコンテナーの名前を使用して DELETE
要求を行います。コンテナーは空である必要があります。コンテナーが空であるかを確認する場合は、コンテナーに対して HEAD
リクエストを実行します。コンテナーが正常に削除されると、コンテナー名を再利用できます。
構文
DELETE /<api version>/<account>/<tenant>:<container> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth-token>
名前 | 説明 | ステータスコード |
---|---|---|
| コンテナーが削除されました。 |
|
3.4. オブジェクト操作
オブジェクトは、データおよびメタデータを保存するコンテナーです。コンテナーには多くのオブジェクトがありますが、オブジェクト名は一意である必要があります。この API により、クライアントはオブジェクトの作成、アクセス制御およびメタデータの設定、オブジェクトのデータおよびメタデータの取得、およびオブジェクトの削除を行うことができます。この API は特定のユーザーのアカウントの情報に関連するリクエストを行うため、コンテナーまたはオブジェクトのアクセス制御が意図的に公開されていない限り、この API のすべてのリクエストを認証する必要があります。つまり、匿名要求が許可されます。
3.4.1. オブジェクトの作成/更新
新規オブジェクトを作成するには、API バージョン、アカウント、コンテナー名、および新規オブジェクトの名前を使用して PUT
要求を行います。オブジェクトを作成または更新するには、コンテナーに書き込みパーミッションが必要です。オブジェクト名は、コンテナー内で一意である必要があります。PUT
リクエストはべき等ではないため、一意の名前を使用しないと、リクエストによりオブジェクトが更新されます。ただし、オブジェクト名に疑似階層構文を使用して、別の疑似階層ディレクトリーにある場合は、同じ名前の別のオブジェクトと区別することができます。リクエストには、アクセス制御ヘッダーおよびメタデータヘッダーを含めることができます。
構文
PUT /<api_version>/<account>/<tenant>:<container>/<object> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token>
名前 | 説明 | 型 | 必須 | 有効な値 |
---|---|---|---|---|
| オブジェクトの内容の MD5 ハッシュ。推奨されます。 | 文字列 | No | 該当なし |
| オブジェクトに含まれるコンテンツのタイプ。 | 文字列 | No | 該当なし |
| オブジェクトが大規模な集約オブジェクトの一部であるかどうかを示します。 | 文字列 | いいえ |
|
3.4.2. オブジェクトのコピー
オブジェクトをコピーすると、オブジェクトのサーバー側のコピーを作成し、ダウンロードして別のコンテナー/名前でアップロードする必要はありません。あるオブジェクトのコンテンツを別のオブジェクトにコピーするには、API バージョン、アカウント、およびコンテナー名で PUT
要求または COPY
要求を行います。PUT
要求の場合は、要求で宛先コンテナーおよびオブジェクト名、および要求ヘッダーのソースコンテナーおよびオブジェクトを使用します。Copy
リクエストには、要求でソースコンテナーおよびオブジェクト、および要求ヘッダーの宛先コンテナーおよびオブジェクトを使用します。オブジェクトをコピーするには、コンテナーに書き込みパーミッションが必要です。宛先オブジェクト名は、コンテナー内で一意である必要があります。リクエストはべき等ではないため、一意の名前を使用しないと、リクエストにより宛先オブジェクトが更新されます。ただし、オブジェクト名に疑似階層構文を使用して、宛先オブジェクトが別の擬似階層ディレクトリーにある場合は、同じ名前のソースオブジェクトと区別することができます。リクエストには、アクセス制御ヘッダーおよびメタデータヘッダーを含めることができます。
構文
PUT /<api_version>/<account>/<tenant>:<dest_container>/<dest_object> HTTP/1.1 X-Copy-From: <tenant>:<source_container>/<source_object> Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token>
または、次のようになります。
構文
COPY /<api_version>/<account>/<tenant>:<source_container>/<source_object> HTTP/1.1 Destination: <tenant>:<dest_container>/<dest_object>
名前 | 説明 | 型 | 必須 |
---|---|---|---|
|
ソースコンテナー/オブジェクトパスを定義するために | 文字列 |
はい ( |
|
宛先コンテナー/オブジェクトパスを定義するために | 文字列 |
はい ( |
|
ソースオブジェクトの | Date | いいえ |
|
ソースオブジェクトの | Date | いいえ |
| リクエストの ETag がソースオブジェクトの ETag と一致する場合にのみコピーします。 | ETag. | いいえ |
| リクエストの ETag がソースオブジェクトの ETag と一致しない場合にのみコピーします。 | ETag. | いいえ |
3.4.3. オブジェクトの削除
オブジェクトを削除するには、API バージョン、アカウント、コンテナー、およびオブジェクト名を使用して DELETE
リクエストを行います。コンテナー内のオブジェクトを削除するには、コンテナーに対する書き込み権限が必要です。オブジェクトが正常に削除されると、オブジェクト名を再利用できます。
構文
DELETE /<api_version>/<account>/<tenant>:<container>/<object> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token>
3.4.4. オブジェクトの取得
オブジェクトを取得するには、API バージョン、アカウント、コンテナー、およびオブジェクト名を使用して GET
リクエストを行います。コンテナー内のオブジェクトを取得するには、コンテナーの読み取り権限が必要です。
構文
GET /<api version>/<account>/<tenant>:<container>/<object> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth-token>
名前 | 説明 | 型 | 必須 |
---|---|---|---|
| オブジェクトの内容のサブセットを取得するには、バイト範囲を指定します。 | Date | いいえ |
|
ソースオブジェクトの | Date | いいえ |
|
ソースオブジェクトの | Date | いいえ |
| リクエストの ETag がソースオブジェクトの ETag と一致する場合にのみコピーします。 | ETag. | いいえ |
| リクエストの ETag がソースオブジェクトの ETag と一致しない場合にのみコピーします。 | ETag. | No |
名前 | 説明 |
---|---|
| オブジェクトコンテンツのサブセットの範囲。range ヘッダーフィールドがリクエストで指定されている場合にのみ返されます。 |
3.4.5. オブジェクトメタデータの取得
オブジェクトのメタデータを取得するには、API バージョン、アカウント、コンテナー、およびオブジェクト名を使用して HEAD
リクエストを行います。コンテナー内のオブジェクトからメタデータを取得するには、コンテナーの読み取り権限が必要です。このリクエストは、オブジェクト自体の要求と同じヘッダー情報を返しますが、オブジェクトのデータを返しません。
構文
HEAD /<api_version>/<account>/<tenant>:<container>/<object> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token>
3.4.6. オブジェクトメタデータの追加/更新
オブジェクトにメタデータを追加するには、API バージョン、アカウント、コンテナー、およびオブジェクト名で POST
リクエストを行います。メタデータを追加または更新するには、親コンテナーに対する書き込み権限が必要です。
構文
POST /<api_version>/<account>/<tenant>:<container>/<object> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token>
名前 | 説明 | 型 | 必須 |
---|---|---|---|
| 任意の文字列の値を取得するユーザー定義のメタデータキー。 | 文字列 | いいえ |
3.5. 一時 URL 操作
GET リクエストなど、認証情報を共有せずにオブジェクトへの一時的なアクセスを許可するには、radosgw
の swift エンドポイントにより temp url 機能がサポートされます。この機能には、最初に X-Account-Meta-Temp-URL-Key
の値を設定し、必要に応じて X-Account-Meta-Temp-URL-Key-2
を設定する必要があります。Temp URL 機能は、これらの秘密鍵に対する HMAC-SHA1 署名に依存します。
3.5.1. POST Temp-URL キー
必要なキーを持つ swift アカウントへの POST
リクエストは、一時 URL アクセスをアカウントに提供できるアカウントのシークレット一時 URL キーを設定します。最大 2 つのキーがサポートされ、存在する場合は両方のキーに対して署名がチェックされるため、一時 URL を無効にせずにキーをローテーションできます。
構文
POST /<api_version>/<account> HTTP/1.1 Host: <Fully_Qualified_Domain_Name> X-Auth-Token: <auth_token>
名前 | 説明 | 型 | 必須 |
---|---|---|---|
| 任意の文字列値を取るユーザー定義のキー。 | 文字列 | はい |
| 任意の文字列値を取るユーザー定義のキー。 | 文字列 | いいえ |
3.5.2. GET Temp-URL オブジェクト
一時 URL は、以下の要素を含む暗号化 HMAC-SHA1 署名を使用します。
- Request メソッドの値 (例:GET)
- エポックからの経過時間 (秒単位)。つまり Unix 時間です。
- v1 以降のリクエストパス
上記の項目は、それらの間に新しい行が追加されて正規化され、HMAC は前述の Temp URL キーのいずれかに対して SHA-1 ハッシュアルゴリズムを使用して生成されます。
上記を示すサンプルの Python スクリプトを以下に示します。
例
import hmac from hashlib import sha1 from time import time method = 'GET' host = 'https://objectstore.example.com' duration_in_seconds = 300 # Duration for which the url is valid expires = int(time() + duration_in_seconds) path = '/v1/your-bucket/your-object' key = 'secret' hmac_body = '%s\n%s\n%s' % (method, expires, path) hmac_body = hmac.new(key, hmac_body, sha1).hexdigest() sig = hmac.new(key, hmac_body, sha1).hexdigest() rest_uri = "{host}{path}?temp_url_sig={sig}&temp_url_expires={expires}".format( host=host, path=path, sig=sig, expires=expires) print rest_uri
出力例
https://objectstore.example.com/v1/your-bucket/your-object?temp_url_sig=ff4657876227fc6025f04fcf1e82818266d022c6&temp_url_expires=1423200992
3.6. Swift API の制限
以下の制限事項を使用してください。お使いのハードウェアの選択には影響があるため、この要件を Red Hat アカウントチームと常に相談してください。
- Swift API を使用する場合の最大オブジェクトサイズ: 5GB
- Swift API を使用する場合のメタデータの最大サイズ: オブジェクトに適用できるユーザーメタデータの合計サイズに定義された制限はありませんが、単一の HTTP 要求は 16,000 に制限されます。