サポートコンソール開発者トライアルの開始お問い合わせ

3.4. S3 オブジェクト操作

開発者は、Ceph Object Gateway 経由で Amazon S3 アプリケーションプログラミングインターフェイス (API) を使用してオブジェクト操作を行うことができます。

以下の表は、関数のサポートステータスとともに、オブジェクトの Amazon S3 の機能操作を示しています。

表3.3 オブジェクト操作
機能状態

Get Object

サポート対象

Get Object Information

サポート対象

Put Object Lock

サポート対象

Get Object Lock

サポート対象

Put Object Legal Hold

サポート対象

Get Object Legal Hold

サポート対象

Put Object Retention

サポート対象

Get Object Retention

サポート対象

Put Object Tagging

サポート対象

Get Object Tagging

サポート対象

Delete Object Tagging

サポート対象

Put Object

サポート対象

Delete Object

サポート対象

Delete Multiple Objects

サポート対象

Get Object ACLs

サポート対象

Put Object ACLs

サポート対象

Copy Object

サポート対象

Post Object

サポート対象

Options Object

サポート対象

Initiate Multipart Upload

サポート対象

Add a Part to a Multipart Upload

サポート対象

List Parts of a Multipart Upload

サポート対象

Assemble Multipart Upload

サポート対象

Copy Multipart Upload

サポート対象

Abort Multipart Upload

サポート対象

マルチテナンシー

サポート対象

前提条件

  • 稼働中の Red Hat Ceph Storage クラスターがある。
  • RESTful クライアント。

3.4.1. S3 get an object from a bucket

バケットからオブジェクトを取得します。

構文

GET /BUCKET/OBJECT HTTP/1.1

versionId サブリソースを追加して、オブジェクトの特定のバージョンを取得します。

構文

GET /BUCKET/OBJECT?versionId=VERSION_ID HTTP/1.1

リクエストヘッダー

partNumber
説明
読み取られるオブジェクトのパーツ番号。これにより、指定した部分に対する範囲指定の GET リクエストが有効になります。このリクエストは、オブジェクトの一部だけをダウンロードする場合に便利です。
有効な値
1 から 10,000 までの正の整数。
必須
いいえ
range
説明

取得するオブジェクトの範囲。

注記

各 GET リクエストで複数のデータ範囲を指定することはサポートされていません。

有効な値
範囲: bytes=beginbyte-endbyte
必須
いいえ
if-modified-since
説明
タイムスタンプ以降に変更した場合にのみ取得します。
有効な値
Timestamp
必須
いいえ
if-unmodified-since
説明
タイムスタンプ以降変更されていない場合にのみ取得します。
有効な値
Timestamp
必須
いいえ
if-match
説明
オブジェクトの ETag が ETag と一致する場合にのみ取得します。
有効な値
エンティティータグ
必須
いいえ
if-none-match
説明
オブジェクトの ETag が ETag と一致しない場合にのみ取得します。
有効な値
エンティティータグ
必須
いいえ

リクエストヘッダーを含む構文

GET /BUCKET/OBJECT?partNumber=PARTNUMBER&versionId=VersionId HTTP/1.1
Host: Bucket.s3.amazonaws.com
If-Match: IfMatch
If-Modified-Since: IfModifiedSince
If-None-Match: IfNoneMatch
If-Unmodified-Since: IfUnmodifiedSince
Range: Range

レスポンスヘッダー

Content-Range
説明
データ範囲 (範囲ヘッダーフィールドがリクエストに指定された場合のみを返します)。
x-amz-version-id
説明
バージョン ID または Null を返します。

3.4.2. S3 get information on an object

オブジェクトに関する情報を返します。この要求は Get Object 要求と同じヘッダー情報を返しますが、オブジェクトデータペイロードではなくメタデータのみが含まれます。

オブジェクトの現行バージョンを取得します。

構文

HEAD /BUCKET/OBJECT HTTP/1.1

versionId サブリソースを追加して、特定バージョンの情報を取得します。

構文

HEAD /BUCKET/OBJECT?versionId=VERSION_ID HTTP/1.1

