2.16. バケット通知

ストレージ管理者は、これらの API を使用してバケット通知メカニズムの設定および制御インターフェイスを提供できます。API トピックは、特定のエンドポイントの定義が含まれる名前が付けられたオブジェクトです。バケット通知では、トピックを特定のバケットに関連付けます。S3 バケット操作 セクションでは、バケット通知の詳細が表示されます。

注記

すべてのトピックアクションでは、パラメーターは URL エンコードされ、application/x-www-form-urlencoded コンテンツタイプを使用してメッセージのボディーで送信されます。

注記

トピックの更新を有効にするには、トピックにすでに関連付けられているバケット通知を再作成する必要があります。

2.16.1. 前提条件

Ceph Object Gateway 上にバケット通知を作成します。

2.16.2. バケット通知の概要

バケット通知により、バケットで特定のイベントが発生した場合に、Ceph Object Gateway から情報を送る方法が提供されます。バケット通知は HTTP、AMQP0.9.1、および Kafka エンドポイントに送信できます。特定バケットおよび特定のトピック上のイベントのバケット通知を送信するために、通知エントリーを作成する必要があります。バケット通知は、イベントタイプのサブセットに作成することも、デフォルトですべてのイベントタイプに対して作成できます。バケット通知は、キーの接頭辞または接尾辞、キーに一致する正規表現、オブジェクトに割り当てられたメタデータ属性、またはオブジェクトタグに基づいてイベントをフィルタリングできます。バケット通知には、バケット通知メカニズムの設定および制御インターフェイスを提供する REST API があります。

2.16.3. 永続通知

永続的な通知により、Ceph ObjectGateway からトピックで設定されたエンドポイントへの通知の信頼性の高い非同期配信が可能になります。エンドポイントへの配信は、リクエスト中に同期的に実行されるため、通常の通知も信頼性があります。永続的な通知により、Ceph Object Gateway はエンドポイントがダウンした場合や、操作中にネットワークの問題がある場合でも、通知は送信を再試行します。これは、エンドポイントに正常に配信されない場合に通知が再試行されます。通知は、通知操作に関連するその他のアクションがすべて成功する場合にのみ送信されます。エンドポイントが長期間ダウンすると、通知キューがいっぱいになり、これらのエンドポイントの通知が設定された S3 操作が失敗します。

注記

kafka-ack-level=none を使用すると、メッセージの失敗が示されないため、ブローカーが停止している間に送信されたメッセージは、ブローカーの再起動時に再試行されません。ブローカーがもう一度開始されると、新しい通知のみが表示されます。

2.16.4. トピックの作成

バケット通知を作成する前に、トピックを作成できます。トピックは Simple Notification Service (SNS) エンティティーで、すべてのトピック操作 (つまり create、delete、list、および get) は SNS 操作です。トピックには、バケット通知の作成時に使用されるエンドポイントパラメーターが必要です。リクエストが正常に行われると、レスポンスには、バケット通知要求でこのトピックを参照するために後で使用できるトピックの Amazon Resource Name (ARN) が含まれます。

注記

topic_arn はバケット通知設定を提供し、トピックの作成後に生成されます。

前提条件

稼働中の Red Hat Ceph Storage クラスターがある。
ルートレベルのアクセス。
Ceph Object Gateway のインストール
ユーザーアクセスキーおよびシークレットキー。
エンドポイントパラメーター。

手順

