本文へジャンプします。

ニフクラ ユーザーガイド

クラウド トップ>API> RDB> DescribeDBInstances
本ページは2023/9/5をもって、新ページhttps://docs.nifcloud.com/rdb/api/DescribeDBInstances.htmへ移行しました。 今後は新ページをご参照ください。

DescribeDBInstances

処理概要

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

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

指定するパラメーター

パラメーター 型 説明 必須
DBInstanceIdentifier string DBサーバー名
Filters.member.N string ※指定不可
Filter string ※指定不可
FilterName string ※指定不可
FilterValue string ※指定不可
Marker string

マーカー

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

応答フィールド

フィールド (項目) 型 説明
DescribeDBInstancesResponse structure ルート
␣DescribeDBInstancesResult structure 結果
␣␣DBInstances list DBサーバーリスト
␣␣␣DBInstance structure DBサーバー
備考: DBInstanceの子要素はDescribeDBInstancesで返却される要素をすべて記載しているためAPIによっては返却されない要素もあります。実際のレスポンスはレスポンスサンプルを参照してください。
␣␣␣␣AllocatedStorage integer 割り当てるディスク容量(GB)
␣␣␣␣AutoMinorVersionUpgrade boolean マイナーバージョンの自動アップデートを行うかどうか
備考: 固定値falseを返却
␣␣␣␣AvailabilityZone string DBサーバーのゾーン
␣␣␣␣BackupRetentionPeriod integer バックアップ保持期間
␣␣␣␣BinlogRetentionPeriod integer

バイナリログ保持期間(日)

  • BinlogRetentionPeriodを変更した場合のみ要素を返却します。
␣␣␣␣ExternalReplicationInfo structure

外部レプリケーション情報

  • ※DBサーバーが以下の場合のみこのタグは返却されます
  • MySQLでシングル構成
  • MySQLで冗長構成 (データ優先)
␣␣␣␣␣ExternalReplicationMessage string

外部レプリケーション操作結果

  • ※エラー発生時は、実行時に出力されたメッセージ
␣␣␣␣␣ExternalReplicationStatus string

外部レプリケーション操作ステータス

  • set(SetExternalMaster実行成功 & StartReplication未実行)
  • started(StartReplication実行成功 & StopReplication未実行)
  • stopped(StopReplication実行成功 & ResetExternalMaster未実行)
  • set-error(SetExternalMaster実行失敗)
  • start-error(StartReplication実行失敗)
  • stop-error(StopReplication実行失敗)
  • reset-error(ResetExternalMaster実行失敗)
␣␣␣␣␣ReplicationAddresses list 外部レプリケーション接続元グローバルIPアドレスリスト
␣␣␣␣␣␣ReplicationAddress string

外部レプリケーション接続元グローバルIPアドレス

  • ※シングル構成の場合は外部レプリケーション接続元グローバルIPアドレスを1つ返却します
  • ※冗長構成(データ優先)の場合は外部レプリケーション接続元グローバルIPアドレスを2つ返却します
␣␣␣␣␣ReplicationPrivateAddresses list 外部レプリケーション接続元プライベートIPアドレスリスト
␣␣␣␣␣␣ReplicationPrivateAddress string

外部レプリケーション接続元プライベートIPアドレス

  • ※シングル構成の場合は外部レプリケーション接続元プライベートIPアドレスを1つ返却します
  • ※冗長構成(データ優先)の場合は外部レプリケーション接続元プライベートIPアドレスを2つ返却します
␣␣␣␣␣ExternalMasterAddress string マスターとなるDBサーバーのIPアドレスまたはホスト名
␣␣␣␣CACertificateIdentifier string DBサーバーのサーバー証明書と紐付くCA証明書
␣␣␣␣DBInstanceClass string DBサーバータイプ
␣␣␣␣DBInstanceIdentifier string DBサーバー名
␣␣␣␣DBInstanceStatus string DBサーバーのステータス
␣␣␣␣DBName string DB名
␣␣␣␣DBParameterGroups list DBパラメーターグループ情報リスト
␣␣␣␣␣DBParameterGroup structure DBパラメーターグループ
␣␣␣␣␣␣DBParameterGroupName string DBパラメーターグループ名
␣␣␣␣␣␣ParameterApplyStatus string

