ニフクラAPI (RDB: DescribeEventCategories)

ニフクラユーザーガイド

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

本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/rdb/api/DescribeEventCategories.htmへ移行しました。今後は新ページをご参照ください。

DescribeEventCategories

処理概要

各リソースタイプに対するイベントカテゴリの一覧を取得します。

指定するパラメーター

パラメーター	型	説明	必須
SourceType	string	イベントのリソースタイプ ※省略した場合、すべてのリソースタイプのイベントカテゴリを取得します。値: db-instance db-parameter-group db-security-group db-snapshot

パラメーター

型

説明

必須

SourceType

string

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

※省略した場合、すべてのリソースタイプのイベントカテゴリを取得します。

値:

db-instance
db-parameter-group
db-security-group
db-snapshot

応答フィールド

フィールド (項目)	型	説明
DescribeEventCategoriesResponse	structure	ルート
␣DescribeEventCategoriesResult	structure	結果
␣␣EventCategoriesMapList	list	イベントカテゴリマップリスト
␣␣␣EventCategoriesMap	structure	イベントカテゴリマップ
␣␣␣␣SourceType	string	リソースタイプ
␣␣␣␣EventCategories	list	イベントカテゴリリスト
␣␣␣␣␣EventCategory	string	イベントカテゴリ
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	メッセージ	タイプ	HTTPステータスコード	説明
Client.InvalidParameterIllegalInput.SourceType	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 以外の値を指定した場合

リクエストサンプル

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

応答サンプル

    <DescribeEventCategoriesResponse>
  <DescribeEventCategoriesResult>
    <EventCategoriesMapList>
      <EventCategoriesMap>
        <SourceType>db-instance</SourceType>
        <EventCategories>
          <EventCategory>availability</EventCategory>
          <EventCategory>backup</EventCategory>
          <EventCategory>configuration change</EventCategory>
          <EventCategory>creation</EventCategory>
          <EventCategory>deletion</EventCategory>
          <EventCategory>failover</EventCategory>
          <EventCategory>failure</EventCategory>
          <EventCategory>low storage</EventCategory>
          <EventCategory>maintenance</EventCategory>
          <EventCategory>notification</EventCategory>
          <EventCategory>recovery</EventCategory>
          <EventCategory>restoration</EventCategory>
        </EventCategories>
      </EventCategoriesMap>
    </EventCategoriesMapList>
  </DescribeEventCategoriesResult>
  <ResponseMetadata>
    <RequestId>c3a0eca3-4ec9-420b-8298-4298293042b1</RequestId>
  </ResponseMetadata>
</DescribeEventCategoriesResponse>