DescribeDBInstancesを呼び出して、指定された条件を満たす1つ以上のApsaraDB RDSインスタンスを照会できます。

次のいずれかの方法を使用して、応答を確認できます。

  • 方法1: MaxResultsパラメーターを使用して、1ページあたりのエントリ数を指定します。 次に、NextTokenパラメーターを使用して、次のページの表示に使用されるトークンを指定します。 NextTokenパラメーターは、NextTokenパラメーターに対するDescribeDBInstances操作の最新の呼び出しから返された値に設定されます。
    説明 初めてDescribeDBInstances操作を呼び出してページクエリを実行するときは、MaxResultsパラメーターのみを指定する必要があります。 この場合、操作は最初のページのデータとNextTokenパラメーターの値を返します。
  • 方法2: PageSizeパラメーターを使用して、1ページあたりのエントリ数を指定します。 次に、PageNumberパラメーターを使用して次のページを表示します。
説明 上記のいずれかの方法のみを使用できます。 多数のエントリが返される場合は、方法1を使用してクエリ速度を上げることを推奨します。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

項目データ型必須/任意例:説明 
操作String必須DescribeDBInstances

実行する操作です。 値をDescribeDBInstancesに設定します。

ClientTokenString任意ETnLKlblzczshOTUbOCzxxxxxxx

リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意である必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。

proxyIdString任意API

インスタンスで使用されるプロキシモードのID。

EngineString任意MySQL

インスタンスによって実行されるデータベースエンジン。 有効な値:

  • MySQL
  • SQLServer
  • PostgreSQL
  • MariaDB

既定では、この操作は、サポートされているデータベースエンジンのいずれかを実行するインスタンスを返します。

ZoneIdString任意cn-hangzhou-a

インスタンスが属するゾーンのID。

ResourceGroupIdString任意rg-acfmyxxxxx

インスタンスが属するリソースグループのID。

DBInstanceStatusString任意Running

インスタンスのステータス。 詳細は、「インスタンス状態テーブル」をご参照ください。

ExpiredString任意正しい

インスタンスの有効期限が切れているかどうかを指定します。 有効な値:

  • True: 期限切れのインスタンスを照会します。
  • False: 有効期限が切れていないインスタンスを照会します。
SearchKeyString任意rm-uf6w

インスタンスのIDまたは説明に含まれるキーワード。

DBInstanceIdString任意rm-uf6wjk5xxxxxxx

インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。

DBInstanceTypeString任意プライマリ

インスタンスのロール。 有効な値:

  • Primary: プライマリインスタンス
  • Readonly: 読み取り専用インスタンス
  • Guard: ディザスタリカバリインスタンス
  • Temp: 一時インスタンス

既定では、この操作はサポートされているロールのいずれかを引き受けるインスタンスを返します。

RegionIdString必須cn-hangzhou

インスタンスが存在するリージョンのID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

PageSizeIntegerいいえ30

各ページで返されるエントリ数。 有効な値: 1100

既定値: 30.

PageNumberIntegerいいえ1

返されるページ数。 有効値:0 以外の正の整数。

既定値:1

InstanceNetworkTypeString任意Classic

インスタンスのネットワークタイプ。 有効な値:

  • [VPC]
  • クラシック

既定では、この操作は、サポートされているいずれかのタイプのネットワークに存在するインスタンスを返します。

VpcIdString任意vpc-uf6f7l4fg90xxxxxxxxxx

インスタンスが属する仮想プライベートクラウド (VPC) のID。

VSwitchIdString任意vsw-uf6adz52c2pxxxxxxxxxx

VSwitch の ID です。

DBInstanceClassString任意rds.mys2.small

インスタンスのインスタンスタイプ。 詳細については、「プライマリApsaraDB RDSインスタンスタイプ」をご参照ください。

EngineVersionString任意5.7

インスタンスによって実行されるデータベースエンジンのバージョン。

PayTypeString任意Postpaid

インスタンスの課金方法。 有効な値:

  • 後払い: 従量課金
  • プリペイド: サブスクリプション
ConnectionModeString任意スタンダード

インスタンスの接続モード。 有効な値:

  • 標準: 標準モード
  • セーフ: データベースプロキシモード

既定では、この操作は、サポートされている接続モードのいずれかで実行されるインスタンスを返します。

タグString任意{"key1":"value1"}

インスタンスに追加されるタグ。 各タグは、TagKeyとTagValueの2つの部分で構成されるキーと値のペアです。 リクエストごとに {"key1":"value1","key2":"value2"...} の形式で最大5つのタグを指定できます。

