本文へジャンプします。

ニフクラ ユーザーガイド

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

DescribeEvents

処理概要

過去14日のDBサーバー・DBファイアウォールグループ・DBスナップショット・DBパラメーターグループに関するイベントの情報を取得します。

特定のリソースについてのイベント情報を取得するには対象のSourceIdentifier(リソース名)とSourceType(リソースタイプ)を指定してください。

Duration、EndTime、StartTimeの組み合わせによる情報の取得範囲は下記のようになります。

何も指定しない Durationのデフォルト値60で、現在時刻の1時間前〜現在時刻のイベントを取得
Durationのみ指定 現在時刻から指定した期間(分)前〜現在時刻のイベントを取得
StartTimeのみ指定 StartTime〜現在時刻のイベントを取得
EndTimeのみ指定 EndTimeの1時間前〜EndTimeのイベントを取得
StartTimeとEndTimeを指定 StartTime〜EndTimeのイベントを取得
StartTimeとDurationを指定 エラー
EndTimeとDurationを指定 エラー
StartTime,EndTime,Durationを指定 エラー

指定するパラメーター

パラメーター 説明 必須
Duration integer

読み出すイベントの期間(分)

  • ※現在時刻から指定した期間(分)までに発生したイベントが取得できます
  • ※このパラメータを指定した場合、EndTime・StartTimeは指定できません

Default: 60
EndTime timestamp

イベント読み出し期間の終了時間

  • 例:2009-07-08T18:00Z
  • 形式:ISO 8601

EventCategories.member.N string イベント通知のトリガになるイベントカテゴリーのリスト
値:
  • availability
  • backup
  • configuration change
  • creation
  • deletion
  • failover
  • failure
  • low storage
  • notification
  • recovery
  • restoration
Marker string

マーカー

  • ※ページネート用にイベント一覧の取得位置を表す文字列です
  • ※前回のDescribeEventsリクエストで返却された値を指定します
  • ※この値が指定された場合、取得位置より後のイベントが返却されます

MaxRecords integer レスポンスに含まれるレコードの最大値
使用可能文字: 20〜100
備考: 指定しない場合、該当するレコード全件が返却されます。
SourceIdentifier string

読み出すイベントのリソース名

  • ※指定しない場合、すべてのリソースタイプのイベントが返却されます
  • ※リソースタイプに応じてリソース名を指定してください
    db-instance → DBサーバー名
    db-parameter-group → DBパラメーターグループ名
    db-security-group → DBファイアウォールグループ名
    db-snapshot → DBスナップショット名

○ (SourceTypeを指定する場合)
SourceType string

読み出すイベントのリソースタイプ

  • ※指定しない場合、すべてのリソースタイプのイベントが返却されます

値:
  • db-instance
  • db-parameter-group
  • db-security-group
  • db-snapshot
○ (SourceIdentifierを指定する場合)
StartTime timestamp

イベントの読み出し期間の開始時間

  • 例:2009-07-08T18:00Z
  • 形式:ISO 8601

応答フィールド

フィールド (項目) 説明
DescribeEventsResponse structure ルート
DescribeEventsResult structure 結果
Events list イベント情報リスト
Event structure イベント情報
Date timestamp 日時
EventCategories list イベントのカテゴリーリスト
EventCategory string イベントのカテゴリー
Message string メッセージ
SourceIdentifier string イベントのリソース名
SourceType string

イベントのリソースタイプ

  • 値:db-instance | db-parameter-group | db-security-group | db-snapshot

Marker string

前のリクエストで提供されるページを表す文字列(ページング用)

  • この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される

ResponseMetadata structure 共通メタ情報
RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameterCombination.Duration.and.EventStartTimeAndEndTime

If Duration is specified, both StartTime and EndTime must be omitted.

Sender 400 DurationとStartTimeまたはEndTimeを同時に指定した場合
Client.InvalidParameterCombination.EventStartTime.and.EventEndTime

End time must not precede start time

Sender 400 StartTimeにEndTimeより後の日時を指定した場合
Client.InvalidParameterIllegalInput.Duration
Sender 400 Durationに数値以外を指定した場合
Client.InvalidParameterIllegalInput.EventCategory