以下の要求形式でトピックを作成します。
構文
```
POST
Action=CreateTopic
&Name=TOPIC_NAME
[&Attributes.entry.1.key=amqp-exchange&Attributes.entry.1.value=EXCHANGE]
[&Attributes.entry.2.key=amqp-ack-level&Attributes.entry.2.value=none|broker|routable]
[&Attributes.entry.3.key=verify-ssl&Attributes.entry.3.value=true|false]
[&Attributes.entry.4.key=kafka-ack-level&Attributes.entry.4.value=none|broker]
[&Attributes.entry.5.key=use-ssl&Attributes.entry.5.value=true|false]
[&Attributes.entry.6.key=ca-location&Attributes.entry.6.value=FILE_PATH]
[&Attributes.entry.7.key=OpaqueData&Attributes.entry.7.value=OPAQUE_DATA]
[&Attributes.entry.8.key=push-endpoint&Attributes.entry.8.value=ENDPOINT]
[&Attributes.entry.9.key=persistent&Attributes.entry.9.value=true|false]
```
リクエストパラメーターを以下に示します。
- Endpoint: 通知を送信するエンドポイントの URL。
- OpaqueData: 不透明なデータはトピック設定で設定され、トピックによって発生するすべての通知に追加されます。
- persistent: このエンドポイントへの通知が永続的 (非同期) であるかを示します。デフォルト値は false です。
- HTTP エンドポイント:
  - URL: https://FQDN:PORT
  - ポートのデフォルト: HTTP または HTTPS にそれぞれ 80 または 443 を使用します。
  - verify-ssl: サーバー証明書がクライアントによって検証されているかどうかを示します。デフォルトでは true です。
- AMQP0.9.1 エンドポイント:
  - URL: amqp://USER:PASSWORD@FQDN:PORT[/VHOST].
  - ユーザーおよびグループのデフォルト値はそれぞれ guest と guest です。
  - ユーザーおよびパスワードの詳細は HTTPS 経由で提供する必要があります。そうしないと、トピック作成要求は拒否されます。
  - Port のデフォルト値 は 5672 です。
  - vhost のデフォルトは/です。
  - amqp-exchange: 交換は存在し、トピックに基づいてメッセージをルーティングできる必要があります。これは AMQP0.9.1 の必須パラメーターです。同じエンドポイントを参照するさまざまなトピックが同じ交換を使用する必要があります。
  - amqp-ack-level: 最終宛先に送信される前にメッセージがブローカーで永続化される可能性があるため、終了確認は不要です。承認メソッドは 3 つあります。
    none: ブローカーに送信された場合にメッセージが 配信されている と見なされます。
    broker: デフォルトでは、メッセージはブローカーによって確認応答されると 配信されている と見なされます。
    routable: ブローカーがコンシューマーにルーティングできる場合、メッセージは 配信されている と見なされます。
    注記
    特定のパラメーターのキーと値は、同じ行または特定の順序で存在する必要はありませんが、同じインデックスを使用する必要があります。属性インデックスは、特定の値から順番にしたり、開始したりする必要はありません。
    注記
    topic-name は AMQP トピックに使用されます。
- Kafka エンドポイント:
  - URL: kafka://USER:PASSWORD@FQDN:PORT.
  - use-ssl がデフォルトで false に設定される場合。use-ssl が true に設定されている場合は、ブローカーへの接続にセキュアな接続が使用されます。
  - ca-location が指定され、セキュアな接続が使用される場合は、ブローカーを認証するために、デフォルトの CA ではなく、指定された CA が使用されます。
  - ユーザーおよびパスワードは HTTP[S] でのみ提供できます。そうしないと、トピック作成要求は拒否されます。
  - ユーザーおよびパスワードは use-ssl とのみ提供でき、ブローカーへの接続に失敗していました。
  - Port のデフォルト値 は 9092 です。
  - kafka-ack-level: 最終宛先に送信される前にメッセージがブローカーで永続化される可能性があるため、終了確認は不要です。承認メソッドは 2 つあります。
    none: ブローカーに送信された場合にメッセージが 配信されている と見なされます。
    broker: デフォルトでは、メッセージはブローカーによって確認応答されると 配信されている と見なされます。

応答形式の例を以下に示します。

例

<CreateTopicResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <CreateTopicResult>
        <TopicArn></TopicArn>
    </CreateTopicResult>
    <ResponseMetadata>
        <RequestId></RequestId>
    </ResponseMetadata>
</CreateTopicResponse>

注記

レスポンスのトピックの Amazon Resource Name (ARN) の形式は、arn:aws:sns:ZONE_GROUP:TENANT:TOPIC になります。

以下は AMQP0.9.1 エンドポイントの例になります。

例

client.create_topic(Name='my-topic' , Attributes={'push-endpoint': 'amqp://127.0.0.1:5672', 'amqp-exchange': 'ex1', 'amqp-ack-level': 'broker'}) "