DBパラメーターの適用ステータス

  • 値：applying(適用中) | pending-reboot(再起動待ち) | in-sync(適用済み)
␣␣␣␣DBSecurityGroups list DBファイアウォールグループ情報リスト
␣␣␣␣␣DBSecurityGroup structure DBファイアウォールグループ
␣␣␣␣␣␣DBSecurityGroupName string DBファイアウォールグループ名
␣␣␣␣␣␣Status string

DBファイアウォールグループのステータス

  • 値：active(有効) | adding(適用中) | removing(取り外し中) | failed(変更失敗)
␣␣␣␣Endpoint structure DB接続時のエンドポイント
␣␣␣␣␣Port integer ポート番号
␣␣␣␣␣Address string

グローバルIPアドレス

  • ※PubliclyAccessibleがオフの場合、このタグは返却されません。
␣␣␣␣␣NiftyPrivateAddress string プライベートIPアドレス
␣␣␣␣Engine string データベースエンジン
␣␣␣␣EngineVersion string データベースエンジンのバージョン
␣␣␣␣InstanceCreateTime timestamp DBサーバーの作成日時
␣␣␣␣LatestRestorableTime timestamp ポイントインタイムリカバリー可能な最新の時刻
␣␣␣␣LicenseModel string DBサーバーのライセンスモデル
␣␣␣␣MasterUsername string DBサーバーのマスターユーザー名
␣␣␣␣MultiAZ boolean 冗長化機能が有効かどうか
␣␣␣␣NiftyMultiAZType string 冗長構成タイプ
備考: ニフクラ独自仕様
␣␣␣␣OptionGroupMemberships list オプショングループ情報リスト
␣␣␣␣␣OptionGroupMembership structure オプショングループ情報
␣␣␣␣␣␣OptionGroupName string

下記の固定値を返却

  • 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エンジンがPostgreSQL9.6系の場合、default:postgres-9-6
  • DBエンジンがPostgreSQL11系の場合、default:postgres-11
  • DBエンジンがPostgreSQL13系の場合、default:postgres-13
␣␣␣␣␣␣Status string オプショングループのステータス
備考: 固定値in-syncを返却
␣␣␣␣PendingModifiedValues structure 保留の修正情報
␣␣␣␣␣AllocatedStorage integer 保留中のディスク容量
␣␣␣␣␣BackupRetentionPeriod integer 保留中のバックアップ保持期間
␣␣␣␣␣DBInstanceClass string 保留中のDBサーバータイプ
␣␣␣␣␣DBInstanceIdentifier string 保留中のDBサーバー名
␣␣␣␣␣EngineVersion string 保留中のデータベースエンジンのバージョン
␣␣␣␣␣MasterUserPassword string 保留中のDBサーバーのマスターユーザー名
␣␣␣␣␣MultiAZ boolean 保留中の「冗長化機能が有効かどうか」フラグ
␣␣␣␣␣Port integer 保留中のアクセス可能なポート番号
␣␣␣␣PreferredBackupWindow string バックアップ時間
␣␣␣␣PreferredMaintenanceWindow string メンテナンス時間
␣␣␣␣PubliclyAccessible boolean グローバルIPアドレスを有効にするかどうか
␣␣␣␣ReadReplicaDBInstanceIdentifiers list リードレプリカ名リスト
␣␣␣␣␣ReadReplicaDBInstanceIdentifier string リードレプリカ名
␣␣␣␣ReadReplicaSourceDBInstanceIdentifier string リードレプリカのマスターとして設定されているDBサーバー名
␣␣␣␣SecondaryAvailabilityZone string

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

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

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

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

エラーメッセージ

  • ※エラーが発生していない場合は空タグが返却されます