リクエストヘッダー

range
説明
取得するオブジェクトの範囲。
有効な値
範囲: bytes=beginbyte-endbyte
必須
いいえ
if-modified-since
説明
タイムスタンプ以降に変更した場合にのみ取得します。
有効な値
Timestamp
必須
いいえ
if-match
説明
オブジェクトの ETag が ETag と一致する場合にのみ取得します。
有効な値
エンティティータグ
必須
いいえ
if-none-match
説明
オブジェクトの ETag が ETag と一致する場合にのみ取得します。
有効な値
エンティティータグ
必須
いいえ

レスポンスヘッダー

x-amz-version-id
説明
バージョン ID または Null を返します。

3.4.3. S3 put object lock

put object lock API は、選択したバケットにロック設定を配置します。オブジェクトロックを使用すると、Write-Once-Read-Many (WORM) モデルを使用してオブジェクトを格納できます。オブジェクトロックは、オブジェクトが一定期間または無期限に削除または上書きされないようにします。Object Lock 設定に指定されるルールは、デフォルトで選択されるバケットにあるすべての新規オブジェクトに適用されます。

重要

バケットを作成するときにオブジェクトロックを有効にします。有効にしないと、操作が失敗します。

構文

PUT /BUCKET?object-lock HTTP/1.1

例

PUT /testbucket?object-lock HTTP/1.1

リクエストエンティティー

ObjectLockConfiguration
説明
要求のコンテナー。
型
コンテナー
必須
はい
ObjectLockEnabled
説明
このバケットにオブジェクトロック設定が有効になっているかどうかを示します。
型
String
必須
はい
ルール
説明
指定されたバケットの位置にあるオブジェクトロックルール。
型
コンテナー
必須
いいえ
DefaultRetention
説明
指定されたバケットに設定される新規オブジェクトに適用されるデフォルトの保持期間。
型
コンテナー
必須
いいえ
方式
説明
デフォルトのオブジェクトのロック保持モード。有効な値は GOVERNANCE/COMPLIANCE です。
型
コンテナー
必須
はい
Days
説明
デフォルトの保持期間に指定される日数。
型
Integer
必須
いいえ
Years
説明
デフォルトの保持期間に指定されるの年数。
型
Integer
必須
いいえ

HTTP レスポンス

400
ステータスコード
MalformedXML
説明
XML は適していません。
409
ステータスコード
InvalidBucketState
説明
バケットオブジェクトのロックが有効になっていません。

関連情報

  • この API 呼び出しの詳細は、S3 API を参照してください。

3.4.4. S3 get object lock

get object lock API は、バケットのロック設定を取得します。

構文

GET /BUCKET?object-lock HTTP/1.1

例

GET /testbucket?object-lock HTTP/1.1

レスポンスエンティティー

ObjectLockConfiguration
説明
要求のコンテナー。
型
コンテナー
必須
はい
ObjectLockEnabled
説明
このバケットにオブジェクトロック設定が有効になっているかどうかを示します。
型
String
必須
はい
ルール
説明
指定されたバケットの位置に、オブジェクトロックルールがあります。
型
コンテナー
必須
いいえ
DefaultRetention
説明
指定されたバケットに設定される新規オブジェクトに適用されるデフォルトの保持期間。
型
コンテナー
必須
いいえ
方式
説明
デフォルトのオブジェクトのロック保持モード。有効な値は GOVERNANCE/COMPLIANCE です。
型
コンテナー
必須
はい
Days
説明
デフォルトの保持期間に指定される日数。
型
Integer
必須
いいえ
Years
説明
デフォルトの保持期間に指定されるの年数。
型
Integer
必須
いいえ

関連情報

  • この API 呼び出しの詳細は、S3 API を参照してください。

3.4.7. S3 put object retention

put object retention API は、オブジェクトの保持設定をオブジェクトに配置します。保持期間は、オブジェクトのバージョンを一定時間保護します。GOVERNANCE と COMPLIANCE の 2 つのモードがあります。これら 2 つの保持モードは、オブジェクトに対して異なる保護レベルを適用します。

