Cloudn RDB APIリファレンス

本マニュアルでは、 Cloudn RDBのAPIご利用方法に関してご説明いたします。

右上の “索引” や、左のバーにある検索にて検索が可能です。

1. Cloudn APIについて

Cloudn では、各プロダクトごとにAPIを提供しております。
APIを使用することで、コントロールパネルを介さずにお客様のプログラムから直接リソースを操作することが可能です。

1.1. API共通情報

ご利用にあたっては下記の通りの情報/前提知識が必要となります。

API共通情報

以下、3つの情報がAPIを利用するにあたり必要となります。

  • アクセスキーID
  • 秘密鍵
  • APIエンドポイント

以下の2つを Cloudn ポータルよりログインし、入手します。

  • アクセスキーID

    • APIへのアクセスにおいて、お客様個人のIDを識別するためのキーです。
    • お客様固有のものとなります
  • 秘密鍵

    • APIへのアクセスにおいて、電子署名に利用される鍵です。
    • お客様固有のものとなります

APIエンドポイントについては、各 Cloudn サービスごとに異なります。 下記を参照してください。

API情報 ( Cloudn RDB )

アクセスキーID・秘密鍵入手方法

Cloudn ポータルへログイン

下記URLより、パスワード/IDでログインをします。

https://portal.cloudn-service.com/comgi/login

画面下部”APIアクセスキー・秘密鍵管理”をクリック

画面下部に存在する”APIアクセスキー・秘密鍵管理”をクリックします。

ポータルから秘密鍵へのリンク

Cloudn ポータル最下段、アクセスキーID・秘密鍵管理画面へのリンク

アクセスキーID・秘密鍵をコピーして利用

アクセスキーID・秘密鍵をコピーして利用します。

アクセスキーID・秘密鍵管理画面キャプチャ

アクセスキーID・秘密鍵管理画面

1.2. API情報 ( Cloudn RDB )

APIエンドポイントについて

本サービスにて提供しているAPIエンドポイント(API ServerのURI)は下記となります。
こちらにAPIリクエストをコールしてください。
https://rdb-api.jp-e1.cloudn-service.com

共通パラメータについて

以下のテーブルは後述のAPIリクエストにおいて用いる共通のパラメータを示しています。
Common Request Parameter
パラメータ名 説明 必須 DATATYPE
Action
実行するaction(API名)を指定します。
Yes String
AWSAccessKeyID
APIの認証に必要な秘密鍵と対になるアクセスキーIDを指定します。

デフォルト値 : None
Yes String
Expires
※現時点で未対応です。
(※1) String
SecurityToken
※現時点で未対応です。
No String
Signature
APIリクエストのために作成されたデジタル署名です。

デフォルト値 : None
Yes String
SignatureMethod
APIリクエストに利用するデジタル署名生成のhash algorithmです。

デフォルト値 : None
有効値 : HmacSHA256
Yes String
SignatureVersion
シグネチャのバージョンは、リクエストに署名するために使用します。
Signatureのバージョンは“2”のみ対応です。

デフォルト値 : None
Yes String
Timestamp
APIリクエスト日時です。表記方法は「YYYY-MM-DDThh:mm:ssZ」で、ISO8601準拠です。

デフォルト値 : None
Timestampの有効期限は60secです。
Yes

(※1)

String
Version
APIのversionです。表記方法は、YYYY-MM-DDとなります。
2012-04-23のバージョンのみ提供します。
Yes  

注釈

(※1). APIリクエストにはTimestampかExpiresのどちらかを指定する必要があります。 現時点ではExpiresを提供していないため、Timestampを指定する必要があります。

[参考]前提知識

Cloudn RDBについて

Cloudn RDBの操作・機能については操作マニュアルを参照してください。

クラウド・エヌ インフォメーションポータル - マニュアル

APIの利用方法について

APIクライアントを利用した利用例・プログラム上でAPIを利用するために必要なリクエストの作成例を以下に示します。

注釈

APIのご利用にあたっては、ご利用前に、 Cloudn ポータルより サービスを利用開始する必要があります。

1.3. APIクライアントの利用

概要

Cloudn RDBでは、Amazon Relational Database Service (以下Amazon RDS) 互換APIを提供しており、
各種AWS対応APIツールを利用することが可能です。

APIクライアントとして、下記に示すkick_api.rbを用いた例をご説明します。
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
#!/usr/bin/env ruby
# coding: utf-8

require 'cgi'
require 'time'
require 'openssl'
require 'base64'
require 'net/http'
require 'net/https'

