DescribeEvents - Amazon DocumentDB

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DescribeEvents

インスタンス、セキュリティグループ、スナップショット、DB パラメータグループに関連する過去 14 日間のイベントを返します。特定の DB インスタンス、セキュリティグループ、データベーススナップショット、またはパラメータグループに固有のイベントは、名前をパラメータとして指定して取得します。デフォルトでは、過去 1 時間のイベントを返します。

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

Duration

イベントを取得するための分数。

デフォルト: 60

タイプ: 整数

必須: いいえ

EndTime

ISO 8601 形式で指定された、イベントを取得する時間間隔の終了時刻。

例: 2009-07-08T18:00Z

型: タイムスタンプ

必須: いいえ

EventCategories.EventCategory.N

イベント通知サブスクリプションの通知をトリガーするイベントカテゴリのリスト。

タイプ:文字列の配列

必須: いいえ

Filters.Filter.N

このパラメータは、現在サポートされていません。

型: Filter オブジェクトの配列

必須: いいえ

Marker

以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

タイプ: 文字列

必須: いいえ

MaxRecords

レスポンスに含めるレコードの最大数。指定された MaxRecords の値よりも多くのレコードが存在する場合、ページ割りトークン (マーカー) がレスポンスに含まれるため、残りの結果を取得できます。

デフォルト: 100

制約: 最小 20、最大 100。

タイプ: 整数

必須: いいえ

SourceIdentifier

イベントが返されるイベントソースの識別子。指定しない場合は、すべてのソースはレスポンスに含まれます。

制約:

  • SourceIdentifier を指定した場合、SourceType も指定する必要があります。

  • ソースタイプが DBInstance である場合は、DBInstanceIdentifier を指定する必要があります。

  • ソースタイプが DBSecurityGroup である場合は、DBSecurityGroupName を指定する必要があります。

  • ソースタイプが DBParameterGroup である場合は、DBParameterGroupName を指定する必要があります。

  • ソースタイプが DBSnapshot である場合は、DBSnapshotIdentifier を指定する必要があります。

  • ハイフンを、文字列の最後に使用したり、2 つ続けて使用したりすることはできません。

タイプ: 文字列

必須: いいえ

SourceType

イベントソースのイベントを取得します。値を指定しない場合、すべてのイベントが返されます。

型: 文字列

有効な値:db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot

必須:いいえ

StartTime

ISO 8601 形式で指定された、イベントを取得する時間間隔の開始時刻。

例: 2009-07-08T18:00Z

型: タイムスタンプ

必須: いいえ

レスポンス要素

以下の要素がサービスによって返されます。

Events.Event.N

1 つ以上のイベントに関する詳細情報。

型: Event オブジェクトの配列

Marker

以前のリクエストによって提供されたオプションのページ割りトークン。このパラメータを指定した場合、レスポンスには MaxRecords で指定された値まで、マーカーを超えるレコードのみが含まれます。

型: 文字列

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。