DedicatedHostGroupIdString任意dhg-7a9xxxxxxxx

インスタンスが属する専用クラスターのID。

DedicatedHostIdString任意i-bpxxxxxxx

指定された専用クラスター内のインスタンスが存在するホストのID。

InstanceLevelIntegerいいえ0

Categoryパラメーターを使用してインスタンスのRDSエディションを返すかどうかを指定します。 有効な値:

  • 0: インスタンスのRDSエディションを返す必要があります。
  • 1: インスタンスのRDSエディションを返さないようにします。
ConnectionStringString任意rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com

インスタンスのエンドポイント。 このパラメーターは、単一のインスタンスをクエリする場合にのみ指定する必要があります。

NextTokenString任意o7PORW5o2TJg *********

次のページを表示するために使用されるトークン。 このパラメーターは、NextTokenパラメーターに対するDescribeDBInstances操作の最新の呼び出しから返された値に設定する必要があります。 返されたエントリが複数のページに表示される場合、このパラメーターを指定してこの操作を再度呼び出すと、次のページが表示されます。

MaxResultsIntegerいいえ30

各ページで返されるエントリ数。 有効な値: 1 ~ 100

既定値: 30.

説明 このパラメーターを指定した場合、PageSizeパラメーターとPageNumberパラメーターは使用できません。

レスポンスパラメーター

項目データ型例:説明 
RequestIdString1AD222E9-E606-4A42-BF6D-8A4442913CEF

リクエストの ID です。

PageNumberInteger1

返されたページ数。

説明 MaxResultsパラメーターまたはNextTokenパラメーターを指定した場合、値1のみが返されます。 値1は無視できます。
PageRecordCountInteger10

現在のページで返されたエントリの数。

TotalRecordCountInteger100

返されたエントリの総数。

説明 MaxResultsパラメーターまたはNextTokenパラメーターを指定した場合、現在のページのエントリ数のみが返されます。 番号は無視できます。
項目DBInstanceの配列

インスタンスの詳細。

DBInstance
VpcIdStringvpc-uf6f7l4fg90xxxxxxx

インスタンスが属する VPC の ID。

DedicatedHostIdForLogStringdh-bpxxxx

ロガーインスタンスが存在するホストのID。

CreateTimeString2018-11-05T11:26:02Z

インスタンスが作成された時間。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

PayTypeStringPostpaid

インスタンスの課金方法です。 有効な値:

  • 後払い: 従量課金
  • プリペイド: サブスクリプション
DedicatedHostNameForLogStringテストログ

ロガーインスタンスが存在するホストの名前。

ミュートリオルシングルブール真実

インスタンスにマルチゾーンデプロイ方法が使用されているかどうかを示します。 有効な値: trueとfalse

説明 インスタンスにマルチゾーンデプロイ方法が使用されている場合、インスタンスのゾーンIDにはMAZが含まれます。 例: cn-hangzhou-MAZ10(h,i)
DedicatedHostGroupNameStringtesthostgroup

インスタンスが属する専用クラスターの名前。

EngineVersionString5.7

インスタンスによって実行されるデータベースエンジンのバージョン。

DedicatedHostGroupIdStringdhg-7a9xxxxxxxx

インスタンスが属する専用クラスターのID。

VpcNameStringテスト-huadong

インスタンスが属するVPCの名前。

DedicatedHostZoneIdForMasterStringcn-hangzhou-d

プライマリインスタンスが属するゾーンのID。

ConnectionStringStringrm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com

インスタンスのエンドポイント。

InstanceNetworkTypeStringClassic

インスタンスのネットワークタイプです。 有効な値:

  • クラシック
  • [VPC]
MasterInstanceIdStringrm-uf6wjk5xxxxxxxxxx

プライマリインスタンスのID。 このパラメーターの値がnullの場合、インスタンスはプライマリインスタンスです。

ExpireTimeString2019-02-27T16:00:00Z

インスタンスの有効期限が切れる時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

説明 従量課金インスタンスの有効期限はありません。
DestroyTimeString2018-11-05T11:26:02Z

インスタンスが破棄された時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。

GuardDBInstanceIdStringrm-uf64zsuxxxxxxxxxx

ディザスタリカバリインスタンスのID。 このパラメーターは、インスタンスがプライマリインスタンスであり、ディザスタリカバリインスタンスがある場合にのみ返されます。

DedicatedHostNameForMasterStringテストマスター

プライマリインスタンスが存在するホストの名前。