class KickAPI;

  class CLI

    ENDPOINT = 'https://rdb-api.jp-e1.cloudn-service.com/'
    AWS_ACCESS_KEY_ID = '<PLEASE FILL YOUR ACCESS KEY ID>'
    AWS_SECRET_ACCESS_KEY = '<PLEASE FILL SECRET ACCESS KEY>'

    def main

      params = parse_options(ARGV)
      if params['Action'].nil?
        puts 'usage : ./kick_api.rb Action=... Parameter=... Parameter=...'
        exit 1
      end

      client = KickAPI::Client.new(ENDPOINT, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
      response = client.call(params)
      puts "HTTP Status Code: #{response.header.code}"
      puts response.body

    end

    private

    def parse_options(args)

      params = {}
      args.each do |arg|
        key, value = arg.split('=')
        params[key] = value
      end
      params

    end

  end

  class Client

    def initialize(endpoint, access_key_id, secret_access_key)

      @endpoint_uri = URI.parse(endpoint)
      @access_key_id = access_key_id
      @secret_access_key = secret_access_key

    end

    def call(params)

      action = params['Action']

      raise "params['Action'] is not specified." if action.nil?

      params = {
          'AWSAccessKeyId' => @access_key_id,
          'SignatureMethod' => 'HmacSHA256',
          'SignatureVersion' => 2,
          'Version' => '2012-04-23',
          'Timestamp' => Time.now.iso8601
      }.merge(params)

      params['Signature'] = calculate_signature(params)
      querystring = params.collect { |key, value| escape(key, value) }.join('&')

      client = Net::HTTP.new(@endpoint_uri.host, @endpoint_uri.port)

      if @endpoint_uri.scheme == 'https'
        client.use_ssl = true
        client.verify_mode = OpenSSL::SSL::VERIFY_PEER
      end

      response = client.start do |w|
        get = Net::HTTP::Get.new("#{@endpoint_uri.path}?#{querystring}")
        w.request(get)
      end
      return response
    end

    private

    def calculate_signature(params)
      canonical_querystring = params.sort.collect { |key, value| escape(key, value) }.join('&')

      string_to_sign = "GET
#{@endpoint_uri.host}
#{@endpoint_uri.path}
#{canonical_querystring}"

      hmac = OpenSSL::HMAC.new(@secret_access_key, "sha256")
      hmac.update(string_to_sign)
      Base64.encode64(hmac.digest).chomp
    end

    def escape(key, value)
      [key, value].collect { |str| CGI::escape(str.to_s).gsub('+', '%20').gsub('%7E', '~') }.join('=')
    end

  end
end

if $0 == __FILE__
  KickAPI::CLI.new.main
end

kick_api.rbの利用

前提条件
  • Ruby1.9.2p0 以上での動作(1.8では動作しません)
kick_api.rbのダウンロード
上記のリンクよりkick_api.rbをダウンロードします。
次に、秘密鍵・APIアクセスキーを設定します。
エディタなどでダウンロードしたkick_api.rbを開き、編集します。

以下、APIアクセスキーを”WNZ9AV783OKRC8C5DL4Q”, 秘密鍵を”Q5j2kslNp5L7mnpJGZwS9AdkJla9V08vZ0JalhGl”、
および東日本リージョン(FLATタイプ)を利用すると仮定し設定します。
vim kick_api.rb

下記の変更を行います。

  • 上記コードでハイライトされた部分を編集します

    • “Please Enter the Endpoint” へ 対象リージョン・タイプのエンドポイントホスト部
    • “Please Enter your API Access Key Id” へ APIアクセスキーの “WNZ9AV783OKRC8C5DL4Q” を入力
    • “Please Enter your Secret Key” へ 秘密鍵の “Q5j2kslNp5L7mnpJGZwS9AdkJla9V08vZ0JalhGl” を入力

例の場合、変更した点は以下の通りです。

@@ -16,8 +16,8 @@

-end_point = "Please Enter the Endpoint"
-access_key_id = "Please Enter your API Access Key Id"
-secret_access_key = "Please Enter your Secret Key"
+end_point = "rdb-api.jp-e1.cloudn-service.com"
+access_key_id = "WNZ9AV783OKRC8C5DL4Q"
+secret_access_key = "Q5j2kslNp5L7mnpJGZwS9AdkJla9V08vZ0JalhGl"

参考

API認証情報については以下を参照してください

エンドポイントについては以下を参照してください

上記ファイルを保存します。

kick_api.rbの利用
シェルにて下記のように実行します
下記のコマンドで、現在あるDBインスタンス一覧を取得するAPI ( DescribeDBInstances - DBインスタンス詳細情報取得 )
を利用可能です。
$ruby kick_api.rb Action=DescribeDBInstances

コマンド引数は以下の通りです。

  • “Action=”

    • APIのアクション名(API名)を指定します。例では、 “DescribeDBInstances” というAPIをコールしています
  • その他パラメータ (例: “DBInstanceIdentifier=hogehoge”)

    • API固有のパラメータを上記の形式で入力します。API固有のパラメータは、各APIの説明ページをご覧ください。

上記の様に、kick_api.rbクライアントを利用することでAPIの実行に必要な署名の作成等の作業が簡略化されます。

1.4. リクエスト作成方法

APIクライアントなどを使用せずにAPIリクエストを利用する方法を示します。

APIリクエスト形式

Cloudn RDBサービスのリクエストは、Query API形式となります。
例えば、本サービスのDB Instanceを削除する、 DeleteDBInstance API リクエストは、以下のようになります。
https://rdb-api.jp-e1.cloudn-service.com&Action=DeleteDBInstance&DBInstanceIdentifier=db-instance-name&SkipFinalSnapshot=true&Version=2012-04-23&SignatureVersion=2&SignatureMethod=HmacSHA256&Timestamp=2013-01-30T18%3A09%3A45Z&AWSAccessKeyId=<APIKEY>&Signature=<Signature>
上記では例として RDBでサポートされるDBを作成するリクエストを記載しています。
APIリクエストは、主に命令の種類とそのオプションの値を含み、下記の要素で構成されます。
https://rdb-api.jp-e1.cloudn-service.com
Action=DeleteDBInstance
DBInstanceIdentifier=db-instance-name
SkipFinalSnapshot=true
Version=2012-04-23
SignatureVersion=2
SignatureMethod=HmacSHA256
Timestamp=2013-01-30T18%3A09%3A45Z
AWSAccessKeyId=<APIKEY>
Signature=<Signature>

構成要素は以下の通りです。

  • 1行目: APIサーバ/エンドポイントURL
  • 2行目: RDBへのコマンド (Action)
  • 3-4行目: コマンドに渡すオプションとその値
  • 5-10行目: 署名情報

リクエスト本文に署名を付ける手順を説明します。

署名

APIリクエストには、リクエスト内容を保証するために、署名(Signature)を加えます。
署名は、リクエスト本文(1の要素を元に作成)を元に、ユーザのSECRETKEYとHMAC-SHA-256ハッシュアルゴリズムを組み合わせて作成します。
予めサービス利用に必要な公開鍵と秘密鍵を配布しています。
サービス上ではこれをAPIアクセスキーと秘密鍵と呼びます。
APIアクセスキーと秘密鍵については アクセスキーID・秘密鍵入手方法 を参照してください。
署名の作成手順
以下では署名とAPIリクエストの生成方法について解説します。


リクエストのコマンドパラメータを作成します。
メトリクス一覧情報を取得するリクエスト作成を例に、コマンドパラメータを記載します。
コマンド, パラメータ
Action DeleteDBInstance
DBInstanceIdentifier db-instance-name
SkipFinalSnapshot true
Version 2012-04-23
SignatureVersion 2
SignatureMethod HmacSHA256
Timestamp 2013-01-30T18:09:45Z
AWSAccessKeyId <APIKEY>

注釈

コマンド,およびパラメータは大文字小文字を区別します

注釈

Timestamp は、リクエスト発行時の時刻をiso8601形式で作成します。

  • (例): 2014-08-14T11:10:03
    • マイクロ秒は必要ありません。
    • 日付時刻の間のデリミタは “T” です

次に署名を作成します。

作成したコマンドパラメータを、ASCIIの昇順で並べ替え、値をURLエンコードします。
本操作は署名の作成のために行うもので、リクエスト本文自体が並べ替えられるわけではありません。
(リクエスト本文はソートされている必要はありません)
コマンド, パラメータ
AWSAccessKeyId <APIKEY>
Action DeleteDBInstance
DBInstanceIdentifier db-instance-name
SignatureMethod HmacSHA256
SignatureVersion 2
SkipFinalSnapshot true
Timestamp 2013-01-30T18%3A09%3A45Z
Version 2012-04-23
上表の “コマンド, パラメータ” 行と “値” 行を、”=” にてつないだものを “&” で接続し、
HTTPリクエストの要素を添えて署名対象文字列(“data”)の作成します。

以下の文字列をここでは “data” とします:

GET
rdb-api.jp-e1.cloudn-service.com
/
AWSAccessKeyId=<APIKEY>&Action=DeleteDBInstance&DBInstanceIdentifier=db-instance-name&SignatureMethod=HmacSHA256&SignatureVersion=2&SkipFinalSnapshot=true&Timestamp=2013-01-30T18%3A09%3A45Z&Version=2012-04-23

注釈

“AWSAccessKeyId=〜”クエリまでは各要素を改行しますが、クエリ部分は改行せず1行で作成します

作成した文字列”data”に対して、HMAC-SHA256と秘密鍵から署名を生成し、 これをHTTPリクエストに含められるようにBase64でエンコードします。

  • HMAC-SHA256:
    • 暗号化形式です
    • OpenSSL等のライブラリの機能を利用し、作成します
    • (例:Rubyであればgemライブラリの ruby-hmac(0.4.0) など)
  • SECRETKEY:
    • 弊社から配布された物をご利用ください
  • HMACによる署名サンプル:
    • 5df60c66d6715d33c5b49af3428c0cbb84918a0baa96c29f3b32670a742bdc29
  • 署名サンプル:(Base64エンコード後)
    • NWRmNjBjNjZkNjcxNWQzM2M1YjQ5YWYzNDI4YzBjYmI4NDkxOGEwYmFhOTZjMjlmM2IzMjY3MGE3NDJiZGMyOQ==

注釈

署名内に改行が入らないようにご注意ください

署名(Signature)をリクエスト本文に付け加え、リクエスト文字列を作成します。
パラメータの値は予めURLエンコードしておきます。
コマンド、パラメータの記述を コマンド、パラメータ=値(値はURLエンコード済)とし、各パラメータを&で繋ぎます。

なお、APIリクエストでは項目をソートする必要はありません。
https://rdb-api.jp-e1.cloudn-service.com?AWSAccessKeyId=<APIKEY>&Action=DeleteDBInstance&DBInstanceIdentifier=db-instance-name&SignatureMethod=HmacSHA256&SignatureVersion=2&SkipFinalSnapshot=true&Timestamp=2013-01-30T18%3A09%3A45Z&Version=2012-04-2&Signature=NWRmNjBjNjZkNjcxNWQzM2M1YjQ5YWYzNDI4YzBjYmI4NDkxOGEwYmFhOTZjMjlmM2IzMjY3MGE3NDJiZGMyOQ==
作成したリクエスト本文を元に、HTTPSでAPIエンドポイントに対しGETリクエストを実行します。
APIエンドポイントは APIエンドポイントについて を参照してください。
GET /?
AWSAccessKeyId=<APIKEY>&Action=DeleteDBInstance&DBInstanceIdentifier=db-instance-name&SignatureMethod=HmacSHA256&SignatureVersion=2&SkipFinalSnapshot=true&Timestamp=2013-01-30T18%3A09%3A45Z&Version=2012-04-2&Signature=NWRmNjBjNjZkNjcxNWQzM2M1YjQ5YWYzNDI4YzBjYmI4NDkxOGEwYmFhOTZjMjlmM2IzMjY3MGE3NDJiZGMyOQ==

1.5. データ構造

取得するデータに関する構造を以下に示します。

EC2SecurityGroup

概要
*現時点で未対応です。
このデータタイプは、以下のAPIのレスポンスに含まれています。
・AuthorizeDBSecurityGroupIngress・DescribeDBSecurityGroups・RevokeDBSecurityGroupIngtress
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
EC2SecurityGroupID 該当するEC2 Security Groupに設定されているIDです。 String
EC2SecurityGroupName 該当するEC2 Security Groupに設定されているnameです。 String
EC2SecurityGroupOwnerID 該当するEC2 Security GroupのownerのAWS ID(Account Number)として、 EC2SecurityGroupNameに設定されている値です。 String
Status 設定されたEC2 security group nameのstatusです。表示されるstatusは “authorizing”“authorized”“revoking”“revoked”になります。 String

IPRanges

概要
このデータタイプは、以下のAPIのレスポンスに含まれています。
・DescribeDBSecurityGroups
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
CIDRIP 設定されたIP rangeです。 String
Status 設定されたIP rangeのstatusです。 表示されるstatusは“authorizing”“authorized”“revoking”“revoked”になります。 String

DBParameterGroupStatus

概要
DBParameterGroupのStatusです。
このデータタイプは、以下のAPIのレスポンスに含まれています。
・CreateDBInstance・CreateDBInstanceReadReplica・DeleteDBInstance
・ModifyDBInstance・RebootDBInstance・RestoreDBInstanceFromDBSnapshot
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
DBParameterGroupName DBParameterGroupの名前です。 String
ParameterApplyStatus パラメータ更新のStatusです。 String

DBSecurityGroup

概要
このデータタイプは、以下のAPIのレスポンスに含まれています。
・DescribeDBSecurityGroups・AuthorizeDBSecurityGroupIngress
・CreateDBSecurityGroup・RevokeDBSecurityGroupIngress

DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
DBSecurityGroupDescription DBセキュリティグループの説明です。 String
DBSecurityGropuName 設定されているDBセキュリティグループの名前です。 String
EC2SecurityGroups DataTypeのEC2SecurityGroupのパラメータが含まれます。 EC2SecurityGroup listの詳細は、 Data Typesの「EC2SecurityGroup」を参照 EC2SecurityGroup list
IPRanges DataTypeのIPRangeのパラメータが含まれます。 IPRangelistの詳細は、Data Typesの「IPRange」を参照 IPRange list
OwnerId ※本RDBサービスでは無効なParameterです。 設定したDBセキュリティグループのownerのAWS IDです。 String
VpcId ※本RDBサービスでは無効なParameterです。 設定したDBセキュリティグループのownerのVpcIdです。 String

DBSecurityGroupMembership

概要
このデータタイプは、以下のAPIのレスポンスに含まれています。
・ModifyDBInstance ・RebootDBInstance ・RestoreDBInstanceFromDBSnapshot ・RestoreDBInstanceToPointInTime
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
DBSecurityGroupName DBSecurityGroupの名前です。 String
Status DBSecurityGroupのStatusです。 String

DBSubnetGroup

概要
*現時点で未対応です。
次のアクションの実行が成功した結果に含まれています。
・CreateDBSubnetGroup・ModifyDBSubnetGroup
・DescribeDBSubnetGroups・DeleteDBSubnetGroup

DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
DBSubnetGroupDescription DBSubnetGroupの説明です。 String
DBSubnetGroupName DBSubnetGroupに指定した名前です。 String
SubnetGroupStatus DBSubnetGroupのStatusです。 String
Subnets
Subnetの情報一覧の一部です。
Subnetsの詳細は、「Load Balancer API (Data Type) Subnets」を参照
String
VpcID DBSubnetGroupのVpcIDです。 String

Subnets

概要
*現時点で未対応です。

このデータタイプは、以下のAPIのレスポンスに含まれています。
・DescribeDBSubnetGroups
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
SubnetAvailabilityZine AvailabilityZone情報が含まれています。 このデータタイプは、以下のデータタイプとしても利用されます。 ・OrderableDBInstanceOption AvailabilityZoneの詳細は、「AvailabilityZone」を参照 AvailabilityZone
SubnetIdentifier 指定したこのSubnetの識別子です。 String
SubnetStatus 指定したSubnetのStatusです。 String

AvailabilityZone

概要
ゾーン情報が含まれています。
このデータタイプは、以下のデータタイプに含まれています。
・OrderableDBInstanceOption
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
Name |ゾーンの名前です。 String
ProvisionedIopsCapable |*現在このパラメータはサポートしておりません。 Boolean

Endpoint

概要
このデータタイプは、以下のAPIのレスポンスに含まれています。
・CreateDBInstance ・DescribeDBInstances ・DeleteDBInstance ・RebootDBInstance ・ModifyDBInstance ・RestoreDBInstanceToPointInTime ・CreateDBInstanceReadReplica

DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
Address DBインスタンスの接続先です。 String
Port DBインスタンスの接続ポート番号です。Required:No Integer

OptionGroupMembership

概要
*現時点で未対応です。
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
OptionGroupName 属しているオプショングループの名前です。Required:No String
Status OptionGroupMembershipのステータスです。 Required:No String

PendingModifiedValues

概要
*現時点で未対応です。
このデータタイプは、以下のAPIのレスポンスに含まれています。
・ModifyDBInstance
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
AllocatedStorage 保留されているDBインスタンスの変更後ディスク容量です。Required:No Integer
BackupRetentionPeriod 自動バックアップが保持される日数の保留数を表します。 Required:No Integer
DBInstanceClass 保留されている新しいDBサーバープランを表します。Required:No String
EngineVersion DBエンジンの変更後バージョンを表します。 Required: No String
MasterUserPassword 保留されている変更後DB接続パスワードを表します。 Required:No String
MultiAZ 高可用性構成設定への変更後の設定を表します。 Required:No Boolean
Port 保留されている変更後DB接続ポート番号を表します。Required:No Integer

ResourcePendingMaintenanceActions

概要
このデータタイプは、以下のAPIのレスポンスに含まれています。
・ApplyPendingMaintenanceAction
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
PendingMaintenanceActionDetails.PendingMaintenanceAction.N 適用待ちアクションのリストです。 Required:No PendingMaintenanceAction
ResourceIdentifier DBインスタンス名。 Required:No String

PendingMaintenanceAction

概要
このデータタイプは、以下のAPIのレスポンスに含まれています。
・ApplyPendingMaintenanceAction
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
Action system-update固定 String
OptInStatus immediate固定 String
CurrentVersion DBインスタンスに適用済みのシステムアップデート最新バージョン String
TargetVersion DBインスタンスに未適用のシステムアップデート最新バージョン。 String

DBInstance

概要
次のアクションの実行が成功した結果に含まれています。
・CreateDBInstance
・DescribeDBInstances
・DeleteDBInstance
・RebootDBInstance
・ModifyDBInstance
・RestoreDBInstanceToPointInTime
・CreateDBInstanceReadReplica
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
AllocatedStorage
GB単位で指定した、割り当てられるDBディスク容量です。
Integer
AutoMinorVersionUpgrade
※無効パラメータです。
Boolean
AvailabilityZone
DBインスタンスが作成されたゾーンを表します。
String
BackupRetentionPeriod
自動バックアップ機能で取得したデータを保持する日数を表します。
Integer
CharacterSetName
※無効パラメータです。
String
CloudnPaaSLinkStatus
PaaSサービスとの連携の状態を表します。
String
DBInstanceClass
指定したDBサーバープランを表します。
String
DBInstanceIdentifier
ユーザが指定したDBインスタンス名を表します。
これは、DBインスタンスを識別する一意のキーです。
String
DBInstanceStatus
現時点のDBインスタンスの状態を表します。
String
DBName
CreateDBInstanceを実施する際にDBNameを指定していた時は、
DBインスタンスが作成されたタイミングで初期DBが作成され、
DB名としてその値を返します。また、この名前は
DBインスタンスが存在している限り値を返します。
String
DBParameterGroups
※無効パラメータです。
DBParameterGroupStatus list
DBSecurityGroups
※無効パラメータです。
DBSecurityGroupMembership list
DBSubnetGroups
※無効パラメータです。
DBSubnetGroup
Endpoint
DB接続に使用するエンドポイントを表します。
Endpoint
Engine
DBインスタンスが作成されているDBエンジンの名前です。
String
EngineVersion
DBエンジンのバージョン情報です。
String
InstanceCreateTime
DBインスタンスが作成された日時です。
DataTime
LatesRestorableTime
リストア機能(point-in-time restore)を利用してDBインスタンスを復元できる、
最も新しい時間を表します。
DataTime
LicenseModel
DBインスタンスのライセンスモデル情報です。
String
MasterUsername
DBインスタンスのDB接続ユーザ名です。
String
MultiAZ
DBインスタンスが高可用性構成を表します。
Boolean
OptionGroupMembership
※無効パラメータです。
OptionGroupMembership

Event

概要
このデータタイプは、以下のAPIのレスポンスに含まれています。
・DescribeEvents
DATA TYPE
Contents
Contents
パラメータ 説明 DATATYPE
Message
イベントの内容を示すメッセージ。
メッセージ一覧は以下のとおりです。
・Applying modification to allocated storage
・Applying modification to database instance class
・Backing up database instance
・DB instance restarted
・DB instance shutdown
・Database instance created
・Database instance deleted
・Disabled automated backups
・Enabled automated backups
・Finished applying modification to allocated storage
・Finished applying modification to database instance class
・Multi-AZ failover to standby complete - DNS propagation may take a few minutes
・Multi-AZ failover to standby started
・Restored from database instance <DBinstance名> to YYYY-MM-DD hh:mm:ss.s
・Sorry, Cannot Start CloudnMonitoring
String
SourceType
イベント発生元のタイプ。現在のところ、db-instanceのイベントのみ取得できます。
String
Date
イベントの発生時刻
DataTime
SourceIdentifier
イベント発生元の識別子。
SourceTypeがdb-instanceの場合、DBInstanceIdentifierとなります。
String

2. AmazonWebService RDS互換API

AmazonWebService RDS互換APIは以下の通りです。

2.1. DBインスタンスの管理

DBインスタンスを管理するためのAPIコマンドです。

CreateDBInstance - DB インスタンス作成

概要
新規にDBインスタンスを作成するAPIです。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します

リクエストパラメータ一覧
パラメータ名 説明 必須 DATA TYPE
AllocatedStorage
DBインスタンスに割り当てられるDBディスク容量です。単位はGBとなります。

有効値: 30 | 100 | 300
Yes Integer
AutoMinorVersionUpgrade
※ リクエスト可能ですが、無効なパラメータです。

デフォルト値: true
No Boolean
AvailabilityZone
DBインスタンスが作成されるゾーンを指定できます。初期値は弊社システムにて指定します。

有効値:jp-e1a | jp-e1b
No String
BackupRetentionPeriod
自動バックアップ機能によるバックアップデータを何日間分保存するかを指定できます。
0を指定すると自動バックアップ機能を無効化します。

デフォルト値: 1
制限:指定可能な数字は0-35です。
No Integer
CharacterSetName
※ リクエスト可能ですが、無効なパラメータです。    
No String
DBInstanceClass
作成するDBインスタンスのCPU/メモリ量を指定できます。
DBサーバープランとCPU/メモリ量の対応は、以下のURLでご確認をお願いします。

有効値: db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge
Yes String
DBInstanceIdentifier
作成されるDBインスタンス名です。

制限:1~63文字以内での指定が可能で、利用可能文字は英数字とハイフンです。
   最初の1文字は英字でなればなりません。 ハイフンは最後の文字として利用できず、
   また、連続して利用できません。

例: my-db-instance
Yes String
DBName
作成されるデータベースの名前を指定できます。このパラメータを指定しないと、
CreateDBInstanceのAPIに対する処理実行タイミングでは、
作成されたDBインスタンスに対して初期データベースの作成を実施しません。

制限: 1~64文字以内の英数字とアンダースコアのみ指定可能です。
   数字のみの文字列は指定できません。
   指定されたDBエンジンの予約語は指定できません。
No String
DBParameterGroupName
※ リクエスト可能ですが無効なパラメータです。
No String
DBSecurityGroups.member.N
DBセキュリティグループのリストは、作成されるDBインスタンスに関連付けられます。
最大で3個のDBセキュリティグループをDBインスタンスへ関連付けることができます。

デフォルト値:default DBセキュリティグループが指定されます。
No String list
DBSubnetGroupName
※ リクエスト可能ですが無効なパラメータです。
No String
Engine
作成されるDBインスタンスで使用するDBエンジンの名前を指定します。

有効値:MySQL
Yes String
EngineVersion
利用するDBエンジンのバージョンを指定します。

有効値: 5.6.19 | 5.6.27 | 5.6.30 | 5.7.15
例: 5.6.30
No String
LicenseModel
作成されるDBインスタンスのライセンスモデル情報です。

有効値: general-public-license
No String
MasterUserPassword
お客様が指定したDB接続ユーザ(MasterUsername)で、
DBインスタンスへ接続するためのパスワードです。

制限: 8~41文字以内の英数字のみ指定可能です。
Yes String
MasterUsername
DB接続ユーザ名です。お客様が、DBインスタンスへ接続する際に必要です。

制限: 1~16文字以内の英数字のみ指定可能です。 最初の1文字は英字でなればなりません。
指定されたDBエンジンの予約語にすることはできません。
Yes String
MultiAZ
DBインスタンスを複数ゾーン冗長構成(Multi-AZ)で構築するかを指定します。
No Boolean
OptionGroupName
※ リクエスト可能ですが無効なパラメータです。
No String
Port
作成したDBインスタンスへの接続を受け付けるポート番号です。

デフォルト値:3306
有効値:1150~65535 (4949/7801/12812/30022を除く)
No Integer
PreferredBackupWindow
自動バックアップを実施する時間を指定します。自動バックアップ中は、
パフォーマンスが若干低下いたしますので、利用頻度の少ない時間帯を指定いただけますと、
快適にご利用になれます。デフォルト値:システムがランダムに指定する240分間です。

制限:指定書式はhh24:mi-hh24:miです。時刻指定は世界標準時(UTC)です。
   PreferredMaintenanceWindowと同一時間は指定できません。
   指定可能期間は240分固定です。開始時間に02:00から11:00(UTC)は指定できません。
No String
PreferredMaintenanceWindow
システムメンテナンスの発生しうる時間帯を、週時で指定します。
指定時間帯はUTCでの指定をお願いします。
本時間帯に、お客様データベースに対してアップデート等のメンテナンス作業を実施します。

フォーマット:ddd:hh24:mi-ddd:hh24:mi (dddの有効値: mon、tue、wed、fri、sat、sun)
例:sat:06:00-sat:11:00
デフォルト値:システムがランダムに設定する300分間です。
制限:指定可能期間は300分固定です。
No String
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ 説明 DATA TYPE
AllocatedStorage
GB単位で指定した、割り当てられるDBディスク容量です。
Integer
AutoMinorVersionUpgrade
※無効パラメータです。
Boolean
AvailabilityZone
DBインスタンスが作成されたゾーンを表します。
String
BackupRetentionPeriod
自動バックアップ機能で取得したデータを保持する日数を表します。
Integer
CharacterSetName
※無効パラメータです。
String
DBInstanceClass
指定したDBサーバープランを表します。
String
DBInstanceIdentifier
ユーザが指定したDBインスタンス名を表します。
この識別子は、DBインスタンスを識別する一意のキーです。
String
DBInstanceStatus
現時点のDBインスタンスの状態を表します。

有効値:availablel | creating | modifying | rebooting | deleting
    backing-up |resetting-master-credentials
    failed | incompatible-restore
    incompatible-parameters |storage-full  
String
DBName
CreateDBInstanceを実施する際にDBNameを指定していた時は、
DBインスタンスが作成されたタイミングで初期DBが作成され、
DB名としてその値を返します。また、この名前はDBインスタンス
が存在している限り値を返します。
String
DBParameterGroups
※無効パラメータです。


DBParameter GroupStatus list
DBSecurityGroups
DBセキュリティグループの項目の内、DBSecurityGroup.Nameと
DBSecurityGroup.Statusのみを表します。
DBSecurity GroupMembership
DBSubnetGroup
※無効パラメータです。

DBSubnet
Group
Endpoint
DB接続に使用するエンドポイントを表します。
Endpoint
Engine
DBインスタンスが作成されているDBエンジンの名前です。
String
EngineVersion
DBエンジンのバージョン情報です。            
String
InstanceCreateTime
DBインスタンスが作成された日時です。
DateTime
LatestRestorableTime
リカバリ機能を利用してデータベースをリストアできる、最も新しい時間を表します。
DataTime
LicenseModel
DBインスタンスのライセンスモデル情報です。
String
MasterUsername
DBインスタンスのDB接続ユーザ名です。
String
MultiAZ
DBインスタンスが複数ゾーン冗長構成(Multi-AZ)かを表します。
Boolean
OptionGroupMembership
※無効パラメータです。


Option Group Membership
PendingModifiedValues
※無効パラメータです。


Pending Modified Values
PreferredBackupWindow
自動バックアップ機能を有効にしていた場合の、バックアップ取得時間帯を表します。
String
PreferredMaintenanceWindow
システムメンテナンスが発生した時に、実際にメンテナンス作業が実行される
週次の実施時間帯を表します。
String
ReadReplicaDBInstanceIdentifiers
※無効パラメータです。
String list
ReadReplicaSourceDBInstanceIdentifier
※無効パラメータです。
String
サンプルAPIコール&レスポンス
以下の例ではkick_api.rbを用いて、db-instance-nameという名前のDBインスタンスを作成しています。
DBサーバープランとしてdb.m1.small、ディスク容量30GB、DB接続ユーザ名db_username、DB接続パスワードdb_passwordを指定しています。
サンプルAPIコール
$ruby kick_api.rb Action=CreateDBInstance \
 Engine=MySQL \
 MasterUsername=db_username \
 AllocatedStorage=30 \
 EngineVersion=5.6.27 \
 DBInstanceClass=db.m1.small \
 DBInstanceIdentifier=db-instance-name \
 MasterUserPassword=db_password \
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<CreateDBInstanceResponse xmlns="http://api.rdb.cloudn-service.com/">
 <CreateDBInstanceResult>
   <DBInstance>
     <ReadReplicaDBInstanceIdentifiers/>
     <LatestRestorableTime></LatestRestorableTime>
     <Engine>mysql</Engine>
     <DBName/>
     <PendingModifiedValues/>
     <BackupRetentionPeriod>1</BackupRetentionPeriod>
     <MultiAZ>false</MultiAZ>
     <LicenseModel>general-public-license</LicenseModel>
     <DBInstanceStatus>creating</DBInstanceStatus>
     <EngineVersion>5.6.27</EngineVersion>
     <Endpoint>
       <Port>3306</Port>
       <Address/>
     </Endpoint>
     <DBInstanceIdentifier>db-instance-name</DBInstanceIdentifier>
     <DBParameterGroups>
       <DBParameterGroup>
         <ParameterApplyStatus>in-sync</ParameterApplyStatus>
         <DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
       </DBParameterGroup>
     </DBParameterGroups>
     <DBSecurityGroups>
       <DBSecurityGroup>
         <Status>adding</Status>
         <DBSecurityGroupName>default</DBSecurityGroupName>
       </DBSecurityGroup>
     </DBSecurityGroups>
     <PreferredBackupWindow>16:00-20:00</PreferredBackupWindow>
     <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
     <PreferredMaintenanceWindow>sat:06:00-sat:11:00</PreferredMaintenanceWindow>
     <AvailabilityZone>jp-e1a</AvailabilityZone>
     <InstanceCreateTime/>
     <AllocatedStorage>30</AllocatedStorage>
     <DBInstanceClass>db.m1.small</DBInstanceClass>
     <MasterUsername>db_username</MasterUsername>
     <CloudnPaaSLinkStatus>unregistered</CloudnPaaSLinkStatus>
   </DBInstance>
 </CreateDBInstanceResult>
 <ResponseMetadata>
   <RequestId>job-6492c892cefc6e36162a064416cd6b13</RequestId>
 </ResponseMetadata>
</CreateDBInstanceResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBInstanceAlreadyExists
指定したDBインスタンス名は、既に存在しています。
HTTP Status Code:400
DBParameterGroupNotFound
指定したDBParameterGroupは存在していません。
HTTP Status Code:404
DBSecrityGroupNotFound
指定したDBセキュリティグループは存在していません。
HTTP Status Code:404
DBSubnetGroupNotFound
指定したDBSubnetGroupは存在していません。
HTTP Status Code:400
InstanceQuotaExceeded
要求は、作成可能DBインスタンス数の上限を超えています。
HTTP Status Code:400
InsufficientDBInstanceCapacity
指定したDBサーバープランは、指定したゾーンでは作成できません。
HTTP Status Code:400
InvalidVPCNetworkState
DBインスタンスが作成された時、DBSubnetGroup内に収まっていません。
HTTP Status Code:400
OptionGroupNotFound HTTP Status Code:400
ProvisionedIopsNotAvailableInAZ
指定されたゾーンでは、Iopsの指定はできません。
HTTP Status Code:400
StorageQuotaExceeded
全てのDBインスタンスで使用可能なディスク容量を超えています。
HTTP Status Code:400

DeleteDBInstance - DBインスタンス削除

概要
作成済みのDBインスタンスを削除するAPIです。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
DBInstanceIdentifier
削除対象のDBインスタンス名を指定します。また、
このパラメータは大文字と小文字を区別しません。

制限:1~63文字以内の英数字のみ指定可能です。
   最初の1文字は英字でなればなりません。
   ハイフンは最後の文字として利用できず、また連続して利用できません。 
Yes String
FinalDBSnapshotIdentifier
※リクエスト可能ですが無効なパラメータです。
No String
SkipFinalSnapshot
※現在trueのみ有効です。trueを指定してください。
DBインスタンスを削除する前に、DBSnapshotを作成するかを指定します。
“true”に設定するとSnapshotは作成されず、
“false”に設定するとSnapshotが作成されます。

注意 このパラメータを“false”で指定する場合は、
   FinalDBSnapshotIdentifierを指定してはいけません。

Yes (Mast erの

場合)

Boolean
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ 説明 DATATYPE
AllocatedStorage
GB単位で指定した、割り当てられるDBディスク容量です。
Integer
AutoMinorVersionUpgrade
※無効パラメータです。
Boolean
AvailabilityZone
DBインスタンスが配置されたゾーンを示します。
String
BackupRetentionPeriod
自動バックアップ機能で取得したバックアップデータの保持日数を表します。
Integer
CharacterSetName
CharacterSetNameが設定されていた場合は、その値を返します。
String
DBInstanceClass
DBサーバープランを表します。
String
DBInstanceIdentifier
ユーザが指定したDBインスタンス名を表します。
この識別子は、DBインスタンスを識別する一意のキーです。
String
DBInstanceStatus
現時点のDBインスタンスの状態を表します。

有効値:availablel | creating | modifying | rebooting | deleting |
    backing-up |resetting-master-credentials | failed | incompatible-restore |
    incompatible-parameters |storage-full
String
DBName
CreateDBInstanceを実施する際にDBNameを指定していた時は、
DBインスタンスが作成されたタイミングで初期DBが作成され、
DB名としてその値を返します。
また、この名前はDBインスタンスが存在している限り値を返します。
String
DBParameterGroups
※無効パラメータです。




DB Parameter Group Status list
DBSecurityGroups
DBSecurityGroupの項目の内、DBSecurityGroup.NameとDBSecurityGroup.Statusを表します。



DB Security Group Membership list
DBSubnetGroup
※無効パラメータです。
DBSubnetGroup
Endpoint
DB接続時のエンドポイントを表します。
Endpoint
Engine
DBエンジンの名前です。現在提供されているのはMySQLのみです。
String
EngineVersion
DBエンジンのバージョン情報です。
String
InstanceCreateTime
DBインスタンスの作成日時です。
DateTime
LatestRestorableTime
リストア機能(point-in-time restore)を利用してDBインスタンスをリストアできる、
最も新しい時間を表します。
DataTime
LicenseModel
DBインスタンスのライセンスモデル情報です。
String
MasterUsername
DBインスタンスのDB接続ユーザ名です。
String
MultiAZ
DBインスタンスが複数拠点冗長構成(Multi-AZ)で構成されているかを表します。
Boolean
OptionGroupMembership
※無効パラメータです。

OptionGroup Membership
PendingModifiedValues
※無効パラメータです。

Pending Modified
PreferredBackupWindow
自動バックアップ機能を有効にしていた場合の、バックアップデータ取得時間帯を表します。
String
PreferredMaintenanceWindow
システムメンテナンスが発生した時に、実際にメンテナンス作業が実行される、
週次の実施時間帯を表します。
String
ReadReplicaDBInstanceIdentifiers
このDBインスタンスに紐づくリードレプリカ名を表します。
String list
ReadReplicaSourceDBInstanceIdentifier
このDBインスタンスがリードレプリカの接続先DBインスタンスを表します。
String
サンプルAPIコール&レスポンス
サンプルAPIコール

以下の例ではkick_api.rbを用いて、db-instance-nameという名前のDBインスタンスを削除しています。

$ruby kick_api.rb Action=DeleteDBInstance \
 SkipFinalSnapshot=true \
 DBInstanceIdentifier=db-instance-name
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<DeleteDBInstanceResponse xmlns="http://api.rdb.cloudn-service.com/">
 <DeleteDBInstanceResult>
   <DBInstance>
     <ReadReplicaDBInstanceIdentifiers/>
     <LatestRestorableTime></LatestRestorableTime>
     <Engine>mysql</Engine>
     <DBName/>
     <PendingModifiedValues/>
     <BackupRetentionPeriod>1</BackupRetentionPeriod>
     <MultiAZ>false</MultiAZ>
     <LicenseModel>general-public-license</LicenseModel>
     <DBInstanceStatus>deleting</DBInstanceStatus>
     <EngineVersion>5.5.28</EngineVersion>
     <Endpoint>
       <Port>3306</Port>
       <Address>db-instance-name.2efo1thk3hhcw33b2cfhb93wbuw.jp-e1.rdb.cloudn-service.com</Address>
     </Endpoint>
     <DBInstanceIdentifier>db-instance-name</DBInstanceIdentifier>
     <DBParameterGroups>
       <DBParameterGroup>
         <ParameterApplyStatus>in-sync</ParameterApplyStatus>
         <DBParameterGroupName>default.mysql5.5</DBParameterGroupName>
       </DBParameterGroup>
     </DBParameterGroups>
     <DBSecurityGroups>
       <DBSecurityGroup>
         <Status>adding</Status>
         <DBSecurityGroupName>default</DBSecurityGroupName>
       </DBSecurityGroup>
     </DBSecurityGroups>
     <PreferredBackupWindow>16:00-20:00</PreferredBackupWindow>
     <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
     <PreferredMaintenanceWindow>sat:06:00-sat:11:00</PreferredMaintenanceWindow>
     <AvailabilityZone>jp-e1a</AvailabilityZone>
     <InstanceCreateTime/>
     <AllocatedStorage>30</AllocatedStorage>
     <DBInstanceClass>db.m1.small</DBInstanceClass>
     <MasterUsername>db_username</MasterUsername>
     <CloudnPaaSLinkStatus>unregistered</CloudnPaaSLinkStatus>
   </DBInstance>
 </DeleteDBInstanceResult>
 <ResponseMetadata>
   <RequestId>job-1487c0be76ebfb964be9fe8117e8efe2</RequestId>
 </ResponseMetadata>
</DeleteDBInstanceResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBInstanceNotFound
指定したDBインスタンス名は存在していません。
HTTP Status Code:404
DBSnapshotAlreadyExists
指定したDBSnapshotIdentifierは既に存在しています。
HTTP Status Code:400
InvalidDBInstanceState
指定したDBインスタンスは削除可能なステータスではありません。
HTTP Status Code:400
SnapshotQuotaExceeded
Snapshotの要求が、Diskの契約容量を超えてしまったため実施できません。
HTTP Status Code:400

DescribeDBInstances - DBインスタンス詳細情報取得

概要
作成済みDBインスタンスの詳細情報を取得するAPIです。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
DBInstanceIdentifier
作成されるDBインスタンス名です。表示したいDBインスタンス名をDBInstanceIdentifier
キーに指定します。DBInstanceIdentifierキーを省略すれば、
すべてのDBインスタンス情報が表示されます。
このパラメータは大文字小文字を区別しません。

制限:1~63文字以内での指定が可能で、利用可能文字は英数字とハイフンです。
   最初の1文字は英字でなればなりません。
   ハイフンは最後の文字として利用できず、また、連続して利用できません。
No String
Marker
※無効パラメータです。
No String
MaxRecords
※無効パラメータです。
No Integer
Body
  • 無し
レスポンス
レスポンス (Body)
Response(Body)
パラメータ 説明 DATATYPE
DBInstances DBインスタンスの情報です。 DB Instance
Marker ※無効パラメータです。 String
サンプルAPIコール&レスポンス
サンプルAPIコール
以下の例ではkick_api.rbを用いて、作成済みDBインスタンス一覧を表示しています。
$ruby kick_api.rb Action=DescribeDBInstances
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<DescribeDBInstancesResponse xmlns="http://api.rdb.cloudn-service.com/">
 <DescribeDBInstancesResult>
   <DBInstances>
   <DBInstance>
     <ReadReplicaDBInstanceIdentifiers/>
     <LatestRestorableTime></LatestRestorableTime>
     <Engine>mysql</Engine>
     <DBName/>
     <PendingModifiedValues/>
     <BackupRetentionPeriod>1</BackupRetentionPeriod>
     <MultiAZ>false</MultiAZ>
     <LicenseModel>general-public-license</LicenseModel>
     <DBInstanceStatus>failed</DBInstanceStatus>
     <EngineVersion>5.5.28</EngineVersion>
     <Endpoint>
       <Port>3306</Port>
       <Address>db-instance-name.2efo1thk3hhcw33b2cfhb93wbuw.jp-e1.rdb.cloudn-service.com</Address>
     </Endpoint>
     <DBInstanceIdentifier>db-instance-name</DBInstanceIdentifier>
     <DBParameterGroups>
       <DBParameterGroup>
         <ParameterApplyStatus>in-sync</ParameterApplyStatus>
         <DBParameterGroupName>default.mysql5.5</DBParameterGroupName>
       </DBParameterGroup>
     </DBParameterGroups>
     <DBSecurityGroups>
       <DBSecurityGroup>
         <Status>adding</Status>
         <DBSecurityGroupName>default</DBSecurityGroupName>
       </DBSecurityGroup>
     </DBSecurityGroups>
     <PreferredBackupWindow>16:00-20:00</PreferredBackupWindow>
     <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
     <PreferredMaintenanceWindow>sat:06:00-sat:11:00</PreferredMaintenanceWindow>
     <AvailabilityZone>jp-e1a</AvailabilityZone>
     <InstanceCreateTime/>
     <AllocatedStorage>30</AllocatedStorage>
     <DBInstanceClass>db.m1.small</DBInstanceClass>
     <MasterUsername>db_username</MasterUsername>
     <CloudnPaaSLinkStatus>unregistered</CloudnPaaSLinkStatus>
   </DBInstance>
   </DBInstances>
 </DescribeDBInstancesResult>
 <ResponseMetadata>
   <RequestId>job-1de5a1f7b166b3da1b4b8b6aaa8c1aff</RequestId>
 </ResponseMetadata>
</DescribeDBInstancesResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBInstanceNotFound
指定したDBインスタンス名は存在していません。
HTTP Status Code:404

ModifyDBInstance - DBインスタンスリソース変更

概要
作成済みDBインスタンスのリソースや設定を変更するAPIです。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
AllocatedStorage
DBインスタンスのDBディスク容量を拡張するパラメータです。単位はGB単位となります。

デフォルト値:利用中のDBディスク容量
制限1:DBディスク容量の縮小はできません。
制限2:300GBへの拡張はできません。
代替案として、新規にDBインスタンス作成し、データを移行することでご対応いただけます。

有効値:30 | 100
No Integer
AllowMajorVersionUpgrade
※リクエスト可能ですが、無効なパラメータです。
No Boolean
ApplyImmediately
このAPIで指定した変更を即時反映させるか、
PreferredMaintenanceWindowで反映させるかを設定します。
この値が“false”の場合は、設定変更は「RebootDBInstance」API実行時、
またはメンテナンス時に実行されます。

有効値:true
制限:true 固定での提供になります。
Yes Boolean
AutoMinorVersionUpgrade
※ リクエスト可能ですが、無効なパラメータです。
No Boolean
BackupRetentionPeriod
自動バックアップ機能で取得したバックアップデータを何日間分保持するかを指定できます。
0を指定すると自動バックアップ機能を無効化します。

デフォルト値:現在の設定値 制限:指定可能な数字は0から35までになります。

【注意】
設定変更には5分から10分程度のサービス停止が伴います。
停止時間はDBサーバープラン、DBディスク量によって変動いたします。
・設定値1~35→設定値0:停止を伴う
・設定値0→設定値1~35:停止を伴う
・設定値1~35→設定値1~35:停止しない
・設定値0→設定値0: 停止しない

【備考】
1~35から0に変更した場合、Latest Restorable Timeに以前の時刻が表示
されておりますが、動作に支障はありません。

No Integer
DBInstanceClass
変更するDBインスタンス のDBサーバープランを指定します。
変更にはサービス停止を伴います。

有効値:db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge
No String
DBInstanceIdentifier
変更しようとするDBインスタンス名です。

制限:存在しているDBインスタンス名でなければいけません。
   1~63文字以内での指定が可能で、利用可能文字は英数字とハイフンです。
   最初の1文字は英字でなればなりません。
   ハイフンは最後の文字として利用できず、また、連続して利用できません。

例:my-db-instance
Yes String
DBParameterGroupName
※リクエスト可能ですが、無効なパラメータです。
No String
DBSecurityGroups.member.N
当該DBインスタンスに設定されているDBセキュリティグループのリストです。

(注意)一部のDBSecurityGroupのみを指定して変更できません。
DBインスタンスに関連付ける全てのDBセキュリティグループ(最大3個まで)を指定ください。

例: 以下のように指定します。
  DBSecurityGroups.member.1=sample1, DBSecurityGroups.member.2=sample2

制限:1から255文字の英数字でなければいけません。
   最初の1文字は英字でなればなりません。
   ハイフンは最後の文字として利用できず、また連続して利用できません。
No String list
EngineVersion
DBエンジンのバージョンを指定します。

MySQLのマイナーバージョンアップ機能を提供しています。
マイナーバージョンアップする際には、同一メジャーバージョンを指定する必要があります。
例: 現在のバージョンが5.5.28の場合には5.5.44は指定できますが、5.6.19は指定できません。

注意: メジャーバージョンアップ機能は提供しておりません。
有効値:5.5.44 | 5.5.46 | 5.5.49 | 5.5.52 | 5.6.19 | 5.6.27 | 5.6.30 | 5.6.33 | 5.7.15
No String
MasterUserPassword
※リクエスト可能ですが、無効なパラメータです。
No String
MultiAZ
※リクエスト可能ですが、無効なパラメータです。
No Boolean
OptionGroupName
※リクエスト可能ですが、無効なパラメータです。
No String
PreferredBackupWindow
※リクエスト可能ですが、無効なパラメータです。
No String
PreferredMaintenanceWindow
※リクエスト可能ですが、無効なパラメータです。
No String
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ 説明 DATA TYPE
AllocatedStorage
GB単位で指定した、割り当てられるDBディスク容量です。
Integer
AutoMinorVersionUpgrade
※無効パラメータです。
Boolean
AvailabilityZone
DBインスタンスが配置されたゾーンを表します。
String
BackupRetentionPeriod
自動バックアップ機能で取得したバックアップデータを保持する日数を表します。
Integer
CharacterSetName
CharacterSetNameが設定されていた場合は、その値を返します。
String
DBInstanceClass
指定したDBサーバープランを表します。
String
DBInstanceIdentifier
ユーザが指定したDBインスタンス名を表します。これは、DBインスタンスを識別する
一意のキーです。
String
DBInstanceStatus
現時点のDBインスタンスの状態を表します。

有効値:availablel | creating | modifying | rebooting | deleting |
    backing-up |failed | storage-full
String
DBName
CreateDBInstanceを実施する際にDBNameを指定していた時は、
DBインスタンスが作成されたタイミングで初期DBが作成され、
DB名としてその値を返します。
また、この名前はDBインスタンスが存在している限り値を返します。
String
DBParameterGroups
※無効パラメータです。
String
DBSecurityGroups
DBセキュリティグループの項目の内、DBSecurityGroup.Nameと
DBSecurityGroup.Statusのみを表します。
DBSecurityGroupMembership list
DBSubnetGroup
※無効パラメータです。
DBSubnetGroup
Endpoint
DB接続するエンドポイントを表します。
Endpoint
Engine
DBエンジンの名前です。
String
EngineVersion
DBエンジンのバージョン情報です。
String
InstanceCreateTime
DBインスタンスの作成日時です。
DateTime
LatestRestorableTime
リストア機能(point-in-time restore)を利用してDBインスタンスを復元できる、
最も新しい時間を表します。
DataTime
LicenseModel
DBインスタンスのライセンスモデル情報です。
String
MasterUsername
DBインスタンスのDB接続ユーザ名です。
String
MultiAZ
DBインスタンスが複数ゾーン冗長構成(Multi-AZ)で構成されているかを表します。
Boolean
OptionGroupMembership
※無効パラメータです。
OptionGroupMembership
PendingModifiedValues
※無効パラメータです。
PendingModifiedValues
PreferredBackupWindow
自動バックアップ機能を有効にしていた場合の、バックアップデータ取得時間帯を
表します。
String
PreferredMaintenanceWindow
システムメンテナンスが発生した時に、実際にメンテナンス作業が実行される、
週次の実施時間帯を表します。
String
ReadReplicaDBInstanceIdentifiers
このDBインスタンスに紐づくリードレプリカ名を表します。
String list
ReadReplicaSourceDBInstanceIdentifier
このDBインスタンスがリードレプリカだった時に、接続先DBインスタンス名を表します。
String
サンプルAPIコール&レスポンス
以下の例では、kick_api.rbを用いて、バックアップデータ保持期間を10日に変更しています。
サンプルAPIコール
ruby kick_api.rb Action=ModifyDBInstance \
 ApplyImmediately=true \
 DBInstanceIdentifier=db-instance-name \
 BackupRetentionPeriod=10
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<ModifyDBInstanceResponse xmlns="http://api.rdb.cloudn-service.com/">
 <ModifyDBInstanceResult>
   <DBInstance>
     <ReadReplicaDBInstanceIdentifiers/>
     <LatestRestorableTime>2014-09-01T05:53:34Z</LatestRestorableTime>
     <Engine>mysql</Engine>
     <DBName/>
     <PendingModifiedValues>
       <BackupRetentionPeriod>10</BackupRetentionPeriod>
     </PendingModifiedValues>
     <BackupRetentionPeriod>1</BackupRetentionPeriod>
     <MultiAZ>false</MultiAZ>
     <LicenseModel>general-public-license</LicenseModel>
     <DBInstanceStatus>modifying</DBInstanceStatus>
     <EngineVersion>5.5.28</EngineVersion>
     <Endpoint>
       <Port>3306</Port>
       <Address>db-instance-name.2efo1thk3hhcw33b2cfhb93wbuw.jp-e1.rdb.cloudn-service.com</Address>
     </Endpoint>
     <DBInstanceIdentifier>db-instance-name</DBInstanceIdentifier>
     <DBParameterGroups>
       <DBParameterGroup>
         <ParameterApplyStatus>in-sync</ParameterApplyStatus>
         <DBParameterGroupName>default.mysql5.5</DBParameterGroupName>
       </DBParameterGroup>
     </DBParameterGroups>
     <DBSecurityGroups>
       <DBSecurityGroup>
         <Status>active</Status>
         <DBSecurityGroupName>default</DBSecurityGroupName>
       </DBSecurityGroup>
     </DBSecurityGroups>
     <PreferredBackupWindow>16:00-20:00</PreferredBackupWindow>
     <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
     <PreferredMaintenanceWindow>sat:06:00-sat:11:00</PreferredMaintenanceWindow>
     <AvailabilityZone>jp-e1a</AvailabilityZone>
     <InstanceCreateTime>2014-08-29 07:21:18 UTC</InstanceCreateTime>
     <AllocatedStorage>30</AllocatedStorage>
     <DBInstanceClass>db.m1.small</DBInstanceClass>
     <MasterUsername>db_username</MasterUsername>
     <CloudnPaaSLinkStatus>unregistered</CloudnPaaSLinkStatus>
   </DBInstance>
 </ModifyDBInstanceResult>
 <ResponseMetadata>
   <RequestId>job-92ab4d6e68fab0215d4189bb47e4e2d6</RequestId>
 </ResponseMetadata>
</ModifyDBInstanceResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBInstanceNotFound
指定したDBインスタンスは存在していません。
HTTP Status Code:404
DBParameterGroupNotFound
指定したDBParameterGroupは存在していません。
HTTP Status Code:404
DBSecrityGroupNotFound
指定したDBセキュリティグループは存在していません。
HTTP Status Code:404
InsufficientDBInstanceCapacity
指定したDBサーバープランは、指定したゾーンでは作成できません。
HTTP Status Code:400
InvalidDBInstanceState
指定したDBインスタンスのステータスはavailableではありません。
HTTP Status Code:400
InvalidDBSecurityGroupState
DBセキュリティグループのステータスは、削除を許容しません。
HTTP Status Code:400
InvalidVPCNetworkState
変更後のDBセキュリティグループが、ゾーンを含んでいません。
HTTP Status Code:400
StorageQuotaExceeded
全てのDBインスタンスで使用可能なDBストレージ量を超えています。
HTTP Status Code:400

RebootDBInstance - DBインスタンス再起動

概要
DBインスタンスを再起動するAPIです。このAPIは即時実行され、実行中はステータスが“rebooting”になります。
また、複数ゾーン冗長構成(Multi-Zone)の場合は、ForceFailoverオプションにより、DBインスタンスのゾーンの変更有無を指定することが出来ます。
ForceFailover=trueとした場合に、ゾーンが変更されます。再起動が完了したら、イベントに出力されます。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
DBInstanceIdentifier
DBインスタンス名です。この値が設定されている場合のみ、結果が表示されます。

制限:1~63文字以内での指定が可能で、利用可能文字は英数字とハイフンです。
   最初の1文字は英字でなればなりません。
   ハイフンは最後の文字として利用できず、また、連続して利用できません。
Yes String
ForceFailover
複数ゾーン冗長構成(Multi-AZ)の場合に指定可能です。
“true”を指定すると、フェイルオーバされます。

制限:単一ゾーン構成では“true”を指定できません
No Boolean
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ 説明 DATATYPE
AllocatedStorage
GB単位で指定した、割り当てられるDBディスク容量です。
Integer
AutoMinorVersionUpgrade
※無効パラメータです。
Boolean
AvailabilityZone
DBインスタンスが作成されたゾーンを表します。
String
BackupRetentionPeriod
自動バックアップ機能のバックアップデータ保持日数を表します。
Integer
CharacterSetName
CharacterSetNameが設定されていた場合は、その値を返します。
String
DBInstanceClass
指定したDBサーバープランを表します。
String
DBInstanceIdentifier
DBインスタンス名を表します。この識別子は、DBインスタンスを識別する一意のキーです。
String
DBInstanceStatus
現時点のDBインスタンスのステータスを表します。

有効値:availablel | creating | modifying | rebooting | deleting |
    backing-up | failed | storage-full
String
DBName
CreateDBInstanceを実施する際にDBNameを指定していた時は、
DBインスタンスが作成されたタイミングで初期DBが作成され、
DB名としてその値を返します。また、
この名前はDBインスタンスが存在している限り値を返します。
String
DBParameterGroups
※無効パラメータです。


DB Parameter GroupStatus list
DBSecurityGroups
DBセキュリティグループの項目の内、
DBSecurityGroup.NameとDBSecurityGroup.Statusのみを表します。

DBSecurity GroupMembership list
DBSubnetGroup
※無効パラメータです。
DBSubnetGroup
Endpoint
DB接続に使うエンドポイントを表します。
Endpoint
Engine
DBインスタンスが作成されているDBエンジンの名前です。
String
EngineVersion
DBエンジンのバージョン情報です。
String
InstanceCreateTime
DBインスタンスが作成された日時です。
DateTime
LatestRestorableTime
リストア機能(point-in-time restore)を利用してDBインスタンスを復元できる、
最も新しい時間を表します。
DataTime
LicenseModel
DBインスタンスのライセンスモデル情報です。
String
MasterUsername
DBインスタンスのDB接続ユーザ名です。
String
MultiAZ
DBインスタンス高可用性構成を表します。
Boolean
OptionGroupMembership
※無効パラメータです。
OptionGroupMembership
PendingModifiedValues
※無効パラメータです。

Pending ModifiedValues
PreferredBackupWindow
自動バックアップ機能を有効にしていた場合の、バックアップデータ取得時間帯を表します。
String
PreferredMaintenanceWindow
システムメンテナンスが発生した時に、実際にメンテナンス作業が実行される、
週次の実施時間帯を表します。
String
ReadReplicaDBInstanceIdentifiers
このDBインスタンスに紐づくリードレプリカ名を表します。
String list
ReadReplicaSourceDBInstanceIdentifier
このDBインスタンスがリードレプリカだった時に、接続先DBインスタンス名を表します。
String
サンプルAPIコール&レスポンス

以下の例では、kick_api.rbを用いてdb-instance-nameという名前のDBインスタンスを再起動しています。

サンプルAPIコール
$ruby kick_api.rb Action=RebootDBInstance DBInstanceIdentifier=db-instance-name
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<RebootDBInstanceResponse xmlns="http://api.rdb.cloudn-service.com/">
 <RebootDBInstanceResult>
   <DBInstance>
     <ReadReplicaDBInstanceIdentifiers/>
     <LatestRestorableTime>2014-09-01T05:58:39Z</LatestRestorableTime>
     <Engine>mysql</Engine>
     <DBName/>
     <PendingModifiedValues/>
     <BackupRetentionPeriod>10</BackupRetentionPeriod>
     <MultiAZ>false</MultiAZ>
     <LicenseModel>general-public-license</LicenseModel>
     <DBInstanceStatus>rebooting</DBInstanceStatus>
     <EngineVersion>5.5.28</EngineVersion>
     <Endpoint>
       <Port>3306</Port>
       <Address>db-instance-name.2efo1thk3hhcw33b2cfhb93wbuw.jp-e1.rdb.cloudn-service.com</Address>
     </Endpoint>
     <DBInstanceIdentifier>db-instance-name</DBInstanceIdentifier>
     <DBParameterGroups>
       <DBParameterGroup>
         <ParameterApplyStatus>in-sync</ParameterApplyStatus>
         <DBParameterGroupName>default.mysql5.5</DBParameterGroupName>
       </DBParameterGroup>
     </DBParameterGroups>
     <DBSecurityGroups>
       <DBSecurityGroup>
         <Status>active</Status>
         <DBSecurityGroupName>default</DBSecurityGroupName>
       </DBSecurityGroup>
     </DBSecurityGroups>
     <PreferredBackupWindow>16:00-20:00</PreferredBackupWindow>
     <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
     <PreferredMaintenanceWindow>sat:06:00-sat:11:00</PreferredMaintenanceWindow>
     <AvailabilityZone>jp-e1a</AvailabilityZone>
     <InstanceCreateTime>2014-08-29 07:21:18 UTC</InstanceCreateTime>
     <AllocatedStorage>30</AllocatedStorage>
     <DBInstanceClass>db.m1.small</DBInstanceClass>
     <MasterUsername>db_username</MasterUsername>
     <CloudnPaaSLinkStatus>unregistered</CloudnPaaSLinkStatus>
   </DBInstance>
 </RebootDBInstanceResult>
 <ResponseMetadata>
   <RequestId>job-12bf86d3d4d35d2da6f84ff3cc8599fa</RequestId>
 </ResponseMetadata>
</RebootDBInstanceResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBInstanceNotFound
指定したDBインスタンス名は存在していません。
HTTP Status Code:404
InvalidDBInstanceState
指定したDBインスタンスのステータスが“available”ではありません。
HTTP Status Code:400

RestoreDBInstanceToPointInTime - DBインスタンスのリストア

概要
任意の指定した時点にDBインスタンスをリストアするAPIです。
BackupRetentionPeriodで指定した期間内に対して、リストア可能です。
リストアされるDBは、元のDBと同じ構造で作成されます。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
AutoMinorVersionUpgrade
※ リクエスト可能ですが、無効なパラメータです。

デフォルト値:true
No Boolean
AvailabilityZone
DBインスタンスが作成されるゾーンを指定できます。
初期値は弊社システムにて指定します。

有効値:jp-e1a | jp-e1b
No String
DBInstanceClass
リストアされるDBインスタンスのDBサーバープランを指定します。

デフォルト値:現在利用中のDBサーバープラン
有効値:db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge
No String
DBName
リストアされるDBの名前を指定できます。

Note:このパラメータは、MySQLでは利用できません。
No String
DBSecurityGroups.member.N
DBセキュリティグループのリストは、リストア元DBインスタンスに関連付けられます。
任意のDBセキュリティグループ
を指定し、そのDBインスタンスへ関連付けることができます。
最大で3個のDBセキュリティグループをDBインスタンスへ関連付けることができます。

デフォルト値:default DBセキュリティグループが適用されます。
No String list
DBSubnetGroupName
※リクエスト可能ですが、無効なパラメータです。
No String
Engine
リストアされたDBインスタンスで使用するDBエンジンです。
MySQLのみ指定可能です。

デフォルト値:リストア元と同じDBエンジン
例:MySQL
No String
LicenseModel
リストアされるDBインスタンスのライセンスモデル情報です。

デフォルト値:リストア元DBインスタンスと同じライセンスモデル
有効値:general-public-license
No String
MultiAZ
DBインスタンスを複数ゾーン冗長構成(Multi-AZ)の構成で構築するかを指定します。

デフォルト値:false
制限:MultiAZパラメータがtrueに設定されている場合は、AvailabilityZone
   を設定することはできません。
No Boolean
OptionGroupName
※リクエスト可能ですが、無効なパラメータです。
No String
Port
作成したDBへの接続を受け付けるPort番号です。

有効値:1150~65535(4949/7801/12812/30022を除く)
デフォルト値:リストア元と同じPort番号
No Integer
RestoreTime
リストアする時点を日時で指定します。

有効値:UTCで指定しなければなりません
制限:「LatestRestorableTime」より以前の時間でなければいけません
    UseLatestRestorableTimeが“true”の場合は指定できません
例:2013-01-10T23:45:15Z
No DateTime
SourceDBInstanceIdentifier
リストアする元となるDBインスタンス名です。

制限:存在している値の指定が必要1から63文字の英数字かハイフンのみ利用可能
   最初の1文字目は英字のみ利用可能ハイフンは最後の文字として利用できず、
   また、連続して利用できません
Yes String
TargetDBInstanceIdentifier
リストアする先となるDBインスタンス名です。

制限:1から63文字の英数字かハイフンのみ利用可能
   最初の1文字目は英字のみ利用可能ハイフンは最後の文字として利用できず、
   また、連続して利用できません
Yes String
UseLatestRestorableTime
DBインスタンスが最新のバックアップ時刻でリストアされるかどうかを、
true/falseで指定します。

デフォルト値:false
制限:RestoreTimeのパラメータが指定されている場合はtrueを指定できません。
No Boolean
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ 説明 DATATYPE
AllocatedStorage GB単位で指定した、割り当てられるDBディスク容量です。 Integer
AutoMinorVersionUpgrade ※無効パラメータです。 Boolean
AvailabilityZone DBインスタンスの配置ゾーンを表します。 String
BackupRetentionPeriod 自動バックアップ機能で取得したバックアップデータの保持日数を表します。 Integer
CharacterSetName ※無効パラメータです。 String
DBInstanceClass 指定したDBサーバープランを表します。 String
DBInstanceIdentifier ユーザが指定したDBインスタンス名を表します。 これは、DBインスタンスを識別する一意のキーです。 String
DBInstanceStatus
現時点のDBインスタンスのステータスを表します。

有効値:availablel | creating | modifying | rebooting | deleting |
    backing-up | failed | storage-full |
String
DBName CreateDBInstanceを実施する際にDBNameを指定していた時は、 DBインスタンスが作成されたタイミングで初期DBが作成され、DB名としてその値を返します。 また、この名前はDBインスタンスが存在している限り値を返します。 String
DBParameterGroups ※無効パラメータです。 DB Parameter Group Status list
DBSecurityGroups DBセキュリティグループの項目の内、 DBSecurityGroup.NameとDBSecurityGroup.Statusのみを表します。 DB Security Group Membership list
DBSubnetGroup ※無効パラメータです。 DBSubnetGroup
Endpoint エンドポイントを表します。 Endpoint
Engine DBインスタンスが利用するDBエンジン名です。 String
EngineVersion DBエンジンのバージョン情報です。 String
InstanceCreateTime DBインスタンスの作成日時です。 DateTime
LatestRestorableTime リストア機能(point-in-time restore)を利用してDBインスタンスをリストアできる、 最も新しい時間を表します。 DataTime
LicenseModel DBインスタンスのライセンスモデル情報です。 String
MasterUsername DBインスタンスのDB接続ユーザ名です。 String
MultiAZ DBインスタンスが複数ゾーン冗長構成(Multi-AZ)で構成されているかを表します。 Boolean
OptionGroupMembership ※無効パラメータです。 OptionGroup Membership
PendingModifiedValues ※無効パラメータです。 Pending Modified Values
PreferredBackupWindow 自動バックアップ機能を有効にしていた場合の、バックアップデータ取得時間帯を表します。 String
PreferredMaintenanceWindow システムメンテナンスが発生した時に、実際にメンテナンス作業が実行される、 週次の実施時間帯を表します。 String
ReadReplicaDBInstanceIdentifiers このDBインスタンスに紐づくリードレプリカ名を表します。 String list
ReadReplicaSourceDBInstanceIdentifier このDBインスタンスがリードレプリカだった時に、接続先DBインスタンス名を表します。 String
サンプルAPIコール&レスポンス
サンプルAPIコール

以下の例では、kick_api.rbを用いて2014-09-01 07:41:13時点のデータを元に、リストアしています。 リストア元のDBインスタンス名はdb-instance-name-2で、リストア先のDBインタンス名はdb-instance-name3となります。

$ruby kick_api.rb Action=RestoreDBInstanceToPointInTime \
 SourceDBInstanceIdentifier=db-instance-name-2 \
 TargetDBInstanceIdentifier=db-instance-name3 \
 RestoreTime=2014-09-01T07:41:13Z
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<RestoreDBInstanceToPointInTimeResponse xmlns="http://api.rdb.cloudn-service.com/">
 <RestoreDBInstanceToPointInTimeResult>
   <DBInstance>
     <ReadReplicaDBInstanceIdentifiers>
     </ReadReplicaDBInstanceIdentifiers>
     <LatestRestorableTime></LatestRestorableTime>
     <Engine>mysql</Engine>
     <DBName/>
     <PendingModifiedValues>
       <MasterUserPassword>****</MasterUserPassword>
       <AllocatedStorage>30</AllocatedStorage>
     </PendingModifiedValues>
     <BackupRetentionPeriod>10</BackupRetentionPeriod>
     <MultiAZ>false</MultiAZ>
     <LicenseModel>general-public-license</LicenseModel>
     <DBInstanceStatus>creating</DBInstanceStatus>
     <EngineVersion>5.5.28</EngineVersion>
     <Endpoint>
       <Port>3306</Port>
       <Address/>
     </Endpoint>
     <DBInstanceIdentifier>db-instance-name3</DBInstanceIdentifier>
     <DBParameterGroups>
       <DBParameterGroup>
         <ParameterApplyStatus>in-sync</ParameterApplyStatus>
         <DBParameterGroupName>default.mysql5.5</DBParameterGroupName>
       </DBParameterGroup>
     </DBParameterGroups>
     <DBSecurityGroups>
       <DBSecurityGroup>
         <Status>adding</Status>
         <DBSecurityGroupName>default</DBSecurityGroupName>
       </DBSecurityGroup>
     </DBSecurityGroups>
     <PreferredBackupWindow>16:00-20:00</PreferredBackupWindow>
     <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
     <PreferredMaintenanceWindow>sat:06:00-sat:11:00</PreferredMaintenanceWindow>
     <AvailabilityZone>jp-e1a</AvailabilityZone>
     <InstanceCreateTime/>
     <AllocatedStorage>30</AllocatedStorage>
     <DBInstanceClass>db.m1.small</DBInstanceClass>
     <MasterUsername>db_username</MasterUsername>
   </DBInstance>
 </RestoreDBInstanceToPointInTimeResult>
 <ResponseMetadata>
   <RequestId>job-039946781f393f02e6846c253aaeb823</RequestId>
 </ResponseMetadata>
</RestoreDBInstanceToPointInTimeResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBInstanceAlreadyExists
指定したDBインスタンス名は、既に存在しています。
HTTP Status Code:400
DBInstanceNotFound
指定したDBインスタンス名は、存在していません。
HTTP Status Code:404
DBSubnetGroupNotFound
指定したDBSubnetGroupは存在していません。
HTTP Status Code:400
InstanceQuotaExceeded
要求は、作成可能DBインスタンス数の上限を超えています。
HTTP Status Code:400
InsufficientDBInstanceCapacity
指定したDBサーバープランは、指定したゾーンでは作成できません。
HTTP Status Code:400
InvalidDBInstanceState
DBインスタンスのステータスが“available”ではありません。
HTTP Status Code:400
InvalidRestore
VPCのバックアップから、VPCではないDBインスタンスへはリストアできません。
HTTP Status Code:400
InvalidVPCNetworkState
DBインスタンスが作成された時、DBSubnetGroup内に収まっていません。
HTTP Status Code:400
PointInTimeRestoreNotEnabled
ソースに指定したDBインスタンスはBackupRetentionPeriodの設定が“0”です。
HTTP Status Code:400
StorageQuotaExceeded
全てのDBインスタンスで使用可能なDBストレージ量を超えています。
HTTP Status Code:400

ApplyPendingMaintenanceAction - DBインスタンスへのシステムアップデート適用

概要
DBインスタンスにシステムアップデートを適用するAPIです。このAPIは即時実行され、実行中はステータスが“modifying”になります。
システムアップデートが完了したら“available”ステータスに戻り、イベントに出力されます。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
ResourceIdentifier
DBインスタンス名です。この値が設定されている場合のみ、結果が表示されます。

制限:1~63文字以内での指定が可能で、利用可能文字は英数字とハイフンです。
   最初の1文字は英字でなればなりません。
   ハイフンは最後の文字として利用できず、また、連続して利用できません。
Yes String
ApplyAction
適用する操作を指定します。現在system-updateのみ指定可能です。
Yes String
OptInType
適用するタイミングを指定します。現在immediateを指定可能です。
Yes String
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ 説明 DATATYPE
ResourcePendingMaintenanceActions
DBインスタンスに対する適用待ちシステムアップデート
ResourcePendingMaintenanceActions
サンプルAPIコール&レスポンス

以下の例では、kick_api.rbを用いてdb-instance-nameという名前のDBインスタンスにシステムアップデートを適用しています。

サンプルAPIコール
$ruby kick_api.rb Action=ApplyPendingMaintenanceAction ResourceIdentifier=db-instance-name ApplyAction=system-update OptInType=immediate
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<ApplyPendingMaintenanceActionResponse xmlns="http://api.rdb.cloudn-service.com/">
  <ApplyPendingMaintenanceActionResult>
    <ResourcePendingMaintenanceActions>
      <ResourceIdentifier>db-instance-name</ResourceIdentifier>
      <PendingMaintenanceActionDetails>
        <PendingMaintenanceAction>
          <Action>system-update</Action>
          <OptInStatus>immediate</OptInStatus>
          <CurrentVersion>20160801</CurrentVersion>
          <TargetVersion>20160803</TargetVersion>
        </PendingMaintenanceAction>
      </PendingMaintenanceActionDetails>
    </ResourcePendingMaintenanceActions>
  </ApplyPendingMaintenanceActionResult>
  <ResponseMetadata>
    <RequestId>job-480bc4dcdd3e5b1dbf24dab0023ee32d</RequestId>
  </ResponseMetadata>
</ApplyPendingMaintenanceActionResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
ResourceNotFoundFault
指定したDBインスタンス名は存在していません。
HTTP Status Code:404

2.2. DBセキュリティグループ管理

DBセキュリティグループを管理するためのAPIコマンドです。

CreateDBSecurityGroup - DBセキュリティグループ作成

概要
新しいDBセキュリティグループを作成するAPIです。
DBセキュリティグループは、DBインスタンスへの接続許可制限に利用します。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します。

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
DBSecurityGroupDescription
DBセキュリティグループの説明です。
Yes String
DBSecurityGroupName
アクセス許可制限として追加設定するDBセキュリティグループの名前です。
指定した名前は、小文字で登録されます。

制限:1~255文字以内での指定が可能で、利用可能文字は英数字とハイフンです。
   最初の1文字は英字でなければなりません。
   ハイフンは最後の文字として利用できず、また、連続して利用できません。

例:mysql-securitygroup
Yes String
EC2VpcId
※リクエスト可能ですが、無効なパラメータです。
No String
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ名 説明 DATATYPE
DBSecurityGroupDescription DBセキュリティグループの説明です。 String
DBSecurityGropuName 設定されているDBセキュリティグループの名前です。 String
EC2SecurityGroups ※無効なパラメータです。 EC2SecurityGroup list
IPRanges IPRangeのパラメータが含まれます。 IPRange list
OwnerId ※無効なパラメータです。 String
VpcId ※無効なパラメータです。 String
サンプルAPIコール&レスポンス
サンプルAPIコール
以下の例ではkick_api.rbを用いて、DBSecurityGroup-nameという名前のDBセキュリティグループを作成しています。
追加するDBセキュリティグループの説明として”This is the DBSecurityGroup”を追加しています。
$ruby kick_api.rb Action=CreateDBSecurityGroup \
 DBSecurityGroupDescription="This is the DBSecurityGroup" \
 DBSecurityGroupName=DBSecurityGroup-name
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<CreateDBSecurityGroupResponse xmlns="http://api.rdb.cloudn-service.com/">
 <CreateDBSecurityGroupResult>
   <DBSecurityGroup>
     <EC2SecurityGroups/>
     <DBSecurityGroupDescription>This is the DBSecurityGroup</DBSecurityGroupDescription>
     <IPRanges/>
     <OwnerId/>
     <DBSecurityGroupName>dbsecuritygroup-name</DBSecurityGroupName>
   </DBSecurityGroup>
 </CreateDBSecurityGroupResult>
 <ResponseMetadata>
   <RequestId>job-3ae0cb1081f0949410348265ad66ec12</RequestId>
 </ResponseMetadata>
</CreateDBSecurityGroupResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBSecurityGroupAlreadyExists
指定したDBセキュリティグループは既に存在しています。
HTTP Status Code:400
DBSecurityGroupQuotaExceeded
DBセキュリティグループの設定上限を超えています。
HTTP Status Code:400

DeleteDBSecurityGroup - DBセキュリティグループ削除

概要
DBセキュリティグループを削除するAPIです。削除するDBセキュリティグループは、
他のDBインスタンスに設定されていてはいけません。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します。

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
DBSecurityGroupName
削除するDBセキュリティグループ名です。

Note:default DBセキュリティグループは削除できません。
制限:1~255文字以内での指定が可能で、利用可能文字は英数字です。
   最初の1文字は英字でなればなりません。
   ハイフンは最後の文字として利用できず、また、連続して利用できません。
Yes String
Body
  • 無し
レスポンス
レスポンス (Body)

無し

サンプルAPIコール&レスポンス
サンプルAPIコール
以下の例ではkick_api.rbを用いて、DBSecurityGroup-nameという名前のDBセキュリティグループを削除しています。
$ruby kick_api.rb Action=DeleteDBSecurityGroup \
 DBSecurityGroupName=DBSecurityGroup-name
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<DeleteDBSecurityGroupResponse xmlns="http://api.rdb.cloudn-service.com/">
 <ResponseMetadata>
   <RequestId>job-c078025822c93bcea66c6dfc3094984d</RequestId>
 </ResponseMetadata>
</DeleteDBSecurityGroupResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBSecurityGroupNotFound
指定したDBセキュリティグループ名(DBSecurityGroupName)のDBセキュリティグループは存在していません。
HTTP Status Code:404
InvalidDBSecurityGroupState
DBセキュリティグループのステータスは削除を許容していません。
HTTP Status Code:400

DescribeDBSecurityGroups - DBセキュリティグループの詳細情報取得

概要
DBセキュリティグループの詳細を表示するAPIです。
DBSecurityGroupNameが指定されていた場合は、指定したものだけを表示します。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します。

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
DBSecurityGroupName
詳細を表示するDBセキュリティグループの名称です。
No String
Marker
※リクエスト可能ですが、無効なパラメータです。
No String
MaxRecords
※リクエスト可能ですが、無効なパラメータです。
No Integer
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ名 説明 DATATYPE
DBSecurityGroups DBセキュリティグループのパラメータが含まれます。 DBSecurityGroup list
IPRanges IPRangeのパラメータが含まれます。 IPRange list
サンプルAPIコール&レスポンス
サンプルAPIコール
以下の例ではkick_api.rbを用いて、DBセキュリティグループの詳細情報を取得しています。
$ruby kick_api.rb Action=DescribeDBSecurityGroups
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<DescribeDBSecurityGroupsResponse xmlns="http://api.rdb.cloudn-service.com/">
 <DescribeDBSecurityGroupsResult>
   <DBSecurityGroups>
     <DBSecurityGroup>
       <EC2SecurityGroups/>
       <DBSecurityGroupDescription>This is the DBSecurityGroup</DBSecurityGroupDescription>
       <IPRanges/>
       <OwnerId/>
       <DBSecurityGroupName>dbsecuritygroup-name</DBSecurityGroupName>
     </DBSecurityGroup>
     <DBSecurityGroup>
       <EC2SecurityGroups/>
       <DBSecurityGroupDescription>default</DBSecurityGroupDescription>
       <IPRanges>
         <IPRange>
           <CIDRIP>0.0.0.0/0</CIDRIP>
           <Status>authorized</Status>
         </IPRange>
       </IPRanges>
       <OwnerId/>
       <DBSecurityGroupName>default</DBSecurityGroupName>
     </DBSecurityGroup>
   </DBSecurityGroups>
 </DescribeDBSecurityGroupsResult>
 <ResponseMetadata>
   <RequestId>job-1a45af830f39584140f458d1d923dae7</RequestId>
 </ResponseMetadata>
</DescribeDBSecurityGroupsResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
DBSecurityGroupNotFound
指定したDBセキュリティグループ名(DBSecurityGroupName)のDBセキュリティグループは存在していません。
HTTP Status Code:404

AuthorizeDBSecurityGroupIngress - 接続許可アドレスの追加

概要
ご利用のDBインスタンス毎に設定されているDBセキュリティグループに対し、
接続許可アドレス(CIDR)を追加するAPIです。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します。

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
CIDRIP
DBインスタンスへアクセス許可したいアドレスをCIDR表記で指定します。

例:192.0.2.0/24(URLエンコードしてリクエストして下さい。)
Yes String
DBSecurityGroupName CIDRIPを追加するDBセキュリティグループ名です。 Yes String
EC2SecurityGroupID ※リクエスト可能ですが、無効なパラメータです。 No String
EC2SecurityGropuName ※リクエスト可能ですが、無効なパラメータです。 No String
EC2SecurityGroupOwnerId ※リクエスト可能ですが、無効なパラメータです。 No String
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ名 説明 DATATYPE
DBSecurityGroupDescription DBセキュリティグループの説明です。文字数制限は255文字です。 String
DBSecurityGroupName 設定されているDBセキュリティグループの名前です。 String
EC2SecurityGroups ※無効なパラメータです。 EC2 Security Group list
IPRanges IPRangeのパラメータが含まれます。 IPRange list
OwnerId ※無効なパラメータです。 String
VpcId ※無効なパラメータです。 String
サンプルAPIコール&レスポンス
サンプルAPIコール
以下の例ではkick_api.rbを用いて、dbsecuritygroup-nameという名前のDBセキュリティグループに、接続許可アドレス192.0.2.0/24を追加しています。
$ruby kick_api.rb Action=AuthorizeDBSecurityGroupIngress \
 CIDRIP=192.0.2.0/24 \
 DBSecurityGroupName=dbsecuritygroup-name
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<AuthorizeDBSecurityGroupIngressResponse xmlns="http://api.rdb.cloudn-service.com/">
 <AuthorizeDBSecurityGroupIngressResult>
   <DBSecurityGroup>
     <EC2SecurityGroups/>
     <DBSecurityGroupDescription>This is the DBSecurityGroup</DBSecurityGroupDescription>
     <IPRanges>
       <IPRange>
         <CIDRIP>192.0.2.0/24</CIDRIP>
         <Status>authorizing</Status>
       </IPRange>
     </IPRanges>
     <OwnerId/>
     <DBSecurityGroupName>dbsecuritygroup-name</DBSecurityGroupName>
   </DBSecurityGroup>
 </AuthorizeDBSecurityGroupIngressResult>
 <ResponseMetadata>
   <RequestId>job-d92dc73314e285c5876fe58ccf37b286</RequestId>
 </ResponseMetadata>
</AuthorizeDBSecurityGroupIngressResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
AuthorizationAlreadyExists 指定したCIDRIPまたはEC2SecurityGroupは既に設定されているDBセキュリティグループ に含まれています。 HTTP Status Code:400
AuthorizationQuotaExceeded DBセキュリティグループの設定上限を超えています。 HTTP Status Code:400
DBSecurityGroupNotFound 指定したDBセキュリティグループ (DBSecurityGroupName)は存在していません。 HTTP Status Code:404
InvalidDBSecurityGroupState DBセキュリティグループのステータスは設定の有効化を許容していません。 HTTP Status Code:400

RevokeDBSecurityGroupIngress - 接続許可アドレス取消

概要
以前に設定した該当DBインスタンスへのアクセス許可アドレス設定を取り消すAPIです。
CIDRIPパラメータは必須パラメータです。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します。

リクエストパラメータ一覧
パラメータ名 説 明 必須 DATATYPE
CIDRIP 削除したいアクセス許可アドレスです。 有効なレンジでなければいけません。 Yes String
DBSecurityGroupName 対象となるDBセキュリティグループ名です。 Yes String
EC2SecurityGroupID ※リクエスト可能ですが、無効なパラメータです。 No String
EC2SecurityGropuName ※リクエスト可能ですが、無効なパラメータです。 No String
EC2SecurityGroupOwnerId ※リクエスト可能ですが、無効なパラメータです。 No String
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ名 説明 DATATYPE
DBSecurityGroupDescription DBセキュリティグループの説明です。 String
DBSecurityGropuName 設定されているDBセキュリティグループの名前です。 String
EC2SecurityGroups ※無効なパラメータです。 EC2SecurityGroup list
IPRanges IPRangeのパラメータが含まれます。 IPRange list
OwnerId ※無効なパラメータです。 String
VpcId ※無効なパラメータです。 String
サンプルAPIコール&レスポンス
サンプルAPIコール
以下の例ではkick_api.rbを用いて、接続許可アドレスをdbsecuritygroup-nameというDBセキュリティグループから削除しています。
削除した接続許可アドレスは192.0.2.0/24です。
$ruby kick_api.rb Action=RevokeDBSecurityGroupIngress \
 CIDRIP=192.0.2.0/24 \
 DBSecurityGroupName=dbsecuritygroup-name
サンプルレスポンス

レスポンスは以下のようにXML形式で返されます。

<RevokeDBSecurityGroupIngressResponse xmlns="http://api.rdb.cloudn-service.com/">
 <RevokeDBSecurityGroupIngressResult>
   <DBSecurityGroup>
     <EC2SecurityGroups/>
     <DBSecurityGroupDescription>This is the DBSecurityGroup</DBSecurityGroupDescription>
     <IPRanges>
       <IPRange>
         <CIDRIP>192.0.2.0/24</CIDRIP>
         <Status>revoking</Status>
       </IPRange>
     </IPRanges>
     <OwnerId/>
     <DBSecurityGroupName>dbsecuritygroup-name</DBSecurityGroupName>
   </DBSecurityGroup>
 </RevokeDBSecurityGroupIngressResult>
 <ResponseMetadata>
   <RequestId>job-5adcca93f78007d849538292a2e50f78</RequestId>
 </ResponseMetadata>
</RevokeDBSecurityGroupIngressResponse>
エラーメッセージ
エラーメッセージ一覧
パラメータ名 説明
AuthorizationNotFound
指定したCIDRIPまたはEC2SecurityGroupは指定したDBセキュリティグループに含まれていません。
HTTP Status Code:404
DBSecurityGroupNotFound
指定したDBセキュリティグループ名(DBSecurityGroupName)のDBセキュリティグループは存在していません。
HTTP Status Code:404
InvalidDBSecurityGroupState
DBセキュリティグループのステータスは削除を許容していません。
HTTP Status Code:400

2.3. Event管理

Eventを管理するためのAPIコマンドです。

DescribeEvents - 過去のイベント表示

概要
DB Instancesに関するイベントを表示するAPIです。
リクエスト
リクエストメソッド
  • GET
リクエストパラメータ一覧

共通パラメータ仕様 記載のパラメータ、および下記パラメータを指定します

リクエストパラメータ一覧
パラメータ名 説明 必須 DATATYPE
Duration
イベント情報を取得する時間間隔です。分単位で指定します。

デフォルト値:60
No Integer
EndTime
ISO8601形式で指定された取得イベントのEndTimeを指定します。

例:2013-05-01T18:00Z
No DateTime
Marker
※無効パラメータです。
No String
MaxRecords
※無効パラメータです。
No Integer
SourceIdentifier
取得したいイベント情報の識別子を指定します。
指定しなければ、全てのインスタンスのイベントを取得します。

制限:
  ハイフンは最後の文字として利用できず、また連続して利用不可
  SourceIdentifierを指定する場合はSourceTypeの指定も必須
  SourceTypeがDBInstanceならばDBInstanceIdentifierも必須
例:
DBInstanceIdentifieを指定する場合
Action=ModifyDBInstance&SourceType=db-Instance&SourceIdentifier=db-instance-name
No String
SourceType
取得するイベントの種類です。指定しなければ、全てのイベントを返します。

有効値 :db-instance
No String
StartTime
取得するイベントの開始時刻を指定します。ISO8601形式で表示します。

例:2013-05-01T18:00Z
No DateTime
Body
  • 無し
レスポンス
レスポンス (Body)
  • 形式: XML
Response(Body)
パラメータ名 説明 DATATYPE
Events イベントのリストです。 Event list
Marker 過去に操作を実施した時に指定したポインタ情報です。 String
サンプルAPIコール&レスポンス
サンプルAPIコール
$ruby kick_api.rb Action=DescribeEvents
サンプルレスポンス
<DescribeEventsResponse xmlns="http://api.rdb.cloudn-service.com/">
 <DescribeEventsResult>
   <Events>
     <Event>
       <Message>Database instance created</Message>
       <SourceType>db-instance</SourceType>
       <Date>2014-09-01T08:02:07Z</Date>
       <SourceIdentifier>db-instance-name3</SourceIdentifier>
     </Event>
     <Event>
       <Message>Restored from database instance db-instance-name3 to 2014-09-01 07:41:13.0</Message>
       <SourceType>db-instance</SourceType>
       <Date>2014-09-01T08:06:09Z</Date>
       <SourceIdentifier>db-instance-name3</SourceIdentifier>
     </Event>
   </Events>
 </DescribeEventsResult>
 <ResponseMetadata>
   <RequestId>job-47cebaa43a39936a3fd4d206ffaec9cc</RequestId>
 </ResponseMetadata>
</DescribeEventsResponse>