注記

この期間中、オブジェクトは Write-Once-Read-Many 保護 (WORM 保護) され、上書きも削除もできません。

構文

PUT /BUCKET/OBJECT?retention&versionId= HTTP/1.1

例

PUT /testbucket/testobject?retention&versionId= HTTP/1.1

versionId サブリソースは、オブジェクトの特定のバージョンを取得します。

リクエストエンティティー

Retention
説明
要求のコンテナー。
型
コンテナー
必須
はい
方式
説明
指定されたオブジェクトの保持モード。有効な値は GOVERNANCE、COMPLIANCE です。
型
String
必須
はい
RetainUntilDate
説明
保持日。
形式
2020-01-05T00:00:00.000Z
型
Timestamp
必須
はい

関連情報

  • この API 呼び出しの詳細は、S3 API を参照してください。

3.4.8. S3 get object retention

get object retention API は、オブジェクト上でオブジェクトの保持設定を取得します。

構文

GET /BUCKET/OBJECT?retention&versionId= HTTP/1.1

例 

GET /testbucket/testobject?retention&versionId= HTTP/1.1

versionId サブリソースは、オブジェクトの特定のバージョンを取得します。

レスポンスエンティティー

Retention
説明
要求のコンテナー。
型
コンテナー
必須
はい
方式
説明
指定されたオブジェクトの保持モード。有効な値は GOVERNANCE/COMPLIANCE です。
型
String
必須
はい
RetainUntilDate
説明
保持日。形式: 2020-01-05T00:00:00.000Z
型
Timestamp
必須
はい

関連情報

  • この API 呼び出しの詳細は、S3 API を参照してください。

3.4.9. S3 put object tagging

put object tagging API は、タグをオブジェクトに関連付けます。タグはキーと値のペアです。他のバージョンのタグを配置するには、versionId クエリーパラメーターを使用します。s3:PutObjectTagging アクションを実行するパーミッションが必要です。デフォルトでは、バケットの所有者はこのパーミッションを持ち、このパーミッションを他のユーザーに付与できます。

構文

PUT /BUCKET/OBJECT?tagging&versionId= HTTP/1.1

例

PUT /testbucket/testobject?tagging&versionId= HTTP/1.1

リクエストエンティティー

タグ付け
説明
要求のコンテナー。
型
コンテナー
必須
はい
TagSet
説明
タグのセットのコレクションです。
型
String
必須
はい

関連情報

  • この API 呼び出しの詳細は、S3 API を参照してください。

3.4.10. S3 get object tagging

get object tagging API は、オブジェクトのタグを返します。デフォルトでは、GET 操作はオブジェクトの現行バージョンについての情報を返します。

注記

バージョン付けされたバケットの場合は、バケットに複数のバージョンのオブジェクトを使用できます。他のバージョンのタグを取得するには、要求に versionId クエリーパラメーターを追加します。

構文

GET /BUCKET/OBJECT?tagging&versionId= HTTP/1.1

例

GET /testbucket/testobject?tagging&versionId= HTTP/1.1

関連情報

  • この API 呼び出しの詳細は、S3 API を参照してください。

3.4.11. S3 delete object tagging

delete object tagging API は、指定されたオブジェクトから設定されたタグ全体を削除します。この操作を使用するには、s3:DeleteObjectTagging アクションを実行するパーミッションが必要です。

注記

特定のオブジェクトバージョンのタグを削除するには、リクエストに versionId クエリーパラメーターを追加します。

構文

DELETE /BUCKET/OBJECT?tagging&versionId= HTTP/1.1

例

DELETE /testbucket/testobject?tagging&versionId= HTTP/1.1

関連情報

  • この API 呼び出しの詳細は、S3 API を参照してください。

3.4.12. S3 add an object to a bucket

オブジェクトをバケットに追加します。この操作を実行するには、バケットに書き込みパーミッションが必要です。

構文

PUT /BUCKET/OBJECT HTTP/1.1

リクエストヘッダー