Invalid event category type aaa.

Sender 400 存在しないEventCategories.member.Nを指定した場合
Client.InvalidParameterIllegalInput.EventEndTime

timestamp must follow ISO8601

Sender 400 EndTimeに日時以外を指定した場合
Client.InvalidParameterIllegalInput.EventStartTime

timestamp must follow ISO8601

Sender 400 StartTimeに日時以外を指定した場合
Client.InvalidParameterIllegalInput.MaxRecords
Sender 400 MaxRecordsに数値でない値を指定した場合
Client.InvalidParameterIllegalInput.SourceType

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

Sender 400 存在しないSourceTypeを指定した場合
Client.InvalidParameterMissing.SourceType

Cannot specify source identifier without source type

Sender 400 SourceTypeを指定しないでSourceIdentifierを指定した場合
Client.InvalidParameterOutOfRange.Duration

Duration must be positive.

Sender 400 Durationに0以下の数値を指定した場合
Client.InvalidParameterOutOfRange.Duration

Events occurring more than 14 days in the past are not available.

Sender 400 Durationに20160(14日)を超える数値を指定した場合
Client.InvalidParameterOutOfRange.EventEndTime

Events occurring more than 14 days in the past are not available.

Sender 400 (StartTimeを指定しないで)
EndTimeに14日+1時間より前の日時を指定した場合
Client.InvalidParameterOutOfRange.EventEndTime

Start time must be in the past.

Sender 400 (StartTimeを指定しないで)
EndTimeに現在時刻+1時間以降を指定した場合
Client.InvalidParameterOutOfRange.EventStartTime

Events occurring more than 14 days in the past are not available.

Sender 400 StartTimeに14日より前の日時を指定した場合
Client.InvalidParameterOutOfRange.EventStartTime

Start time must be in the past.

Sender 400 StartTimeに現在時刻以降の日時を指定した場合
Client.InvalidParameterOutOfRange.MaxRecords

Invalid value for max records. Must be between 20 and 100

Sender 400 MaxRecordsに20-100でない値を指定した場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=DescribeEvents
  &Duration=1440
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD Access Key ID>
  &Signature=<Signature>

  

応答サンプル

    <DescribeEventsResponse>
  <DescribeEventsResult>
    <Events>
      <Event>
        <Date>2013-11-30T05:51:24.000Z</Date>
        <EventCategories>
          <EventCategory>configuration change</EventCategory>
        </EventCategories>
        <Message>Updated parameter max_allowed_packet to 1024 with apply method immediate</Message>
        <SourceIdentifier>mydbparametergroup</SourceIdentifier>
        <SourceType>db-parameter-group</SourceType>
      </Event>
      <Event>
        <Date>2013-11-30T05:51:24.000Z</Date>
        <EventCategories>
          <EventCategory>configuration change</EventCategory>
        </EventCategories>
        <Message>Updated parameter max_connections to 24 with apply method pending-reboot</Message>
        <SourceIdentifier>mydbparametergroup</SourceIdentifier>
        <SourceType>db-parameter-group</SourceType>
      </Event>
      <Event>
        <Date>2013-11-30T06:00:07.000Z</Date>
        <EventCategories>
          <EventCategory>configuration change</EventCategory>
        </EventCategories>
        <Message>Updated parameter max_allowed_packet to null with apply method immediate</Message>
        <SourceIdentifier>mydbparametergroup</SourceIdentifier>
        <SourceType>db-parameter-group</SourceType>
      </Event>
      <Event>
        <Date>2013-11-30T06:00:07.000Z</Date>
        <EventCategories>
          <EventCategory>configuration change</EventCategory>
        </EventCategories>
        <Message>Updated parameter max_connections to {DBInstanceClassMemory/12582880} with apply method immediate</Message>
        <SourceIdentifier>mydbparametergroup</SourceIdentifier>
        <SourceType>db-parameter-group</SourceType>
      </Event>
    </Events>
  </DescribeEventsResult>
  <ResponseMetadata>
    <RequestId>00441b3a-a6f8-46c8-8f34-2af2c76f08ce</RequestId>
  </ResponseMetadata>
</DescribeEventsResponse>

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

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