イベント通知登録の作成(POST /v1.0/{tenantId}/eventnotifications)

イベント通知登録の作成。

Request URI

{tenantID}

インスタンスのオーナーとなるプロジェクトID

Data Type Cardinality
String 1..1

Request Parameter

eventnotification

Data Type Cardinality Parent Element Child Element(s)
    None enabled

eventCategories.

sourceIds.

sourceType

id

name

description

enabled

イベント通知を有効にする

true or false

Data Type Cardinality Parent Element Child Element(s)
Boolean 0..1 eventnotification None

eventCategories.

登録したいSourceTypeのイベントカテゴリのリスト。

与えられたSourceTypeのカテゴリのリストはDescribeEventCategoriesかユーザーガイドのEventトピックで確認できる。

Data Type Cardinality Parent Element Child Element(s)
String 0..1 eventnotification None

sourceIds.

イベントが返すイベントソースのIdのリスト、

Default:指定されなかった場合、すべてのソースが対象となる。

ソースタイプにより制約される。

例. instanceならばDBInstanceのidでなければならない。

Data Type Cardinality Parent Element Child Element(s)
String list 0..1 eventnotification None

sourceType

イベントを生成しているソースのタイプ。

例えば、DBinstanceによって生成されたイベントを通知したいときには、「db-instance」を指定する。

Default:指定がない場合はすべてのイベントを通知する

db-instance | db-snapshot

Data Type Cardinality Parent Element Child Element(s)
String 0..1 eventnotification None

id

イベント通知登録のID
  • 英数字またはハイフンのみ使用可
  • 文字列の先頭は英字で始めること
  • 文字列の末尾にハイフンは使用不可
  • 連続した２つ以上のハイフンは使用不可
  • 最大63文字

Default: random value

Data Type Cardinality Parent Element Child Element(s)
String 0..1 eventnotification None

name

イベント通知登録の名前
  • 英数字またはハイフンのみ使用可
  • 文字列の先頭は英字で始めること
  • 文字列の末尾にハイフンは使用不可
  • 連続した２つ以上のハイフンは使用不可
  • 最大255文字
Data Type Cardinality Parent Element Child Element(s)
String 1..1 eventnotification None

description

イベント通知登録の説明
  • 最大1024文字

Default: None

Data Type Cardinality Parent Element Child Element(s)
String 0..1 eventnotification None

Response Headers

ステータス

リクエストのステータスを返却する。

以下の値を返却する。
400:
badRequest
401:
unauthorized
403:
forbidden
404:
itemNotFound
413:
overLimit
422:
unprocessableEntity
500:
instanceFault
501:
notImplemented
503:
serviceUnavailable
504:
gatewayTimeout
Data Type Cardinality
Int 1..1

Response Elements

EventSubscription

Data Type Cardinality Parent Element Child Element(s)
    None id

name

enabled

eventCategoriesList

sourceIdsList

sourceType

status

created

id

イベント通知登録のID

Data Type Cardinality Parent Element Child Element(s)
String      

name

イベント通知登録の名前

Data Type Cardinality Parent Element Child Element(s)
String      

enabled

通知が有効かどうかのフラグ

Data Type Cardinality Parent Element Child Element(s)
Boolean      

eventCategoriesList

通知するイベントカテゴリのリスト

Data Type Cardinality Parent Element Child Element(s)
String list      

sourceIdsList

通知するイベントの発生元となるリソースIDのリスト

Data Type Cardinality Parent Element Child Element(s)
String list      

sourceType

イベントの発生元となるリソースの種類

Data Type Cardinality Parent Element Child Element(s)
String      

status

イベント通知登録の状態

creating | modifying | deleting | active |

Data Type Cardinality Parent Element Child Element(s)
String      

created

作成日時

Data Type Cardinality Parent Element Child Element(s)
String      

description

説明

Data Type Cardinality Parent Element Child Element(s)
String      

Example of Response


{
  "eventSubscription": {
    "subsciptionId": "suscription1",
    "name": " mysubscription1",
    " enabled ": true,
    " eventCategories ": [
      {
        "eventCategory": "backup"
      },
      {
        "eventCategory": "creation"
      }
    ],
    "sourceIds": [
      {
        "sourceId": "dbinst1"
      },
      {
        "sourceId": "dbinst2"
      }
    ],
    "sourceType": "db-instance",
    "created": "2013-03-18T19:09:17",
"description": " this is test "
  }
}