本文へジャンプします。

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

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

RDB: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

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

  • ※現在時刻から指定した期間(分)までに発生したイベントが取得できます
  • ※このパラメータを指定した場合、EndTime・StartTimeは指定できません
  数値 60  
EndTime イベント読み出し期間の終了時間
例:2009-07-08T18:00Z
形式:ISO 8601
  日時  
EventCategories.member.N イベント通知のトリガになるイベントカテゴリーのリスト
値:availability | backup | configuration change | creation | deletion | failover | failure | low storage | notification | recovery | restoration
  文字配列  
Marker

マーカー

  • ※ページネート用にイベント一覧の取得位置を表す文字列です
  • ※前回のDescribeEventsリクエストで返却された値を指定します
  • ※この値が指定された場合、取得位置より後のイベントが返却されます
  文字列  
MaxRecords レスポンスに含まれるレコードの最大値
値:20〜100
  数値 20-100 指定しない場合、該当するレコード全件が返却されます。
SourceIdentifier

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

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

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

  • ※指定しない場合、すべてのリソースタイプのイベントが返却されます
値:db-instance | db-parameter-group | db-security-group | db-snapshot
○(SourceIdentifierを指定する場合) 文字列  
StartTime イベントの読み出し期間の開始時間
例:2009-07-08T18:00Z
形式:ISO 8601
  日時  

レスポンス

XML

status

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

result
要素名 説明 備考
DescribeEventsResponse ルート  
DescribeEventsResult 結果  
Events イベント情報リスト リスト  
Event イベント情報  
Date 日時 日時  
EventCategories イベントのカテゴリーリスト リスト  
EventCategory イベントのカテゴリー 文字列  
Message メッセージ 文字列  
SourceIdentifier イベントのリソース名 文字列  
SourceType イベントのリソースタイプ
値:db-instance | db-parameter-group | db-security-group | db-snapshot
文字列  
Marker マーカー 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
InvalidParameterCombination If Duration is specified, both StartTime and EndTime must be omitted. Sender 400 DurationとStartTimeまたはEndTimeを同時に指定した場合
Cannot specify source identifier without source type Sender 400 SourceTypeを指定しないでSourceIdentifierを指定した場合
InvalidParameterValue Invalid value for max records. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合
MalformedInput   Sender 400 Durationに数値以外を指定した場合
InvalidParameterValue Duration must be positive. Sender 400 Durationに0以下の数値を指定した場合
InvalidParameterCombination Events occurring more than 14 days in the past are not available. Sender 400 Durationに20160(14日)を超える数値を指定した場合
InvalidParameterCombination Events occurring more than 14 days in the past are not available. Sender 400 (StartTimeを指定しないで)EndTimeに14日+1時間より前の日時を指定した場合
MalformedInput timestamp must follow ISO8601 Sender 400 EndTimeに日時以外を指定した場合
InvalidParameterValue Start time must be in the past. Sender 400 (StartTimeを指定しないで)EndTimeに現在時刻+1時間以降を指定した場合
InvalidParameterValue Invalid event category type xxxx. Sender 400 EventCategories.member.Nに存在しないカテゴリーを指定した場合
MalformedInput   Sender 400 MaxRecordsに数値以外を設定した場合
InvalidParameterValue Invalid event source type. Valid types are 'db-instance', 'db-security-group', 'db-snapshot', 'db-parameter-group' Sender 400 SourceTypeに存在しないリソースタイプを指定した場合
InvalidParameterCombination Events occurring more than 14 days in the past are not available. Sender 400 StartTimeに14日より前の日時を指定した場合
MalformedInput timestamp must follow ISO8601 Sender 400 StartTimeに日時以外を指定した場合
InvalidParameterValue Start time must be in the past. Sender 400 StartTimeに現在時刻以降の日時を指定した場合
InvalidParameterCombination End time must not precede start time Sender 400 EndTimeより後の日時をStartTimeに指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
  ?Action=DescribeEvents
  &Duration=1440
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00%3A00%3A00.000Z
  &AWSAccessKeyId=<Nifty Cloud Access Key ID>
  &Signature=<Signature>
レスポンスサンプル
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<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>

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