本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> RDB> DescribeEventSubscriptions

DescribeEventSubscriptions

処理概要

イベントサブスクリプションの情報を取得します。

指定するパラメーター

パラメーター 説明 必須
Marker string

マーカー

  • ※ページネート用にイベントサブスクリプション一覧の取得位置を表す文字列です。
  • ※前回のDescribeEventSubscriptionsリクエストで返却された値を指定します。
  • ※この値が指定された場合、取得位置より後のイベントサブスクリプションが返却されます。

MaxRecords integer レスポンスに含まれるレコードの最大値
Default: 100
使用可能文字: 20〜100
SubscriptionName string

イベント通知名

  • ※Markerと同時に指定することはできません。

NiftyFilters.Filter.N.FilterName string

絞込対象のキー

  • ※SubscriptionNameが指定された場合、本パラメータは無視されます。

値:
  • SubscriptionName
  • SourceType
  • Enabled
  • NiftyDescription
備考: ニフクラ独自仕様
NiftyFilters.Filter.N.FilterValue string

絞込対象の値

  • ※SubscriptionNameが指定された場合、本パラメータは無視されます。

備考: ニフクラ独自仕様
NIftySortKey string

並び替え対象のキー

  • ※SubscriptionNameが指定された場合、本パラメータは無視されます。

値:
  • SubscriptionName
  • SourceType
  • Enabled
  • SubscriptionCreationTime
Default: SubscriptionName
備考: ニフクラ独自仕様
NiftySortDesc integer

NiftySortKeyで指定した項目に対する並び替え順

  • ※SubscriptionNameが指定された場合、本パラメータは無視されます。

値:
  • 0 (昇順)
  • 1 (降順)
Default: 0
備考: ニフクラ独自仕様

応答フィールド

フィールド (項目) 説明
DescribeEventSubscriptionsResponse structure ルート
DescribeEventSubscriptionsResult structure 結果
EventSubscriptionsList list イベントサブスクリプションリスト
EventSubscription structure イベントサブスクリプション
備考: EventSubscriptionの子要素はDescribeEventSubscriptionsで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
CustSubscriptionId string イベント通知名
Enabled boolean 通知が有効かどうか
EventCategoriesList list イベントカテゴリリスト
EventCategory string イベントカテゴリ
SourceIdsList list リソースIDリスト
SourceId string リソースID
SourceType string リソースタイプ
Status string

イベントサブスクリプションのステータス

  • 値:active(適用中)| deleted(削除)

SubscriptionCreationTime string イベントサブスクリプションの作成日時
NiftyEmailAddressesList list メールアドレスリスト
備考: ニフクラ独自仕様
NiftyEmailAddress string メールアドレス
備考: ニフクラ独自仕様
NiftyDescription string イベント通知の説明
備考: ニフクラ独自仕様
Marker string

前のリクエストで提供されるページを表す文字列(ページング用)

  • この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される

ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameterCombination.SubscriptionName.and.Marker

SubscriptionName and Marker cannot both be provided.

Sender 400 SubscriptionNameとMarkerを同時に指定した場合
Client.InvalidParameterFormat.SubscriptionName

The parameter Subscription Identifier is not a valid identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

Sender 400 SubscriptionNameに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterIllegalInput.MaxRecords
Sender 400 MaxRecordsに数値でない値を指定した場合
Client.InvalidParameterNotFound.EventSubscription

Event Subscription aaa not found.

Sender 404 存在しないSubscriptionNameを指定した場合
Client.InvalidParameterOutOfRange.MaxRecords

Invalid value for max records. Must be between 20 and 100

Sender 400 MaxRecordsに20-100でない値を指定した場合
Client.InvalidParameterTooLong.SubscriptionName

Invalid subscription name: sample-subscription123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

Sender 400 SubscriptionNameに255文字を超える値を指定した場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=DescribeEventSubscriptions
  &SubscriptionName=myrdb-event
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

  

応答サンプル

    <DescribeEventSubscriptionsResponse>
  <DescribeEventSubscriptionsResult>
    <EventSubscriptionsList>
      <EventSubscription>
        <Enabled>true</Enabled>
        <SourceType>db-instance</SourceType>
        <Status>active</Status>
        <SourceIdsList>
          <SourceId>mydbinstance</SourceId>
        </SourceIdsList>
        <SubscriptionCreationTime>2014-12-16 01:35:27.638</SubscriptionCreationTime>
        <CustSubscriptionId>myrdb-event</CustSubscriptionId>
        <NiftyEmailAddressesList>
          <NiftyEmailAddress>rdb-event@example.com</NiftyEmailAddress>
        </NiftyEmailAddressesList>
      </EventSubscription>
    </EventSubscriptionsList>
  </DescribeEventSubscriptionsResult>
  <ResponseMetadata>
    <RequestId>d3e207a9-8baf-46a1-b1ef-6f295afedf7a</RequestId>
  </ResponseMetadata>
</DescribeEventSubscriptionsResponse>

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月17日時点の情報です。

推奨画面サイズ 1024×768 以上