content-md5
説明
メッセージの base64 でエンコードされた MD-5 ハッシュ
有効な値
文字列。デフォルトや制約はありません。
必須
いいえ
content-type
説明
標準の MIME タイプ。
有効な値
MIME タイプ。デフォルト: binary/octet-stream
必須
いいえ
x-amz-meta-<…​>*
説明
ユーザーのメタデータ。オブジェクトとともに保存されます。
有効な値
8kb までの文字列。デフォルトはありません。
必須
いいえ
x-amz-acl
説明
固定 ACL。
有効な値
private、public-read、public-read-write、authenticated-read
必須
いいえ

レスポンスヘッダー

x-amz-version-id
説明
バージョン ID または Null を返します。

3.4.13. S3 delete an object

オブジェクトを削除します。含まれるバケットに WRITE パーミッションを設定する必要があります。

オブジェクトを削除します。オブジェクトのバージョン管理が有効なの場合、マーカーが作成されます。

構文

DELETE /BUCKET/OBJECT HTTP/1.1

バージョン管理が有効な場合にオブジェクトを削除するには、versionId サブリソースおよび削除するオブジェクトのバージョンを指定する必要があります。 

DELETE /BUCKET/OBJECT?versionId=VERSION_ID HTTP/1.1

3.4.14. S3 delete multiple objects

この API 呼び出しは、バケットから複数のオブジェクトを削除します。

構文

POST /BUCKET/OBJECT?delete HTTP/1.1

3.4.15. S3 get an object's Access Control List (ACL)

オブジェクトの現行バージョンの ACL を返します。

構文

GET /BUCKET/OBJECT?acl HTTP/1.1

versionId サブリソースを追加して、特定バージョンの ACL を取得します。

構文

GET /BUCKET/OBJECT?versionId=VERSION_ID&acl HTTP/1.1

レスポンスヘッダー

x-amz-version-id
説明
バージョン ID または Null を返します。

レスポンスエンティティー

AccessControlPolicy
説明
応答のコンテナー。
型
コンテナー
AccessControlList
説明
ACL 情報用のコンテナー
型
コンテナー
Owner
説明
バケット所有者の ID および DisplayName のコンテナー。
型
コンテナー
ID
説明
バケット所有者の ID。
型
String
DisplayName
説明
バケットの所有者の表示名。
型
String
Grant
説明
Grantee および Permission のコンテナー。
型
コンテナー
Grantee
説明
パーミッションを付与されるユーザーの DisplayName および ID のコンテナー。
型
コンテナー
パーミッション
説明
Grantee バケットに指定されるパーミッション。
型
String

3.4.16. S3 set an object's Access Control List (ACL)

オブジェクトの現行バージョンのオブジェクト ACL を設定します。

構文

PUT /BUCKET/OBJECT?acl

リクエストエンティティー

AccessControlPolicy
説明
応答のコンテナー。
型
コンテナー
AccessControlList
説明
ACL 情報用のコンテナー
型
コンテナー
Owner
説明
バケット所有者の ID および DisplayName のコンテナー。
型
コンテナー
ID
説明
バケット所有者の ID。
型
String
DisplayName
説明
バケットの所有者の表示名。
型
String
Grant
説明
Grantee および Permission のコンテナー。
型
コンテナー
Grantee
説明
パーミッションを付与されるユーザーの DisplayName および ID のコンテナー。
型
コンテナー
パーミッション
説明
Grantee バケットに指定されるパーミッション。
型
String

3.4.17. S3 copy an object

オブジェクトをコピーするには、PUT を使用して宛先バケットとオブジェクト名を指定します。

構文

PUT /DEST_BUCKET/DEST_OBJECT HTTP/1.1
x-amz-copy-source: SOURCE_BUCKET/SOURCE_OBJECT

リクエストヘッダー