ZoneIdStringcn-hangzhou-a

インスタンスが属するゾーンの ID。

DBInstanceIdStringrm-uf6wjk5xxxxxxxxxx

インスタンスの ID です。

DedicatedHostIdForMasterStringdh-bpxxxx

プライマリインスタンスが存在するホストのID。

TempDBInstanceIdStringrm-uf64zsuxxxxxxxxxx

一時インスタンスのID。 このパラメーターは、インスタンスがプライマリインスタンスであり、一時インスタンスがある場合にのみ返されます。

DBInstanceStorageTypeStringModuleList.4.ModuleCode

インスタンスのストレージタイプを示します。

ConnectionModeStringスタンダード

インスタンスの接続モード。 有効な値:

  • 標準: 標準モード
  • セーフ: データベースプロキシモード
LockModeStringUnlock

インスタンスがロックされているかどうかを示します。 有効な値:

  • Unlock: インスタンスはロックされていません。
  • ManualLock: インスタンスは手動でロックされています。
  • LockByExpiration: インスタンスは有効期限が切れると自動的にロックされます。
  • LockByRestoration: インスタンスはロールバックされる前に自動的にロックされます。
  • LockByDiskQuota: ストレージ容量がなくなると、インスタンスは自動的にロックされます。
  • リリース済み: インスタンスがリリースされました。 インスタンスのリリース後、インスタンスのロックを解除することはできません。 インスタンスのバックアップデータを新しいインスタンスにのみ復元できます。 このプロセスは長い時間を必要とする。
VpcCloudInstanceIdStringrm-uf6wjk5xxxxxxx

インスタンスの ID です。 このパラメーターは、インスタンスがVPCにある場合にのみ返されます。

DedicatedHostZoneIdForSlaveStringcn-hangzhou

セカンダリインスタンスが属するゾーンのID。

DedicatedHostZoneIdForLogStringcn-hangzhou-b

ロガーインスタンスが存在するホストのゾーンID。

DedicatedHostNameForSlaveStringtestslave

セカンダリインスタンスが存在するホストの名前。

DBInstanceDescriptionStringtestdatabase

インスタンスの説明。

DBInstanceNetTypeStringインターネット

インスタンスへのネットワーク接続のタイプ。 有効な値:

  • インターネット: インターネット
  • イントラネット: 内部ネットワーク
DBInstanceTypeStringPrimary

インスタンスのロール。 有効な値:

  • Primary: プライマリインスタンス
  • Readonly: 読み取り専用インスタンス
  • Guard: ディザスタリカバリインスタンス
  • Temp: 一時インスタンス
LockReasonStringinstance_expired

インスタンスがロックされている理由。

DBInstanceStatusStringRunning

インスタンスのステータス。 詳細は、「インスタンス状態テーブル」をご参照ください。

RegionIdStringcn-hangzhou

インスタンスのリージョン ID です。

VSwitchIdStringvsw-uf6adz52c2pxxxxxxx

VSwitch の ID です。

DedicatedHostIdForSlaveStringdh-bpxxxx

セカンダリインスタンスが存在するホストのID。

ResourceGroupIdStringrg-acfmyxxxxxxx

インスタンスが属するリソースグループの ID 。

カテゴリーString基本

インスタンスのRDSエディション。 有効な値:

  • 基本: 基本版
  • HighAvailability: 高可用性エディション
  • ファイナンス: Enterprise Edition
    説明 このパラメーターは、InstanceLevelパラメーターが1に設定されている場合にのみ返されます。
EngineStringMySQL

インスタンスによって実行されるデータベースエンジン。

DBInstanceClassStringrds.mys2.small

インスタンスのインスタンスタイプ。 詳細については、「プライマリApsaraDB RDSインスタンスタイプ」をご参照ください。

ReadOnlyDBInstanceIdsReadOnlyDBInstanceIdの配列

インスタンスにアタッチされている読み取り専用インスタンスのIDで構成される配列。 このパラメーターは、インスタンスがプライマリインスタンスであり、読み取り専用インスタンスがある場合にのみ返されます。

ReadOnlyDBInstanceId
DBInstanceIdStringrr-uf6wjk5xxxxxxx

読み取り専用インスタンスのID。

DeletionProtectionブール

読み取り専用インスタンスでリリース保護機能が有効になっているかどうかを示します。 有効な値:

  • true: リリース保護機能が有効になっています。
  • false: リリース保護機能は無効です。
NextTokenStringo7PORW5o2TJg *********

