本文へジャンプします。

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

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

RDB:DescribeDBInstances

処理概要

DBサーバーの情報を取得します。

このAPIアクションはページネートをサポートしています。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DBInstanceIdentifier DBサーバー名
  文字列  
Filters.member.N
  • ※指定不可
  リスト  
Filter
  • ※指定不可
   
FilterName
  • ※指定不可
文字列  
FilterValue
  • ※指定不可
文字配列  
Marker

マーカー

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

レスポンス

XML

status

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

result
要素名 説明 備考
DescribeDBInstancesResponse ルート  
DescribeDBInstancesResult 結果  
DBInstances DBサーバーリスト  
DBInstance DBサーバー  
AllocatedStorage ディスク容量 (GB) 数値  
AutoMinorVersionUpgrade マイナーバージョンの自動アップデートするかどうか 真偽値 固定値falseを返却
AvailabilityZone DBサーバーのゾーン 文字列  
BackupRetentionPeriod バックアップ保持期間 数値  
DBInstanceClass DBサーバータイプ 文字列  
DBInstanceIdentifier DBサーバー名 文字列  
DBInstanceStatus DBサーバーのステータス 文字列  
DBName DB名 文字列  
DBParameterGroups DBパラメーターグループ情報リスト リスト  
DBParameterGroup DBパラメーターグループ情報  
DBParameterGroupName DBパラメーターグループ名 文字列  
ParameterApplyStatus DBパラメーターの適用ステータス
値:applying(適用中) | pending-reboot(再起動待ち) | in-sync(適用済み)
文字列  
DBSecurityGroups DBファイアウォールグループ情報リスト リスト  
DBSecurityGroup DBファイアウォールグループ  
DBSecurityGroupName DBファイアウォールグループ名 文字列  
Status DBファイアウォールグループのステータス
値:active(有効) | adding(適用中) | removing(取り外し中) | failed(変更失敗)
文字列  
Endpoint DB接続時のエンドポイント  
Port ポート番号 数値  
Address グローバルIPアドレス 文字列  
NiftyPrivateAddress プライベートIPアドレス 文字列 ニフティクラウド独自仕様
Engine データベースエンジン 文字列  
EngineVersion データベースエンジンのバージョン 文字列  
InstanceCreateTime DBサーバーの作成日時 日時  
LatestRestorableTime ポイントインタイムリカバリー可能な最新の時刻 日時  
LicenseModel DBサーバーのライセンスモデル 文字列  
MasterUsername DBサーバーのマスターユーザー名 文字列  
MultiAZ 冗長化機能が有効かどうか 真偽値  
NiftyMultiAZType 冗長構成タイプ 文字列 ニフティクラウド独自仕様
OptionGroupMemberships オプショングループ情報リスト リスト  
OptionGroupMembership オプショングループ情報  
OptionGroupName

下記の固定値を返却

  • DBエンジンがMySQL 5.5系の場合、default:mysql-5-5
  • DBエンジンがMySQL 5.6系の場合、default:mysql-5-6
  • DBエンジンがMySQL 5.7系の場合、default:mysql-5-7
  • DBエンジンがPostgreSQL9.3系の場合、default:postgres-9-3
  • DBエンジンがMariaDB10.1系の場合、default:mariadb-10-1
文字列  
Status オプショングループのステータス 文字列 固定値in-syncを返却
PendingModifiedValues 保留の修正情報  
AllocatedStorage 保留中のディスク容量 数値  
BackupRetentionPeriod 保留中のバックアップ保持期間 数値  
DBInstanceClass 保留中のDBサーバータイプ 文字列  
DBInstanceIdentifier 保留中のDBサーバー名 文字列  
EngineVersion 保留中のデータベースエンジンのバージョン 文字列  
MasterUserPassword 保留中のDBサーバーのマスターユーザーパスワード 文字列  
MultiAZ 保留中の「冗長化機能が有効かどうか」フラグ 真偽値  
Port 保留中のアクセス可能なポート番号 数値  
PreferredBackupWindow バックアップ時間 文字列  
PreferredMaintenanceWindow メンテナンス時間 文字列  
PubliclyAccessible グローバルIPアドレスかプライベートIPアドレスか 真偽値 固定値trueを返却
ReadReplicaDBInstanceIdentifiers リードレプリカのDBサーバー名リスト  
ReadReplicaDBInstanceIdentifier リードレプリカのDBサーバー名 文字配列  
ReadReplicaSourceDBInstanceIdentifier リードレプリカのマスターDBサーバー名 文字列  
SecondaryAvailabilityZone

待機系 DB サーバーのゾーン

  • ※冗長化機能がオンの場合、固定で AvailabilityZoneと同じ値が返却されます
  • ※冗長化機能がオフの場合、このタグは返却されません
文字列  
StatusInfos

リードレプリカのステータス

  • ※DBサーバーがリードレプリカでない場合、空タグが返却されます
リスト  
DBInstanceStatusInfo DBサーバーのステータス情報のリスト  
Message

エラーメッセージ

  • ※エラーが発生していない場合は空タグが返却されます