2.16.5. トピック情報の取得

指定したトピックに関する情報を返します。これには、指定されている場合にはエンドポイント情報を含めることができます。

前提条件

稼働中の Red Hat Ceph Storage クラスターがある。
ルートレベルのアクセス。
Ceph Object Gateway のインストール
ユーザーアクセスキーおよびシークレットキー。
エンドポイントパラメーター。

手順

以下の要求形式でトピック情報を取得します。
構文
```
POST
Action=GetTopic
&TopicArn=TOPIC_ARN
```
レスポンスフォーマットの例を以下に示します。
```
<GetTopicResponse>
<GetTopicRersult>
<Topic>
<User></User>
<Name></Name>
<EndPoint>
<EndpointAddress></EndpointAddress>
<EndpointArgs></EndpointArgs>
<EndpointTopic></EndpointTopic>
<HasStoredSecret></HasStoredSecret>
<Persistent></Persistent>
</EndPoint>
<TopicArn></TopicArn>
<OpaqueData></OpaqueData>
</Topic>
</GetTopicResult>
<ResponseMetadata>
<RequestId></RequestId>
</ResponseMetadata>
</GetTopicResponse>
```
以下は、タグおよび定義です。
- User: トピックを作成したユーザーの名前。
- Name: トピックの名前。
- JSON 形式のエンドポイントには以下が含まれます。
  - EndpointAddress: エンドポイントの URL。エンドポイント URL にユーザーおよびパスワード情報が含まれる場合、リクエストは HTTPS 経由で行う必要があります。それ以外の場合、トピックの取得要求は拒否されます。
    EndPointArgs: エンドポイント引数。
    EndpointTopic: エンドポイントに送信されるトピック名は、上記の例のトピック名とは異なる場合があります。
    HasStoredSecret: エンドポイントの URL にユーザーおよびパスワード情報が含まれる場合に true。
    永続: トピックが永続する場合は true。
- TopicArn: Topic ARN。
- OpaqueData: これはトピック上の不透明なデータセットです。

2.16.6. トピックのリスト表示

ユーザーが定義したトピックをリスト表示します。

前提条件

稼働中の Red Hat Ceph Storage クラスターがある。
ルートレベルのアクセス。
Ceph Object Gateway のインストール
ユーザーアクセスキーおよびシークレットキー。
エンドポイントパラメーター。

手順

以下の要求形式でトピック情報をリスト表示します。

構文

POST
Action=ListTopics

レスポンスフォーマットの例を以下に示します。

<ListTopicdResponse xmlns="https://sns.amazonaws.com/doc/2020-03-31/">
<ListTopicsRersult>
<Topics>
<member>
<User></User>
<Name></Name>
<EndPoint>
<EndpointAddress></EndpointAddress>
<EndpointArgs></EndpointArgs>
<EndpointTopic></EndpointTopic>
</EndPoint>
<TopicArn></TopicArn>
<OpaqueData></OpaqueData>
</member>
</Topics>
</ListTopicsResult>
<ResponseMetadata>
<RequestId></RequestId>
</ResponseMetadata>
</ListTopicsResponse>

注記

エンドポイント URL にユーザーおよびパスワード情報が含まれる場合は、トピックのいずれかで要求を行う必要があります。そうしないと、トピックリストの要求は拒否されます。

2.16.7. トピックの削除

削除したトピックを削除すると、操作はなく、失敗は発生しません。

前提条件

稼働中の Red Hat Ceph Storage クラスターがある。
ルートレベルのアクセス。
Ceph Object Gateway のインストール
ユーザーアクセスキーおよびシークレットキー。
エンドポイントパラメーター。

手順

以下の要求形式でトピックを削除します。

構文

POST
Action=DeleteTopic
&TopicArn=TOPIC_ARN

レスポンスフォーマットの例を以下に示します。

<DeleteTopicResponse xmlns="https://sns.amazonaws.com/doc/2020-03-31/">
<ResponseMetadata>
<RequestId></RequestId>
</ResponseMetadata>
</DeleteTopicResponse>

