本文へジャンプします。

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

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

RDB:CreateEventSubscription

処理概要

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

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
Enabled 通知を行うかどうか
値:true(通知を行う) | false(通知を行わない)
  boolean  
EventCategories.member.N

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

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

  • ※省略時はすべてのイベントカテゴリのイベントが通知されます。
  文字配列  
SourceIds.member.N

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

db-instance DBサーバー名(DBInstanceIdentifier)を指定します。
db-parameter-group DBパラメーターグループ名(DBParameterGroupName)を指定します。
db-security-group DBファイアウォールグループ名(DBSecurityGroupName)を指定します。
db-snapshot DBスナップショット名(DBSnapshotIdentifier)を指定します。
  • ※省略時はすべてのリソースIDのイベントが通知されます。
  文字配列  
SourceType

通知を行うイベントのリソースタイプ
値:db-instance | db-parameter-group | db-security-group | db-snapshot

  • ※省略時はすべてのイベントが通知されます。
  文字列  
SubscriptionName

イベント通知名

  • ※1〜255字のアルファベット・数字・ハイフンが使用できます。
  • ※最初の文字はアルファベットである必要があります。
  • ※末尾にハイフンをつけたりハイフンを2個連続させたりすることはできません。
文字列  
NiftyEmailAddresses.member.N イベント通知先のメールアドレスを指定します。 文字配列 ニフティクラウド独自仕様
NiftyDescription

イベント通知の説明

  • 1〜255文字までの印字可能文字が使用できます。
  • 空文字列を指定することも可能です。
  文字列 ニフティクラウド独自仕様

レスポンス

XML

status

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

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

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
EventSubscriptionQuotaExceeded EventSubscription quota exceeded Sender 400 作成可能なイベントサブスクリプションの個数に達している場合
SourceNotFound Cold not find source :aaa Sender 404 存在しないSourceIdsを指定した場合
SubscriptionAlreadyExist Subscription already exists Sender 400 すでに存在するSubscriptionNameを指定した場合
SubscriptionCategoryNotFound Category : aaa not found for source type db-instance Sender 404 存在しないEventCategoriesを指定した場合
InvalidParameterValue Subscription name is required. Sender 400 必須のSubscriptionNameを指定しなかった場合
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 以外の値を指定した場合
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に無効な(数字から始まるなど)値を指定した場合
NiftyEmailAddress is required. Sender 400

必須のNiftyEmailAddressを指定しなかった場合

Invalid nifty email address: aaa Sender 400

NiftyEmailAddressがメールアドレスの形式として正しくない場合

InvalidParameterCombination Cannot set more than 20 nifty email address Sender 400

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

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=CreateEventSubscription
    &SubscriptionName=myrdb-event
    &NiftyEmailAddresses.member.1=localpart@example.com
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<CreateEventSubscriptionResult>
    <DBInstance>
      <AllocatedStorage>50</AllocatedStorage>
      <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
      <AvailabilityZone>west-11</AvailabilityZone>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <DBInstanceClass>db.small</DBInstanceClass>
      <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
      <DBInstanceStatus>modifying</DBInstanceStatus>
      <DBName>testdb</DBName>
      <DBParameterGroups>
        <DBParameterGroup>
          <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
        </DBParameterGroup>
      </DBParameterGroups>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <DBSecurityGroupName>default.west-11</DBSecurityGroupName>
          <Status>available</Status>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <Endpoint>
        <Port>3306</Port>
        <Address>175.184.23.50</Address>
        <NiftyPrivateAddress>10.100.76.68</NiftyPrivateAddress>
      </Endpoint>
      <Engine>mysql</Engine>
      <EngineVersion>5.6.21</EngineVersion>
      <InstanceCreateTime>2014-12-17T05:58:42.000Z</InstanceCreateTime>
      <LatestRestorableTime>2014-12-17T06:10:00.000Z</LatestRestorableTime>
      <LicenseModel>general-public-license</LicenseModel>
      <MasterUsername>testuser</MasterUsername>
      <MultiAZ>true</MultiAZ>
      <NiftyMultiAZType>1</NiftyMultiAZType>
      <OptionGroupMemberships>
        <OptionGroupMembership>
          <OptionGroupName>default:mysql-5-6</OptionGroupName>
          <Status>in-sync</Status>
        </OptionGroupMembership>
      </OptionGroupMemberships>
      <PendingModifiedValues/>
      <PreferredBackupWindow>18:31-19:01</PreferredBackupWindow>
      <PreferredMaintenanceWindow>mon:17:02-mon:17:32</PreferredMaintenanceWindow>
      <PubliclyAccessible>true</PubliclyAccessible>
      <ReadReplicaDBInstanceIdentifiers>
        <ReadReplicaDBInstanceIdentifier>mydbinstance-replica</ReadReplicaDBInstanceIdentifier>
      </ReadReplicaDBInstanceIdentifiers>
      <SecondaryAvailabilityZone>west-11</SecondaryAvailabilityZone>
      <VpcSecurityGroups/>
      <NiftyStorageType>0</NiftyStorageType>
    </DBInstance>
  </CreateEventSubscriptionResult>
  <ResponseMetadata>
    <RequestId>bed9629a-fffd-4379-9e08-3d36dca9f575</RequestId>
  </ResponseMetadata>
</CreateEventSubscriptionResponse>

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