本文へジャンプします。

ニフクラ ユーザーガイド

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

AddSourceIdentifierToSubscription

処理概要

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

指定するパラメーター

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

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

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

SubscriptionName string イベント通知名

応答フィールド

フィールド (項目) 説明
AddSourceIdentifierToSubscriptionResponse structure ルート
AddSourceIdentifierToSubscriptionResult structure 結果
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 イベント通知の説明
備考: ニフクラ独自仕様
ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ 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://jp-east-1.rdb.api.nifcloud.com/
  ?Action=AddSourceIdentifierToSubscription
  &SubscriptionName=myrdb-event
  &SourceIdentifier=mydbinstance
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD 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>

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

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