2.16.8. イベントレコード

イベントは、Ceph Object Gateway によって行われる操作に関する情報を保持し、選択したエンドポイント (HTTP、HTTPS、Kafka、または AMQ0.9.1 など) 上のペイロードとして送信されます。イベントレコードは JSON 形式になります。

例

{"Records":[
    {
        "eventVersion":"2.1",
        "eventSource":"ceph:s3",
        "awsRegion":"us-east-1",
        "eventTime":"2019-11-22T13:47:35.124724Z",
        "eventName":"ObjectCreated:Put",
        "userIdentity":{
            "principalId":"tester"
        },
        "requestParameters":{
            "sourceIPAddress":""
        },
        "responseElements":{
            "x-amz-request-id":"503a4c37-85eb-47cd-8681-2817e80b4281.5330.903595",
            "x-amz-id-2":"14d2-zone1-zonegroup1"
        },
        "s3":{
            "s3SchemaVersion":"1.0",
            "configurationId":"mynotif1",
            "bucket":{
                "name":"mybucket1",
                "ownerIdentity":{
                    "principalId":"tester"
                },
                "arn":"arn:aws:s3:us-east-1::mybucket1",
                "id":"503a4c37-85eb-47cd-8681-2817e80b4281.5332.38"
            },
            "object":{
                "key":"myimage1.jpg",
                "size":"1024",
                "eTag":"37b51d194a7513e45b56f6524f2d51f2",
                "versionId":"",
                "sequencer": "F7E6D75DC742D108",
                "metadata":[],
                "tags":[]
            }
        },
        "eventId":"",
        "opaqueData":"me@example.com"
    }
]}

以下はイベントレコードのキーおよびその定義です。

awsRegion: Zonegroup。
eventTime: イベントがトリガーされたタイミングを示すタイムスタンプ。
eventName: イベントのタイプ。
userIdentity.principalId: イベントを開始したユーザーの ID。
requestParameters.sourceIPAddress: イベントをトリガーしたクライアントの IP アドレス。このフィールドはサポートされません。
responseElements.x-amz-request-id: イベントをトリガーしたリクエスト ID。
responseElements.x_amz_id_2: イベントがトリガーされた Ceph Object Gateway の IP アドレスID 形式は RGWID-ZONE-ZONEGROUP です。
s3.configurationId: イベントを作成した通知 ID。
s3.bucket.name: バケットの名前。
s3.bucket.ownerIdentity.principalId: バケットの所有者。
s3.bucket.arn: バケットの Amazon Resource Name(ARN)。
s3.bucket.id: バケットのアイデンティティー。
s3.object.key: オブジェクトキー。
s3.object.size: オブジェクトのサイズ
s3.object.eTag: オブジェクト etag。
s3.object.version: バージョン化されたバケットのオブジェクトバージョン。
s3.object.sequencer: 16 進数形式でオブジェクトごとの変更識別子を増加させます。
s3.object.metadata: x-amz-meta として送信されるオブジェクトにメタデータセット。
s3.object.tags: オブジェクトに設定されたタグ。
s3.eventId: イベントの一意のアイデンティティー
s3.opaqueData: Opaque データはトピック設定で設定され、トピックによってトリガーされるすべての通知に追加されます。

関連情報

詳細は、Event Message Structure を参照してください。

2.16.9. サポートされるイベントタイプ

以下のイベントタイプがサポートされます。

s3:ObjectCreated:*
s3:ObjectCreated:Put
s3:ObjectCreated:Post
s3:ObjectCreated:Copy
s3:ObjectCreated:CompleteMultipartUpload
s3:ObjectRemoved:*
s3:ObjectRemoved:Delete
s3:ObjectRemoved:DeleteMarkerCreated

2.16. バケット通知

2.16.1. 前提条件

2.16.2. バケット通知の概要

2.16.3. 永続通知

2.16.4. トピックの作成

2.16.5. トピック情報の取得

2.16.6. トピックのリスト表示

2.16.7. トピックの削除

2.16.8. イベントレコード

2.16.9. サポートされるイベントタイプ

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links