この API は、RDS インスタンスのリストを取得します。
操作説明
サポートされているエンジン
RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rds:DescribeDBInstances |
get |
DBInstance
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するためのクライアント生成トークン。各リクエストで一意である必要があり、長さは 64 文字以内で、ASCII 文字のみを含める必要があります。 |
ETnLKlblzczshOTUbOCz**** |
| proxyId |
string |
任意 |
このパラメーターは非推奨です。指定する必要はありません。 |
API |
| Engine |
string |
任意 |
データベースエンジン。有効値:
指定しない場合、すべてのエンジンのインスタンスが返されます。 |
MySQL |
| ZoneId |
string |
任意 |
ゾーン ID。 |
cn-hangzhou-a |
| ResourceGroupId |
string |
任意 |
リソースグループ ID。 |
rg-acfmy**** |
| DBInstanceStatus |
string |
任意 |
インスタンスステータス。詳細については、「インスタンスステータス一覧」をご参照ください。 |
Running |
| Expired |
string |
任意 |
インスタンスが期限切れかどうかを指定します。有効値:
|
True |
| SearchKey |
string |
任意 |
インスタンス ID と説明に対するあいまい検索のキーワード。 |
rm-uf6w |
| DBInstanceId |
string |
任意 |
インスタンス ID。 |
rm-uf6wjk5**** |
| DBInstanceType |
string |
任意 |
インスタンスタイプ。有効値:
指定しない場合、すべてのタイプのインスタンスが返されます。 |
Primary |
| RegionId |
string |
必須 |
リージョン ID。DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。 |
cn-hangzhou |
| PageSize |
integer |
任意 |
各ページに返すエントリ数。有効値:1~100。 デフォルト:30。 |
30 |
| PageNumber |
integer |
任意 |
返すページ番号。0 より大きい整数である必要があります。 デフォルト:1。 |
1 |
| InstanceNetworkType |
string |
任意 |
インスタンスのネットワークタイプ。有効値:
指定しない場合、両方のネットワークタイプのインスタンスが返されます。 |
Classic |
| VpcId |
string |
任意 |
VPC ID。 |
vpc-uf6f7l4fg90**** |
| VSwitchId |
string |
任意 |
vSwitch ID。 |
vsw-uf6adz52c2p**** |
| DBInstanceClass |
string |
任意 |
インスタンスクラス。詳細については、「インスタンスクラス一覧」をご参照ください。 |
rds.mys2.small |
| EngineVersion |
string |
任意 |
データベースエンジンバージョン。 |
8.0 |
| PayType |
string |
任意 |
課金方法。有効値:
|
Postpaid |
| ConnectionMode |
string |
任意 |
インスタンスの接続モード。有効値:
指定しない場合、すべての接続モードのインスタンスが返されます。 |
Standard |
| Tags |
string |
任意 |
インスタンスをフィルターするためのタグ。JSON 文字列で最大 5 つのタグをキーと値のペアとして指定できます。指定されたタグのいずれかを持つインスタンスが返されます。 |
{"key1":"value1"} |
| DedicatedHostGroupId |
string |
任意 |
専用クラスター ID。 |
dhg-7a9**** |
| DedicatedHostId |
string |
任意 |
専用クラスター内のホストの ID。 |
i-bp**** |
| InstanceLevel |
integer |
任意 |
|
0 |
| QueryAutoRenewal |
boolean |
任意 |
このパラメーターは予約済みです。指定する必要はありません。 |
test |
| ConnectionString |
string |
任意 |
インスタンスエンドポイント。指定した場合、この操作はこのエンドポイントに関連付けられたインスタンスのみを返します。 |
rm-uf6wjk5****.mysql.rds.aliyuncs.com |
| NextToken |
string |
任意 |
前回の DescribeDBInstances 操作の呼び出しからのページネーショントークン。結果の次のページを取得するには、前回の応答から NextToken の値を指定します。 |
o7PORW5o2TJg**** |
| MaxResults |
integer |
任意 |
各ページに返す最大エントリ数。有効値:1~100。 デフォルト:30。 説明
このパラメーターを指定すると、 |
30 |
| Filter |
string |
任意 |
クエリのフィルター条件を含む JSON 文字列。 |
{"babelfishEnabled":"true"} |
| Category |
string |
任意 |
インスタンスエディション。有効値:
|
cluster |
この API は、結果をページ分割するための次の 2 つのメソッドをサポートしています:
メソッド 1:MaxResults パラメーターを使用してページごとのレコード数を設定し、NextToken パラメーターを使用して後続のページを取得します。NextToken の値は、前回の DescribeDBInstances API の呼び出しから返された NextToken です。
ページ分割されたクエリの最初のリクエストでは、MaxResults パラメーターのみを設定します。API は、データの最初のページと NextToken の値を返します。
メソッド 2:PageSize パラメーターを使用してページごとのレコード数を設定し、PageNumber パラメーターを使用して特定のページをリクエストします。
これらのメソッドのいずれか 1 つのみを一度に使用できます。大きな結果セットでクエリパフォーマンスを向上させるには、メソッド 1 を使用してください。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーターの詳細。 |
||
| Items |
object |
||
| DBInstance |
array<object> |
インスタンス詳細の配列。 |
|
|
array<object> |
インスタンスの詳細。 |
||
| BpeEnabled |
string |
このパラメーターは非推奨です。 |
0 |
| BurstingEnabled |
boolean |
I/O バースト機能が有効かどうかを示します。有効値:
|
false |
| Category |
string |
インスタンスカテゴリ。有効値:
説明
このパラメーターは、 |
Basic |
| IsAnalyticReadOnlyIns |
boolean |
インスタンスが MySQL DuckDB 分析インスタンスであるかどうかを示します。有効値:
|
false |
| ConnectionMode |
string |
インスタンスの接続モード。有効値:
|
Standard |
| ConnectionString |
string |
インスタンスのエンドポイント。 |
rm-uf6wjk5****.mysql.rds.aliyuncs.com |
| CreateTime |
string |
インスタンスが作成された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。 |
2018-11-05T11:26:02Z |
| DBInstanceCPU |
string |
CPU コアの数。 説明
このパラメーターは、InstanceLevel パラメーターが 1 に設定されている場合にのみ返されます。 |
2 |
| DBInstanceClass |
string |
インスタンスタイプ。詳細については、「プライマリ ApsaraDB RDS for MySQL インスタンスタイプ」をご参照ください。 |
rds.mys2.small |
| DBInstanceDescription |
string |
インスタンスの説明。 |
testdb |
| DBInstanceId |
string |
インスタンス ID。 |
rm-uf6wjk5**** |
| DBInstanceMemory |
integer |
ノードのメモリ容量。単位:MB。 説明
このパラメーターは、InstanceLevel パラメーターが 1 に設定されている場合にのみ返されます。 |
4096 |
| DBInstanceNetType |
string |
インスタンスのネットワーク接続タイプ。有効値:
|
Internet |
| DBInstanceStatus |
string |
インスタンス状態。詳細については、「インスタンス状態」をご参照ください。 |
Running |
| DBInstanceStorageType |
string |
インスタンスのストレージタイプ。 |
ModuleList.4.ModuleCode |
| DBInstanceType |
string |
インスタンスエディション。有効値:
|
Primary |
| DedicatedHostGroupId |
string |
専用クラスター ID。 |
dhg-7a9**** |
| DedicatedHostGroupName |
string |
専用クラスターの名前。 |
testhostgroup |
| DedicatedHostIdForLog |
string |
ログノードが常駐するホストの ID。 |
dh-bp**** |
| DedicatedHostIdForMaster |
string |
プライマリノードが常駐するホストの ID。 |
dh-bp**** |
| DedicatedHostIdForSlave |
string |
セカンダリノードが常駐するホストの ID。 |
dh-bp**** |
| DedicatedHostNameForLog |
string |
ログノードが常駐するホストの名前。 |
testlog |
| DedicatedHostNameForMaster |
string |
プライマリノードが常駐するホストの名前。 |
testmaster |
| DedicatedHostNameForSlave |
string |
セカンダリノードが常駐するホストの名前。 |
testslave |
| DedicatedHostZoneIdForLog |
string |
ログノードが常駐するホストのゾーン ID。 |
cn-hangzhou-b |
| DedicatedHostZoneIdForMaster |
string |
プライマリノードが常駐するホストのゾーン ID。 |
cn-hangzhou-c |
| DedicatedHostZoneIdForSlave |
string |
セカンダリノードが常駐するホストのゾーン ID。 |
cn-hangzhou-d |
| DeletionProtection |
boolean |
リリース保護機能が有効かどうかを示します。有効値:
|
false |
| DestroyTime |
string |
インスタンスが削除された時刻。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。 |
2018-11-05T11:26:02Z |
| Engine |
string |
データベースエンジン。 |
MySQL |
| EngineVersion |
string |
データベースエンジンバージョン。 |
5.7 |
| ExpireTime |
string |
サブスクリプションインスタンスの有効期限。時刻は ISO 8601 標準に準拠し、yyyy-MM-ddTHH:mm:ssZ 形式で、協定世界時 (UTC) で表示されます。 説明
従量課金インスタンスは有効期限が切れません。 |
2019-02-27T16:00:00Z |
| GeneralGroupName |
string |
専用クラスター内の汎用 ApsaraDB RDS for MySQL インスタンスが属するグループの名前。 |
TestGroup |
| GuardDBInstanceId |
string |
インスタンスがプライマリインスタンスであり、ディザスタリカバリインスタンスがある場合、このパラメーターはディザスタリカバリインスタンスの ID です。 |
rm-uf64zsu**** |
| InstanceNetworkType |
string |
インスタンスのネットワークタイプ。有効値:
|
Classic |
| IoAccelerationEnabled |
string |
I/O アクセラレーションが有効かどうかを示します。有効値:
|
0 |
| LockMode |
string |
インスタンスのロック状態。有効値:
|
Unlock |
| LockReason |
string |
インスタンスがロックされた理由。 |
instance_expired |
| MasterInstanceId |
string |
プライマリインスタンスの ID。このパラメーターが null の場合、インスタンスはプライマリインスタンスです。 |
rm-uf6wjk5**** |
| MutriORsignle |
boolean |
インスタンスが複数ゾーンにデプロイされているかどうかを示します。有効値:
説明
複数ゾーンデプロイメントは、ゾーン ID に MAZ が含まれるデプロイメントです。たとえば、ゾーン ID は |
true |
| PayType |
string |
インスタンスの課金方法。有効値:
|
Postpaid |
| ReadOnlyDBInstanceIds |
object |
||
| ReadOnlyDBInstanceId |
array<object> |
プライマリインスタンスにアタッチされている読み取り専用インスタンスの ID。 |
|
|
object |
読み取り専用インスタンスの詳細。 |
||
| DBInstanceId |
string |
読み取り専用インスタンス ID。 |
rr-uf6wjk5**** |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| ResourceGroupId |
string |
リソースグループ ID。 |
rg-acfmy**** |
| SwitchWeight |
integer |
専用クラスター内の汎用 ApsaraDB RDS for MySQL インスタンスが高可用性重み付けスイッチオーバーをサポートしているかどうかを示します。有効値:
|
100 |
| TempDBInstanceId |
string |
インスタンスがプライマリインスタンスであり、一時インスタンスがある場合、このパラメーターは一時インスタンスの ID です。 |
rm-uf64zsu**** |
| Tips |
string |
専用クラスター内の汎用 ApsaraDB RDS for MySQL インスタンスの例外メッセージ。 |
normal |
| TipsLevel |
integer |
専用クラスター内の汎用 ApsaraDB RDS for MySQL インスタンスで検出された例外の重大度。有効値:
|
1 |
| VSwitchId |
string |
vSwitch ID。 |
vsw-uf6adz52c2p**** |
| VpcCloudInstanceId |
string |
VPC インスタンス ID。 |
rm-uf6wjk5**** |
| VpcId |
string |
VPC ID。 |
vpc-uf6f7l4fg90**** |
| VpcName |
string |
VPC 名。 |
test-huadong |
| ZoneId |
string |
ゾーン ID。 |
cn-hangzhou-a |
| BlueGreenDeploymentName |
string |
予約済みパラメーター。 |
test |
| BlueInstanceName |
string |
予約済みパラメーター。 |
test |
| GreenInstanceName |
string |
予約済みパラメーター。 |
test |
| AutoRenewal |
boolean |
自動更新が有効かどうかを示します。有効値:
説明
このパラメーターは、 |
false |
| ColdDataEnabled |
boolean |
予約済みパラメーター。 |
false |
| IsAnalyticIns |
string |
||
| NextToken |
string |
次のリクエストで新しい結果ページを取得するために使用されるページネーショントークン。NextToken パラメーターが返されない場合、これ以上の結果はありません。 |
o7PORW5o2TJg**** |
| PageNumber |
integer |
ページ番号。 説明
MaxResults または NextToken パラメーターを指定した場合、このパラメーターは返されません。このパラメーターには値 1 が暗黙的に使用されます。 |
1 |
| PageRecordCount |
integer |
現在のページのインスタンス数。 |
10 |
| RequestId |
string |
リクエスト ID。 |
1AD222E9-E606-4A42-BF6D-8A4442913CEF |
| TotalRecordCount |
integer |
返されたエントリの総数。 説明
MaxResults または NextToken パラメーターを指定した場合、このパラメーターは返されません。このパラメーターには現在のページのエントリ数が暗黙的に使用されます。 |
100 |
例
成功レスポンス
JSONJSON
{
"Items": {
"DBInstance": [
{
"BpeEnabled": "0",
"BurstingEnabled": false,
"Category": "Basic",
"IsAnalyticReadOnlyIns": false,
"ConnectionMode": "Standard",
"ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
"CreateTime": "2018-11-05T11:26:02Z",
"DBInstanceCPU": "2",
"DBInstanceClass": "rds.mys2.small",
"DBInstanceDescription": "testdb",
"DBInstanceId": "rm-uf6wjk5****",
"DBInstanceMemory": 4096,
"DBInstanceNetType": "Internet",
"DBInstanceStatus": "Running",
"DBInstanceStorageType": "ModuleList.4.ModuleCode",
"DBInstanceType": "Primary",
"DedicatedHostGroupId": "dhg-7a9****",
"DedicatedHostGroupName": "testhostgroup",
"DedicatedHostIdForLog": "dh-bp****",
"DedicatedHostIdForMaster": "dh-bp****",
"DedicatedHostIdForSlave": "dh-bp****",
"DedicatedHostNameForLog": "testlog",
"DedicatedHostNameForMaster": "testmaster",
"DedicatedHostNameForSlave": "testslave",
"DedicatedHostZoneIdForLog": "cn-hangzhou-b",
"DedicatedHostZoneIdForMaster": "cn-hangzhou-c",
"DedicatedHostZoneIdForSlave": "cn-hangzhou-d",
"DeletionProtection": false,
"DestroyTime": "2018-11-05T11:26:02Z",
"Engine": "MySQL",
"EngineVersion": "5.7",
"ExpireTime": "2019-02-27T16:00:00Z",
"GeneralGroupName": "TestGroup",
"GuardDBInstanceId": "rm-uf64zsu****",
"InstanceNetworkType": "Classic",
"IoAccelerationEnabled": "0",
"LockMode": "Unlock",
"LockReason": "instance_expired",
"MasterInstanceId": "rm-uf6wjk5****",
"MutriORsignle": true,
"PayType": "Postpaid",
"ReadOnlyDBInstanceIds": {
"ReadOnlyDBInstanceId": [
{
"DBInstanceId": "rr-uf6wjk5****"
}
]
},
"RegionId": "cn-hangzhou",
"ResourceGroupId": "rg-acfmy****",
"SwitchWeight": 100,
"TempDBInstanceId": "rm-uf64zsu****",
"Tips": "normal",
"TipsLevel": 1,
"VSwitchId": "vsw-uf6adz52c2p****",
"VpcCloudInstanceId": "rm-uf6wjk5****",
"VpcId": "vpc-uf6f7l4fg90****",
"VpcName": "test-huadong",
"ZoneId": "cn-hangzhou-a",
"BlueGreenDeploymentName": "test",
"BlueInstanceName": "test",
"GreenInstanceName": "test",
"AutoRenewal": false,
"ColdDataEnabled": false,
"IsAnalyticIns": ""
}
]
},
"NextToken": "o7PORW5o2TJg****",
"PageNumber": 1,
"PageRecordCount": 10,
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"TotalRecordCount": 100
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | Invalid.NextToken | The parameter NextToken is invalid. | |
| 400 | InvalidDBInstanceType.ValueNotSupport | The specified parameter DBInstanceType is not valid. | |
| 400 | InvalidParameter.OwnerAccount | The specified parameter OwnerAccount is not valid. | |
| 400 | TimeoutRetryLater | Timeout, Please retry later. | |
| 400 | InvalidExpired.Format | The instance expiration status parameter is incorrect. | |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | |
| 400 | Abs.ImageNotFound | The specified Image is disabled or is deleted. | |
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | |
| 400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | |
| 400 | Price.CommoditySys | Commodity system call exception. | |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | |
| 400 | pay.noCreditCard | Account not bound to credit card. | |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | |
| 400 | Api.NotSupport | Specified api is not supported. | |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | |
| 400 | KmsApiError | User secret key invalid. | |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | |
| 400 | RequiredParam.NotFound | Required input param is not found. | |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | |
| 400 | Pay.NoCreditCard | No credit cards. | |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | |
| 400 | OrdTCommodityQueryError | Failed to query for product. | |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | |
| 403 | NotInFlowController | Sorry,no permission. | |
| 403 | InvalidKmsKey | Kms key is disabled. | |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | |
| 404 | Request.NotFound | The requested resource is not available. | |
| 404 | HostInfo.NotFound | The specified host info is not found. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。