DescribeDBInstancesを呼び出して、指定された条件を満たす1つ以上のApsaraDB RDSインスタンスを照会できます。
次のいずれかの方法を使用して、応答を確認できます。
- 方法1: MaxResultsパラメーターを使用して、1ページあたりのエントリ数を指定します。 次に、NextTokenパラメーターを使用して、次のページの表示に使用されるトークンを指定します。 NextTokenパラメーターは、NextTokenパラメーターに対するDescribeDBInstances操作の最新の呼び出しから返された値に設定されます。説明 初めてDescribeDBInstances操作を呼び出してページクエリを実行するときは、MaxResultsパラメーターのみを指定する必要があります。 この場合、操作は最初のページのデータとNextTokenパラメーターの値を返します。
- 方法2: PageSizeパラメーターを使用して、1ページあたりのエントリ数を指定します。 次に、PageNumberパラメーターを使用して次のページを表示します。
デバッグ
リクエストパラメーター
項目 | データ型 | 必須/任意 | 例: | 説明 |
---|---|---|---|---|
操作 | String | 必須 | DescribeDBInstances | 実行する操作です。 値をDescribeDBInstancesに設定します。 |
ClientToken | String | 任意 | ETnLKlblzczshOTUbOCzxxxxxxx | リクエストのべき等性を保証するために使用されるクライアントトークン。 クライアントを使用して値を生成できますが、異なるリクエスト間で一意である必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。 |
proxyId | String | 任意 | API | インスタンスで使用されるプロキシモードのID。 |
Engine | String | 任意 | MySQL | インスタンスによって実行されるデータベースエンジン。 有効な値:
既定では、この操作は、サポートされているデータベースエンジンのいずれかを実行するインスタンスを返します。 |
ZoneId | String | 任意 | cn-hangzhou-a | インスタンスが属するゾーンのID。 |
ResourceGroupId | String | 任意 | rg-acfmyxxxxx | インスタンスが属するリソースグループのID。 |
DBInstanceStatus | String | 任意 | Running | インスタンスのステータス。 詳細は、「インスタンス状態テーブル」をご参照ください。 |
Expired | String | 任意 | 正しい | インスタンスの有効期限が切れているかどうかを指定します。 有効な値:
|
SearchKey | String | 任意 | rm-uf6w | インスタンスのIDまたは説明に含まれるキーワード。 |
DBInstanceId | String | 任意 | rm-uf6wjk5xxxxxxx | インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。 |
DBInstanceType | String | 任意 | プライマリ | インスタンスのロール。 有効な値:
既定では、この操作はサポートされているロールのいずれかを引き受けるインスタンスを返します。 |
RegionId | String | 必須 | cn-hangzhou | インスタンスが存在するリージョンのID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
PageSize | Integer | いいえ | 30 | 各ページで返されるエントリ数。 有効な値: 1〜100。 既定値: 30. |
PageNumber | Integer | いいえ | 1 | 返されるページ数。 有効値:0 以外の正の整数。 既定値:1 |
InstanceNetworkType | String | 任意 | Classic | インスタンスのネットワークタイプ。 有効な値:
既定では、この操作は、サポートされているいずれかのタイプのネットワークに存在するインスタンスを返します。 |
VpcId | String | 任意 | vpc-uf6f7l4fg90xxxxxxxxxx | インスタンスが属する仮想プライベートクラウド (VPC) のID。 |
VSwitchId | String | 任意 | vsw-uf6adz52c2pxxxxxxxxxx | VSwitch の ID です。 |
DBInstanceClass | String | 任意 | rds.mys2.small | インスタンスのインスタンスタイプ。 詳細については、「プライマリApsaraDB RDSインスタンスタイプ」をご参照ください。 |
EngineVersion | String | 任意 | 5.7 | インスタンスによって実行されるデータベースエンジンのバージョン。 |
PayType | String | 任意 | Postpaid | インスタンスの課金方法。 有効な値:
|
ConnectionMode | String | 任意 | スタンダード | インスタンスの接続モード。 有効な値:
既定では、この操作は、サポートされている接続モードのいずれかで実行されるインスタンスを返します。 |
タグ | String | 任意 | {"key1":"value1"} | インスタンスに追加されるタグ。 各タグは、TagKeyとTagValueの2つの部分で構成されるキーと値のペアです。 リクエストごとに {"key1":"value1","key2":"value2"...} の形式で最大5つのタグを指定できます。 |
DedicatedHostGroupId | String | 任意 | dhg-7a9xxxxxxxx | インスタンスが属する専用クラスターのID。 |
DedicatedHostId | String | 任意 | i-bpxxxxxxx | 指定された専用クラスター内のインスタンスが存在するホストのID。 |
InstanceLevel | Integer | いいえ | 0 | Categoryパラメーターを使用してインスタンスのRDSエディションを返すかどうかを指定します。 有効な値:
|
ConnectionString | String | 任意 | rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com | インスタンスのエンドポイント。 このパラメーターは、単一のインスタンスをクエリする場合にのみ指定する必要があります。 |
NextToken | String | 任意 | o7PORW5o2TJg ********* | 次のページを表示するために使用されるトークン。 このパラメーターは、NextTokenパラメーターに対するDescribeDBInstances操作の最新の呼び出しから返された値に設定する必要があります。 返されたエントリが複数のページに表示される場合、このパラメーターを指定してこの操作を再度呼び出すと、次のページが表示されます。 |
MaxResults | Integer | いいえ | 30 | 各ページで返されるエントリ数。 有効な値: 1 ~ 100 既定値: 30. 説明 このパラメーターを指定した場合、PageSizeパラメーターとPageNumberパラメーターは使用できません。 |
レスポンスパラメーター
項目 | データ型 | 例: | 説明 |
---|---|---|---|
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF | リクエストの ID です。 |
PageNumber | Integer | 1 | 返されたページ数。 説明 MaxResultsパラメーターまたはNextTokenパラメーターを指定した場合、値1のみが返されます。 値1は無視できます。 |
PageRecordCount | Integer | 10 | 現在のページで返されたエントリの数。 |
TotalRecordCount | Integer | 100 | 返されたエントリの総数。 説明 MaxResultsパラメーターまたはNextTokenパラメーターを指定した場合、現在のページのエントリ数のみが返されます。 番号は無視できます。 |
項目 | DBInstanceの配列 | インスタンスの詳細。 | |
DBInstance | |||
VpcId | String | vpc-uf6f7l4fg90xxxxxxx | インスタンスが属する VPC の ID。 |
DedicatedHostIdForLog | String | dh-bpxxxx | ロガーインスタンスが存在するホストのID。 |
CreateTime | String | 2018-11-05T11:26:02Z | インスタンスが作成された時間。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。 |
PayType | String | Postpaid | インスタンスの課金方法です。 有効な値:
|
DedicatedHostNameForLog | String | テストログ | ロガーインスタンスが存在するホストの名前。 |
ミュートリオルシングル | ブール | 真実 | インスタンスにマルチゾーンデプロイ方法が使用されているかどうかを示します。 有効な値: trueとfalse。 説明 インスタンスにマルチゾーンデプロイ方法が使用されている場合、インスタンスのゾーンIDにはMAZが含まれます。 例: cn-hangzhou-MAZ10(h,i) |
DedicatedHostGroupName | String | testhostgroup | インスタンスが属する専用クラスターの名前。 |
EngineVersion | String | 5.7 | インスタンスによって実行されるデータベースエンジンのバージョン。 |
DedicatedHostGroupId | String | dhg-7a9xxxxxxxx | インスタンスが属する専用クラスターのID。 |
VpcName | String | テスト-huadong | インスタンスが属するVPCの名前。 |
DedicatedHostZoneIdForMaster | String | cn-hangzhou-d | プライマリインスタンスが属するゾーンのID。 |
ConnectionString | String | rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com | インスタンスのエンドポイント。 |
InstanceNetworkType | String | Classic | インスタンスのネットワークタイプです。 有効な値:
|
MasterInstanceId | String | rm-uf6wjk5xxxxxxxxxx | プライマリインスタンスのID。 このパラメーターの値がnullの場合、インスタンスはプライマリインスタンスです。 |
ExpireTime | String | 2019-02-27T16:00:00Z | インスタンスの有効期限が切れる時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。 説明 従量課金インスタンスの有効期限はありません。 |
DestroyTime | String | 2018-11-05T11:26:02Z | インスタンスが破棄された時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。 |
GuardDBInstanceId | String | rm-uf64zsuxxxxxxxxxx | ディザスタリカバリインスタンスのID。 このパラメーターは、インスタンスがプライマリインスタンスであり、ディザスタリカバリインスタンスがある場合にのみ返されます。 |
DedicatedHostNameForMaster | String | テストマスター | プライマリインスタンスが存在するホストの名前。 |
ZoneId | String | cn-hangzhou-a | インスタンスが属するゾーンの ID。 |
DBInstanceId | String | rm-uf6wjk5xxxxxxxxxx | インスタンスの ID です。 |
DedicatedHostIdForMaster | String | dh-bpxxxx | プライマリインスタンスが存在するホストのID。 |
TempDBInstanceId | String | rm-uf64zsuxxxxxxxxxx | 一時インスタンスのID。 このパラメーターは、インスタンスがプライマリインスタンスであり、一時インスタンスがある場合にのみ返されます。 |
DBInstanceStorageType | String | ModuleList.4.ModuleCode | インスタンスのストレージタイプを示します。 |
ConnectionMode | String | スタンダード | インスタンスの接続モード。 有効な値:
|
LockMode | String | Unlock | インスタンスがロックされているかどうかを示します。 有効な値:
|
VpcCloudInstanceId | String | rm-uf6wjk5xxxxxxx | インスタンスの ID です。 このパラメーターは、インスタンスがVPCにある場合にのみ返されます。 |
DedicatedHostZoneIdForSlave | String | cn-hangzhou | セカンダリインスタンスが属するゾーンのID。 |
DedicatedHostZoneIdForLog | String | cn-hangzhou-b | ロガーインスタンスが存在するホストのゾーンID。 |
DedicatedHostNameForSlave | String | testslave | セカンダリインスタンスが存在するホストの名前。 |
DBInstanceDescription | String | testdatabase | インスタンスの説明。 |
DBInstanceNetType | String | インターネット | インスタンスへのネットワーク接続のタイプ。 有効な値:
|
DBInstanceType | String | Primary | インスタンスのロール。 有効な値:
|
LockReason | String | instance_expired | インスタンスがロックされている理由。 |
DBInstanceStatus | String | Running | インスタンスのステータス。 詳細は、「インスタンス状態テーブル」をご参照ください。 |
RegionId | String | cn-hangzhou | インスタンスのリージョン ID です。 |
VSwitchId | String | vsw-uf6adz52c2pxxxxxxx | VSwitch の ID です。 |
DedicatedHostIdForSlave | String | dh-bpxxxx | セカンダリインスタンスが存在するホストのID。 |
ResourceGroupId | String | rg-acfmyxxxxxxx | インスタンスが属するリソースグループの ID 。 |
カテゴリー | String | 基本 | インスタンスのRDSエディション。 有効な値:
|
Engine | String | MySQL | インスタンスによって実行されるデータベースエンジン。 |
DBInstanceClass | String | rds.mys2.small | インスタンスのインスタンスタイプ。 詳細については、「プライマリApsaraDB RDSインスタンスタイプ」をご参照ください。 |
ReadOnlyDBInstanceIds | ReadOnlyDBInstanceIdの配列 | インスタンスにアタッチされている読み取り専用インスタンスのIDで構成される配列。 このパラメーターは、インスタンスがプライマリインスタンスであり、読み取り専用インスタンスがある場合にのみ返されます。 | |
ReadOnlyDBInstanceId | |||
DBInstanceId | String | rr-uf6wjk5xxxxxxx | 読み取り専用インスタンスのID。 |
DeletionProtection | ブール | 偽 | 読み取り専用インスタンスでリリース保護機能が有効になっているかどうかを示します。 有効な値:
|
NextToken | String | o7PORW5o2TJg ********* | 次のページを表示するために使用されるトークン。 返されたエントリが複数のページに表示される場合、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パラメーターの値が無効な場合に返されるエラーメッセージ。 |
400 | InvalidDBInstanceType.ValueNotSupport | 指定されたパラメーター "DBInstanceType" は無効です。 | 指定されたインスタンスタイプが無効な場合に表示されるエラーメッセージ。 有効なインスタンスタイプを指定する必要があります。 |
エラーコードのリストについては、エラーセンターをご覧ください。