次のページを表示するために使用されるトークン。 返されたエントリが複数のページに表示される場合、NextTokenパラメーターを指定してこの操作を再度呼び出すと、次のページが表示されます。

リクエストの例

http(s):// rds.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstancesResponse>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>1</PageRecordCount>
    <RequestId>A436D75C-30B0-1F34-8544-4B46F4407CC1</RequestId>
    <NextToken>o7PORW5owHNg **********</NextToken>
    <ページ番号> 1 </ PAGENUMBER>
    <Items>
        <DBInstance>
            <EngineVersion>10.0</EngineVersion>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ResourceGroupId>rg-acfmyiu ********* </ResourceGroupId>
            <DBInstanceNetType> イントラネット </DBInstanceNetType>
            <DBInstanceClass>pg.n2.small.2c</DBInstanceClass>
            <CreateTime>2021-02-02T09:14:48Z</CreateTime>
            <VSwitchId>vsw-bp10aqj6o4lcl ********</VSwitchId>
            <TipsLevel>0</TipsLevel>
            <DBInstanceType> プライマリ </DBInstanceType>
            <PayType> 前払い </PayType>
            <LockMode>Unlock</LockMode>
            <DeletionProtection>false</DeletionProtection>
            <MutriORsignle>false</MutriORsignle>
            <InstanceNetworkType>VPC</InstanceNetworkType>
            <InsId>1</InsId>
            <VpcId>vpc-bp1opxu1zkhn0 ********</VpcId>
            <DBInstanceId>pgm-bp10re7n ********</DBInstanceId>
            <ConnectionMode> 標準 </ConnectionMode>
            <ReadOnlyDBInstanceIds>
            </ReadOnlyDBInstanceIds>
            <VpcCloudInstanceId>pgm-bp10re7n ********</VpcCloudInstanceId>
            <RegionId>cn-hangzhou</RegionId>
            <ConnectionString>pgm-bp10re7n *************** .pg.rds.aliyuncs.com</ConnectionString>
            <ExpireTime>2021-02-03T09:14:48Z</ExpireTime>
            <Engine>PostgreSQL</Engine>
        </DBInstance>
    </アイテム>
</DescribeDBInstancesResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 1、
  "PageRecordCount" : 1、
  "RequestId" : "A436D75C-30B0-1F34-8544-4B46F4407CC1" 、
  "NextToken" : "o7PORW5owHNg ***********" 、
  "PageNumber" : 1,
  "アイテム" : {
    "DBInstance" : [ {
      "EngineVersion" : "10.0" 、
      "ZoneId" : "cn-hangzhou-h",
      "DBInstanceStatus" : "Running" 、
      "ResourceGroupId" : "rg-acfmyiu *********" 、
      "DBInstanceNetType" : "イントラネット" 、
      "DBInstanceClass" : "pg.n2.small.2c" 、
      "CreateTime" : "2021-02-02T09:14:48Z" 、
      "VSwitchId" : "vsw-bp10aqj6o4lcl *********" 、
      "TipsLevel" : 0、
      "DBInstanceType" : "プライマリ" 、
      "PayType" : "プリペイド" 、
      "LockMode" : "ロック解除" 、
      "DeletionProtection" : false、
      "MutriORsignle" : false、
      "InstanceNetworkType" : "VPC" 、
      "InsId" : 1、
      "VpcId" : "vpc-bp1opxu1zkhn0 *********" 、
      "DBInstanceId" : "pgm-bp10re7n *********" 、
      "ConnectionMode" : "標準" 、
      "ReadOnlyDBInstanceIds" : {
        "ReadOnlyDBInstanceId" : [ ]
      },
      "VpcCloudInstanceId" : "pgm-bp10re7n ********" 、
      "RegionId" : "cn-hangzhou" 、
      "ConnectionString" : "pgm-bp10re7n **************** .pg.rds.aliyuncs.com" 、
      "ExpireTime" : "2021-02-03T09:14:48Z" 、
      "エンジン" : "PostgreSQL"
    } ]
  }
}

エラーコード

HTTP ステータスコードエラーコードエラーメッセージ説明 
400無効な. NextTokenパラメーターNextTokenが無効です。NextTokenパラメーターの値が無効な場合に返されるエラーメッセージ。
400InvalidDBInstanceType.ValueNotSupport指定されたパラメーター  &quot;DBInstanceType&quot; は無効です。指定されたインスタンスタイプが無効な場合に表示されるエラーメッセージ。 有効なインスタンスタイプを指定する必要があります。

エラーコードのリストについては、エラーセンターをご覧ください。