本文へジャンプします。

ニフティクラウド APIリファレンス

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

RDB:DescribeEventSubscriptions

処理概要

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

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
Marker

マーカー

  • ※ページネート用にDイベントサブスクリプション一覧の取得位置を表す文字列です。
  • ※前回のDescribeEventSubscriptionsリクエストで返却された値を指定します。
  • ※この値が指定された場合、取得位置より後のイベントサブスクリプションが返却されます。
  文字列  
MaxRecords レスポンスに含まれるレコードの最大値
値:20〜100
  数値 20 - 100 100  
SubscriptionName

イベント通知名

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

レスポンス

XML

status

statusは共通の応答メッセージを返却します。

result
要素名 説明 備考
DescribeEventSubscriptionsResponse ルート  
DescribeEventSubscriptionsResult 結果  
EventSubscriptionsList イベントサブスクリプションリスト リスト  
EventSubscription イベントサブスクリプション  
CustSubscriptionId イベント通知名 文字列  
Enabled 通知が有効かどうか boolean  
EventCategoriesList イベントカテゴリリスト リスト  
EventCategory イベントカテゴリ 文字列  
SourceIdsList ースIDリスト リスト  
SourceId リソースID 文字列  
SourceType リソースタイプ 文字列  
Status イベントサブスクリプションのステータス
値:active(適用中)| deleted(削除)
文字列  
SubscriptionCreationTime イベントサブスクリプションの作成日時 文字列  
NiftyEmailAddressesList メールアドレスリスト リスト ニフティクラウド独自仕様
NiftyEmailAddress メールアドレス 文字列 ニフティクラウド独自仕様
NiftyDescription イベント通知の説明 文字列 ニフティクラウド独自仕様
Marker マーカー 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
SubscriptionNotFound Event Subscription aaa not found. Sender 404 存在しないSubscriptionNameを指定した場合
InvalidParameterValue Invalid subscription name: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaaa Sender 400 SubscriptionNameに255文字を超える値を指定した場合
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に無効な(数字から始まるなど)値を指定した場合
Invalid value for max records. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合
InvalidParameterCombination SubscriptionName and Marker cannot both be provided. Sender 400 SubscriptionNameとMarkerを同時に指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DescribeEventSubscription
    &SubscriptionName=myrdb-event
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud 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>

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