文字列  
Normal 正常かどうか 真偽値  
Status DBサーバーのステータス
値(StatusTypeが"read replication"の場合): replicating(レプリケーション中) | error(レプリケーションエラー)
文字列  
StatusType DBサーバーのステータス種別 文字列 固定値"read replication"を返却
VpcSecurityGroups
  • ※返却値なし
リスト  
NiftyStorageType ディスクタイプ 数値 ニフティクラウド独自仕様
NiftyNetworkId プライベートLANのネットワークユニークID 文字列 ニフティクラウド独自仕様
NiftyMasterPrivateAddress マスターのプライベートIPアドレス
  • ※プライベートLAN、プライベートLAN(旧)のDBサーバーのみ返却されます。
文字列 ニフティクラウド独自仕様
NiftySlavePrivateAddress スレーブのプライベートIPアドレス
  • ※プライベートLAN、プライベートLAN(旧)のDBサーバーのみ返却されます。
文字列 ニフティクラウド独自仕様
Marker マーカー 文字列  
ResponseMetadata 共通メタ情報  

エラー

コード メッセージ タイプ HTTP
ステータスコード
説明
DBInstanceNotFound DBInstance aaaa not found. Sender 404 存在しないDBInstanceIdentifierを指定した場合
InvalidParameterValue The parameter DBInstanceIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens. Sender 400 DBInstanceIdentifierに無効な値(数字から始まる、-で終わるなど)を指定した場合
The parameter DBInstanceIdentifier is not a valid identifier because it is longer than 63 characters. Sender 400 DBInstanceIdentifierに63文字以上の値を指定した場合
Invalid value for max records. Must be between 20 and 100 Sender 400 MaxRecordsに20-100でない値を指定した場合

サンプル

リクエストサンプル
https://rdb.jp-east-1.api.cloud.nifty.com/
    ?Action=DescribeDBInstances
    &DBInstanceIdentifier=mydbinstance
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2013-12-09T00%3A00%3A00.000Z
    &AWSAccessKeyId=<Nifty Cloud Access Key ID>
    &Signature=<Signature>
レスポンスサンプル
<DescribeDBInstancesResponse>
  <DescribeDBInstancesResult>
    <DBInstances>
      <DBInstance>
        <AllocatedStorage>50</AllocatedStorage>
        <AutoMinorVersionUpgrade>false</AutoMinorVersionUpgrade>
        <AvailabilityZone>west-11</AvailabilityZone>
        <BackupRetentionPeriod>1</BackupRetentionPeriod>
        <DBInstanceClass>db.mini</DBInstanceClass>
        <DBInstanceIdentifier>mydbinstance</DBInstanceIdentifier>
        <DBInstanceStatus>available</DBInstanceStatus>
        <DBName>db_test_create</DBName>
        <DBParameterGroups>
          <DBParameterGroup>
            <DBParameterGroupName>myrdb-parameter1</DBParameterGroupName>
            <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          </DBParameterGroup>
        </DBParameterGroups>
        <DBSecurityGroups>
          <DBSecurityGroup>
            <DBSecurityGroupName>myrdb-security1</DBSecurityGroupName>
            <Status>available</Status>
          </DBSecurityGroup>
        </DBSecurityGroups>
        <Endpoint>
          <Port>3306</Port>
          <Address>175.184.20.250</Address>
          <NiftyPrivateAddress>10.100.74.211</NiftyPrivateAddress>
        </Endpoint>
        <Engine>mysql</Engine>
        <EngineVersion>5.5.40</EngineVersion>
        <InstanceCreateTime>2014-12-16T06:57:32.000Z</InstanceCreateTime>
        <LatestRestorableTime>2014-12-16T06:55:00.000Z</LatestRestorableTime>
        <LicenseModel>general-public-license</LicenseModel>
        <MasterUsername>user</MasterUsername>
        <MultiAZ>true</MultiAZ>
        <NiftyMultiAZType>1</NiftyMultiAZType>
        <OptionGroupMemberships>
          <OptionGroupMembership>
            <OptionGroupName>default:mysql-5-5</OptionGroupName>
            <Status>in-sync</Status>
          </OptionGroupMembership>
        </OptionGroupMemberships>
        <PendingModifiedValues/>
        <PreferredBackupWindow>23:23-23:53</PreferredBackupWindow>
        <PreferredMaintenanceWindow>fri:20:01-fri:20:31</PreferredMaintenanceWindow>
        <PubliclyAccessible>true</PubliclyAccessible>
        <ReadReplicaDBInstanceIdentifiers>
          <ReadReplicaDBInstanceIdentifier>mydbinstance-replica</ReadReplicaDBInstanceIdentifier>
        </ReadReplicaDBInstanceIdentifiers>
        <SecondaryAvailabilityZone>west-11</SecondaryAvailabilityZone>
        <VpcSecurityGroups/>
        <NiftyStorageType>0</NiftyStorageType>
      </DBInstance>
    </DBInstances>
  </DescribeDBInstancesResult>
  <ResponseMetadata>
    <RequestId>4838a0d1-e2ff-4da9-b675-0e3f9eb21c10</RequestId>
  </ResponseMetadata>
</DescribeDBInstancesResponse>

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