x-amz-copy-source
説明
ソースバケット名 + オブジェクト名。
有効な値
BUCKET/OBJECT
必須
はい
x-amz-acl
説明
固定 ACL。
有効な値
private、public-read、public-read-write、authenticated-read
必須
いいえ
x-amz-copy-if-modified-since
説明
タイムスタンプ以降に変更された場合のみコピーします。
有効な値
Timestamp
必須
いいえ
x-amz-copy-if-unmodified-since
説明
タイムスタンプ以降変更されていない場合にのみコピーします。
有効な値
Timestamp
必須
いいえ
x-amz-copy-if-match
説明
オブジェクトの ETag が ETag と一致する場合に限りコピーします。
有効な値
エンティティータグ
必須
いいえ
x-amz-copy-if-none-match
説明
オブジェクトの ETag が ETag と一致する場合に限りコピーします。
有効な値
エンティティータグ
必須
いいえ

レスポンスエンティティー

CopyObjectResult
説明
レスポンス要素のコンテナー。
型
コンテナー
LastModified
説明
ソースオブジェクトを最後に変更した日付。
型
日付
Etag
説明
新規オブジェクトの ETag。
型
String

3.4.18. S3 add an object to a bucket using HTML forms

HTML フォームを使用してオブジェクトをバケットに追加します。この操作を実行するには、バケットに書き込みパーミッションが必要です。

構文

POST /BUCKET/OBJECT HTTP/1.1

3.4.19. S3 determine options for a request

特定の送信元、HTTP メソッド、およびヘッダーを使用して実際のリクエストを送信できるかどうかを判断するための事前要求です。

構文

OPTIONS /OBJECT HTTP/1.1

3.4.20. S3 initiate a multipart upload

複数パートからなるアップロードプロセスを開始します。追加部分の追加、パーツのリスト表示、および複数パートアップロードの完了または破棄時に指定できる UploadId を返します。

構文

POST /BUCKET/OBJECT?uploads

リクエストヘッダー

content-md5
説明
メッセージの base64 でエンコードされた MD-5 ハッシュ
有効な値
文字列。デフォルトや制約はありません。
必須
いいえ
content-type
説明
標準の MIME タイプ。
有効な値
MIME タイプ。デフォルト: binary/octet-stream
必須
いいえ
x-amz-meta-<…​>
説明
ユーザーのメタデータ。オブジェクトとともに保存されます。
有効な値
8kb までの文字列。デフォルトはありません。
必須
いいえ
x-amz-acl
説明
固定 ACL。
有効な値
private、public-read、public-read-write、authenticated-read
必須
いいえ

レスポンスエンティティー

InitiatedMultipartUploadsResult
説明
結果のコンテナー
型
コンテナー
Bucket
説明
オブジェクトの内容を受け取るバケット。
型
String
キー
説明
key リクエストパラメーターで指定されるキー (存在する場合)。
型
String
UploadId
説明
upload-id 要求パラメーターで指定される ID で、マルチパートアップロードを特定します (存在する場合)。
型
String

3.4.21. S3 add a part to a multipart upload

マルチパートアップロードに部分を追加します。

複数パートのアップロードに部分を追加するために uploadId サブリソースとアップロード ID を指定します。

構文

PUT /BUCKET/OBJECT?partNumber=&uploadId=UPLOAD_ID HTTP/1.1

以下の HTTP レスポンスが返されます。

HTTP レスポンス

404
ステータスコード
NoSuchUpload
説明
指定した upload-id がこのオブジェクトで開始されたアップロードと一致しません。

3.4.22. S3 list the parts of a multipart upload

マルチパートアップロードの一部をリスト表示するために uploadId サブリソースとアップロード ID を指定します。

構文

GET /BUCKET/OBJECT?uploadId=UPLOAD_ID HTTP/1.1

レスポンスエンティティー

