本文へジャンプします。

ニフクラ ユーザーガイド

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

ModifyEventSubscription

処理概要

イベントサブスクリプションを更新します。

このAPIでは、リソースIDの変更はできません。
リソースIDの変更を行うには AddSourceIdentifierToSubscription、RemoveSourceIdentifierFromSubscriptionを使用してください。

指定するパラメーター

パラメーター 説明 必須
Enabled boolean 通知を行うかどうか
値:
  • true (通知を行う)
  • false (通知を行わない)
EventCategories.member.N string

通知を行うイベントカテゴリのリスト

指定したリソースタイプに対応するイベントカテゴリリストを指定します。
リソースタイプに対応するイベントカテゴリはDescribeEventCategories API で取得できます。

  • ※省略時はすべてのイベントカテゴリのイベントが通知されます。

SourceType string 通知を行うイベントのリソースタイプ
SubscriptionName string

イベント通知名

  • ※1〜255字のアルファベット・数字・ハイフンが使用できます。
  • ※最初の文字はアルファベットである必要があります。
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。

NiftyEmailAddresses.member.N string イベント通知先のメールアドレスを指定します。
備考: ニフクラ独自仕様
NiftyDescription string

イベント通知の説明

  • 1〜255文字までの印字可能文字が使用できます。
  • 空文字列を指定することも可能です。

備考: ニフクラ独自仕様
NiftySourceIds.member.N string

通知を行うリソースIDのリスト
指定したリソースタイプによって、それぞれ下記を指定します。

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

備考: ニフクラ独自仕様

応答フィールド

フィールド (項目) 説明
ModifyEventSubscriptionResponse structure ルート
ModifyEventSubscriptionResult 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.NiftyEmailAddress

Invalid nifty email address: aaa

Sender 400 NiftyEmailAddresses.member.Nがメールアドレスの形式として正しくない場合
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.Enabled
Sender 400 Enabledに真偽値型でない値を指定した場合
Client.InvalidParameterIllegalInput.SourceType

Invalid event source type. Valid types are ‘db-instance’, ‘db-security-group’, ‘db-snapshot’, ‘db-parameter-group’

Sender 400 SourceTypeに db-instance | db-security-group | db-snapshot | db-parameter-group 以外の値を指定した場合
Client.InvalidParameterNotFound.EventCategory

Category : aaa not found for source type db-snapshot

Sender 404 存在しないEventCategories.member.Nを指定した場合
Client.InvalidParameterNotFound.EventCategory

Category : availability not found for source type null

Sender 404 SourceIds.member.Nを指定しないでEventCategories.member.Nを指定した場合
Client.InvalidParameterNotFound.EventSubscription

Event Subscription aaa not found.

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

Could not find source :aaa

Sender 404 存在しないSourceIds.member.Nを指定した場合
Client.InvalidParameterRequired.SubscriptionName

Subscription name is required.

Sender 400 必須のSubscriptionNameを指定しなかった場合
Client.InvalidParameterTooLong.NiftyDescription

Invalid nifty description: sample-123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

Sender 400 NiftyDescriptionに512文字を超える値を指定した場合
Client.InvalidParameterTooLong.SubscriptionName

Invalid subscription name: sample-subscription123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890

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

Cannot set more than 20 nifty email address

Sender 400 設定可能なNiftyEmailAddressの上限数を超えている場合

リクエストサンプル

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

  

応答サンプル

    <ModifyEventSubscriptionResponse>
  <ModifyEventSubscriptionResult>
    <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@iexample.com</NiftyEmailAddress>
      </NiftyEmailAddressesList>
    </EventSubscription>
  </ModifyEventSubscriptionResult>
  <ResponseMetadata>
    <RequestId>872cfd14-4a30-483c-84c3-088a0e827915</RequestId>
  </ResponseMetadata>
</ModifyEventSubscriptionResponse>

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

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