GET Bucket metadata notification configuration要求

GET Bucket metadata notification configuration要求では、個々のバケットで検索統合を設定するために使用する設定XMLを読み出すことができます。

要求

この処理を完了するには、s3:GetBucketMetadataNotification権限が必要です。

要求のHTTPヘッダー 説明
Authorization 要求に使用するAWS署名とアカウントのアクセス キーIDを示します。
Date 要求の日付と時刻です。
Host 要求の転送先のホスト名です。

要求例

次の要求は、「bucket」という名前のバケットのメタデータ通知設定を読み出します。

GET /bucket?x-ntap-sg-metadata-notification HTTP/1.1
Host: example.com
Date: Thu, 20 Jul 2017 18:25:38 +0000
Authorization: AWS QYUTN90RX0RXO70QEGU8:/XpYXJFVGp5pXh0se26ZzxxkuNE=

応答

応答のHTTPヘッダー 説明
Connection サーバへの接続が開いているかどうかを示します。
Content-Length 応答の本文の長さです。
Content-Type 応答の本文のMultipurpose Internet Mail Extensions(MIME)タイプです。
Date 応答の日付と時刻です。
Server 応答を作成したサーバです。
x-amz-request-id 要求を一意に識別する識別子です。S3 APIで作成されます。

応答の本文には、バケットのメタデータ通知設定が含まれます。メタデータ通知設定では、バケットでの検索統合の設定を確認できます。つまり、どのオブジェクトにインデックスが付けられ、そのオブジェクト メタデータがどのエンドポイントに送信されるかを確認できます。

<MetadataNotificationConfiguration>
    <Rule>
        <ID>Rule-1</ID>
        <Status>rule-status</Status>
        <Prefix>key-prefix</Prefix>
        <Destination>
           <Urn>arn:aws:es:region:account-ID:domain/mydomain/myindex/mytype</Urn>
        </Destination>
    </Rule>
    <Rule>
        <ID>Rule-2</ID>
         ...
    </Rule>
     ...
</MetadataNotificationConfiguration>

各メタデータ通知設定には、1つ以上のルールが含まれています。各ルールは、その適用対象であるオブジェクトと、StorageGRID Webscaleがオブジェクト メタデータを送信するデスティネーションを指定します。デスティネーションは、StorageGRID WebscaleエンドポイントのURNを使用して指定する必要があります。エンドポイントの設定と検索統合サービスの詳細については、『テナント管理者ガイド』を参照してください。

名前 説明 必須
MetadataNotificationConfiguration

メタデータ通知でオブジェクトとデスティネーションの指定に使用されるルール用のコンテナ タグ。

1つ以上のルール要素が含まれています。

Rule

指定したインデックスにメタデータを追加する必要があるオブジェクトを特定するルール用のコンテナ タグ。

プレフィックスが重複しているルールは拒否されます。

MetadataNotificationConfiguration要素に含まれています。

ID

ルールの一意の識別子。

Rule要素に含まれています。

×
Status

Statusには「Enabled」または「Disabled」を指定できます。無効になっているルールについては操作が実行されません。

Rule要素に含まれています。

Prefix

このプレフィックスと一致するオブジェクトにルールが適用され、そのメタデータが指定したデスティネーションに送信されます。

すべてのオブジェクトを対象にする場合は、空のプレフィックスを指定します。

Rule要素に含まれています。

Destination

ルールのデスティネーション用のコンテナ タグ。

Rule要素に含まれています。

Urn
オブジェクト メタデータが送信されるデスティネーションのURN。次のプロパティを持つStorageGRID WebscaleエンドポイントのURNを指定する必要があります。
  • 「es」を3番目の要素にする必要があります。
  • URNの末尾に、メタデータが格納されるインデックスとタイプを、「domain-name/myindex/mytype」の形式で指定する必要があります。
エンドポイントは、テナント管理インターフェイスまたはテナント管理APIを使用して設定されます。形式は次のとおりです。
  • arn:AWS ES:regionaccount-ID:domain/mydomain/myindex/mytype
  • urn:「mysite」: es:::mydomain/myindex/mytype

エンドポイントは設定XMLを送信する前に設定する必要があります。そうしないと、404エラーで設定が失敗します。

UrnはDestination要素に含まれています。

応答例

<MetadataNotificationConfiguration>タグと</MetadataNotificationConfiguration>タグの間にあるXMLは、バケットで検索統合エンドポイントとの統合がどのように設定されているかを示します。次の例では、「records」という名前のAWSドメインでホストされている「current」という名前のElasticsearchインデックスと「2017」という名前のタイプに、オブジェクト メタデータが送信されます。

HTTP/1.1 200 OK
Date: Thu, 20 Jul 2017 18:24:05 GMT
Connection: KEEP-ALIVE
Server: StorageGRID/11.0.0
x-amz-request-id: 3832973499
Content-Length: 264
Content-Type: application/xml

<MetadataNotificationConfiguration>
    <Rule>
        <ID>Rule-1</ID>
        <Status>Enabled</Status>
        <Prefix>2017</Prefix>
        <Destination>
           <Urn>arn:aws:es:us-east-1:3333333:domain/records/current/2017</Urn>
        </Destination>
    </Rule>
</MetadataNotificationConfiguration>