␣␣␣␣␣␣Normal boolean 正常かどうか
␣␣␣␣␣␣Status string

DBサーバーのステータス

  • 値(StatusTypeが“read replication”の場合)： replicating(レプリケーション中) | error(レプリケーションエラー)
␣␣␣␣␣␣StatusType string DBサーバーのステータス種別
備考: 固定値"read replication"を返却
␣␣␣␣VpcSecurityGroups string ※返却値なし
␣␣␣␣NiftyStorageType integer ディスクタイプ
備考: ニフクラ独自仕様
␣␣␣␣NiftyNetworkId string プライベートLANのネットワークユニークID
備考: ニフクラ独自仕様
␣␣␣␣NiftyMasterPrivateAddress string 主系DBサーバー用のプライベートIPアドレス
備考: ニフクラ独自仕様
␣␣␣␣NiftySlavePrivateAddress string 待機系DBサーバー用のプライベートIPアドレス
備考: ニフクラ独自仕様
␣␣␣␣AccountingType string 当月の利用料金タイプ
␣␣␣␣NextMonthAccountingType string 翌月の利用料金タイプ
␣␣Marker string

前のリクエストで提供されるページを表す文字列（ページング用）

  • この値が指定された場合、レスポンスでマーカーを超えたレコードが最大MaxRecord個返される
␣ResponseMetadata structure 共通メタ情報
␣␣RequestId string リクエスト識別子

エラー

コード メッセージ タイプ HTTPステータスコード 説明
Client.InvalidParameterFormat.DBInstanceIdentifier

The parameter DBInstanceIdentifier is not a valid identifier. Identifiers must begin with a letter; must contain only lowercase ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.

 Sender 400 DBInstanceIdentifierに無効な値(ハイフンから始まる 等)を指定した場合
Client.InvalidParameterIllegalInput.MaxRecords
Sender 400 MaxRecordsに数値でない値を指定した場合
Client.InvalidParameterNotFound.DBInstance

DBInstance aaa not found.

 Sender 404 存在しないDBInstanceIdentifierを指定した場合
Client.InvalidParameterOutOfRange.MaxRecords

Invalid value for max records. Must be between 20 and 100

 Sender 400 MaxRecordsに20-100でない値を指定した場合
Client.InvalidParameterTooLong.DBInstanceIdentifier

The parameter DBInstanceIdentifier is not a valid identifier because it is longer than 63 characters.

 Sender 400 DBInstanceIdentifierに63文字を超える値を指定した場合

リクエストサンプル

    https://jp-east-1.rdb.api.nifcloud.com/
  ?Action=DescribeDBInstances
  &DBInstanceIdentifier=mydbinstance
  &SignatureVersion=2
  &SignatureMethod=HmacSHA256
  &Timestamp=2013-12-09T00:00:00.000Z
  &AWSAccessKeyId=<NIFCLOUD 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>active</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>
        <ExternalReplicationInfo>
          <ReplicationAddresses>
            <ReplicationAddress>xxx.xxx.xxx.xxx</ReplicationAddress>
            <ReplicationAddress>yyy.yyy.yyy.yyy</ReplicationAddress>
          </ReplicationAddresses>
          <ReplicationPrivateAddresses>
            <ReplicationPrivateAddress>xxx.xxx.xxx.xxx</ReplicationPrivateAddress>
            <ReplicationPrivateAddress>yyy.yyy.yyy.yyy</ReplicationPrivateAddress>
          </ReplicationPrivateAddresses>
        </ExternalReplicationInfo>
        <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>0</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>
        <AccountingType>2</AccountingType>
        <NextMonthAccountingType>2</NextMonthAccountingType>
      </DBInstance>
    </DBInstances>
  </DescribeDBInstancesResult>
  <ResponseMetadata>
    <RequestId>4838a0d1-e2ff-4da9-b675-0e3f9eb21c10</RequestId>
  </ResponseMetadata>
</DescribeDBInstancesResponse>
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年9月05日時点の情報です。

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

ページの先頭へ