InitiatedMultipartUploadsResult
説明
結果のコンテナー
型
コンテナー
Bucket
説明
オブジェクトの内容を受け取るバケット。
型
String
キー
説明
key リクエストパラメーターで指定されるキー (存在する場合)。
型
String
UploadId
説明
upload-id 要求パラメーターで指定される ID で、マルチパートアップロードを特定します (存在する場合)。
型
String
イニシエーター
説明
アップロードを開始したユーザーの ID と DisplayName が含まれます。
型
コンテナー
ID
説明
イニシエーターの ID。
型
String
DisplayName
説明
イニシエーターの表示名。
型
String
Owner
説明
アップロードしたオブジェクトを所有するユーザーの ID および DisplayName のコンテナー。
型
コンテナー
StorageClass
説明
作成されるオブジェクトを保存するために使用されるメソッド。STANDARD または REDUCED_REDUNDANCY
型
String
PartNumberMarker
説明
IsTruncated が true の場合に後続のリクエストで使用する部分マーカー。リストの先頭に指定します。
型
String
NextPartNumberMarker
説明
IsTruncated が true の場合は、後続のリクエストで使用する次の部分マーカー。リストの末尾。
型
String
IsTruncated
説明
true の場合は、オブジェクトのアップロードコンテンツのサブセットのみが返されます。
型
Boolean
部分
説明
Key、Part、InitiatorOwner、StorageClass、および Initiated 要素のコンテナー。
型
コンテナー
PartNumber
説明
Key、Part、InitiatorOwner、StorageClass、および Initiated 要素のコンテナー。
型
Integer
ETag
説明
コンポーネントのエンティティータグです。
型
String
Size
説明
アップロードした部分のサイズ。
型
Integer

3.4.23. S3 assemble the uploaded parts

アップロードした部分を組み立て、新規オブジェクトを作成します。これにより、複数パートのアップロードが実行されます。

複数パートからなるアップロードを完了するには、uploadId サブリソースとアップロード ID を指定します。

構文

POST /BUCKET/OBJECT?uploadId=UPLOAD_ID HTTP/1.1

リクエストエンティティー

CompleteMultipartUpload
説明
1 つ以上の部分で構成されるコンテナー。
型
コンテナー
必須
はい
部分
説明
PartNumber および ETag のコンテナー。
型
コンテナー
必須
はい
PartNumber
説明
部分の識別子。
型
Integer
必須
はい
ETag
説明
コンポーネントのエンティティータグです。
型
String
必須
はい

レスポンスエンティティー

CompleteMultipartUploadResult
説明
応答のコンテナー。
型
コンテナー
場所
説明
新規オブジェクトのリソース識別子 (パス)。
型
URI
bucket
説明
新規オブジェクトが含まれるバケットの名前。
型
String
キー
説明
オブジェクトのキー。
型
String
ETag
説明
新規オブジェクトのエンティティータグ。
型
String

3.4.24. S3 copy a multipart upload

既存のオブジェクトからデータをデータソースとしてコピーして、パーツをアップロードします。

複数パートからなるアップロードコピーを実行するには、uploadId サブリソースとアップロード ID を指定します。

構文

PUT /BUCKET/OBJECT?partNumber=PartNumber&uploadId=UPLOAD_ID HTTP/1.1
Host: cname.domain.com

Authorization: AWS ACCESS_KEY:HASH_OF_HEADER_AND_SECRET

リクエストヘッダー

x-amz-copy-source
説明
ソースバケット名およびオブジェクト名。
有効な値
BUCKET/OBJECT
必須
はい
x-amz-copy-source-range
説明
ソースオブジェクトからコピーするバイトの範囲。
有効な値
範囲: bytes=first-last (ここで、最初のおよび最後は、コピーするゼロベースのバイトオフセットです)たとえば、bytes=0-9 は、ソースの最初の 10 バイトをコピーすることを示しています。
必須
いいえ

レスポンスエンティティー

CopyPartResult
説明
すべてのレスポンス要素のコンテナー。
型
コンテナー
ETag
説明
新しい部分の ETag を返します。
型
String
LastModified
説明
最後に変更した日付を返します。
型
String

関連情報

3.4.25. S3 abort a multipart upload

複数パートアップロードを中止します。

マルチパートによるアップロードを中止するために uploadId サブリソースとアップロード ID を指定します。

構文

DELETE /BUCKET/OBJECT?uploadId=UPLOAD_ID HTTP/1.1

3.4.26. S3 Hadoop interoperability

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 コネクターと完全に互換性があります。

関連情報

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.