本文へジャンプします。

ニフクラ APIリファレンス

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

RDB:AddSourceIdentifierToSubscription

処理概要

イベントサブスクリプションにリソースIDを追加します。

リクエストパラメーター

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

追加するリソースID
指定しているリソースタイプによって、それぞれ下記を指定します。

db-instance DBサーバー名(DBInstanceIdentifier)を指定します。
db-parameter-group DBパラメーターグループ名(DBParameterGroupName)を指定します。
db-security-group DBファイアウォールグループ名(DBSecurityGroupName)を指定します。
db-snapshot DBスナップショット名(DBSnapshotIdentifier)を指定します。
文字列  
SubscriptionName イベント通知名 文字列  

レスポンス

XML

status

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

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

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
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.InvalidParameterNotAllowed.SourceIdentifier Source Type is not set in the subscription Sender 400 ソースタイプが設定されていない イベントサブスクリプションに対して実施した場合
Client.InvalidParameterNotFound.EventSubscription Event Subscription aaa not found. Sender 404 存在しないSubscriptionNameを指定した場合
Client.InvalidParameterNotFound.SourceIdentifier Could not find source :aaa Sender 404 存在しないSourceIdentifierを指定した場合
Client.InvalidParameterRequired.SourceIdentifier SourceIdentifier is required. Sender 400 必須のSourceIdentifierを指定しなかった場合
Client.InvalidParameterRequired.SubscriptionName The parameter Subscription Identifier must be provided and must not be blank. Sender 400 必須のSubscriptionNameを指定しなかった場合
Client.InvalidParameterTooLong.SubscriptionName Invalid subscription name: sample-subscription123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890 Sender 400 SubscriptionNameに255文字を超える値を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=AddSourceIdentifierToSubscription
    &SubscriptionName=myrdb-event
    &SourceIdentifier=mydbinstance
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<AddSourceIdentifierToSubscriptionResponse>
  <AddSourceIdentifierToSubscriptionResult>
    <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>
  </AddSourceIdentifierToSubscriptionResult>
  <ResponseMetadata>
    <RequestId>d7e517e4-3c60-4830-960f-abf2c4577b19</RequestId>
  </ResponseMetadata>
</AddSourceIdentifierToSubscriptionResponse>

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