RDS インスタンスのリストを取得します。
操作説明
サポートされているエンジン
RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
rds:DescribeDBInstances |
get |
DBInstance
|
|
なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するためにクライアントで生成されたトークン。このトークンはリクエスト間で一意である必要があります。ASCII 文字のみを含めることができ、長さは 64 文字以内です。 |
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 |
任意 |
インスタンスをフィルターするためのタグ。 |
{"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 API 呼び出しによって返された NextToken 値に設定します。 |
o7PORW5o2TJg**** |
| MaxResults |
integer |
任意 |
各ページに返すエントリ数。有効な値:1~100。 デフォルト値:30。 説明
このパラメーターを指定すると、PageSize および PageNumber パラメーターは無視されます。 |
30 |
| Filter |
string |
任意 |
インスタンスのフィルター条件と値を指定する JSON 文字列。 |
{"babelfishEnabled":"true"} |
| Category |
string |
任意 |
インスタンスのカテゴリ。有効な値:
|
cluster |
この API は 2 つのページネーションメソッドをサポートしています:
方法 1:MaxResults パラメーターを使用してページごとのレコード数を設定し、前の DescribeDBInstances API 呼び出しからの NextToken 値を使用して次のページの結果を取得します。
最初のページ分割リクエストでは、MaxResults パラメーターを設定するだけで済みます。レスポンスには、データの最初のページと対応する NextToken 値が含まれます。
方法 2:PageSize パラメーターを使用してページごとのレコード数を設定し、PageNumber パラメーターを使用して特定のページに移動します。
これらのメソッドのうち、一度に使用できるのは 1 つだけです。多数のレコードをクエリする場合は、パフォーマンスを向上させるために最初の方法を推奨します。
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメーター。 |
||
| Items |
object |
インスタンスのリスト。 |
|
| DBInstance |
array<object> |
インスタンスの詳細。 |
|
|
array<object> |
インスタンスの詳細。 |
||
| BpeEnabled |
string |
このパラメーターは非推奨です。 |
0 |
| BurstingEnabled |
boolean |
I/O バーストが有効かどうかを示します。有効な値:
|
false |
| Category |
string |
インスタンスのカテゴリ。有効な値:
説明
このパラメーターは、InstanceLevel パラメーターが 1 に設定されている場合にのみ返されます。 |
Basic |
| IsAnalyticReadOnlyIns |
boolean |
インスタンスが MySQL DuckDB 分析インスタンスであるかどうかを示します。有効な値:
|
false |
| ConnectionMode |
string |
インスタンスの接続モード。有効な値:
|
Standard |
| ConnectionString |
string |
インスタンスのエンドポイント。 |
rm-uf6wjk5****.mysql.rds.aliyuncs.com |
| CreateTime |
string |
インスタンスの作成時間。時刻は yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。 |
2018-11-05T11:26:02Z |
| DBInstanceCPU |
string |
インスタンスの CPU コア数。 説明
このパラメーターは、InstanceLevel パラメーターが 1 に設定されている場合にのみ返されます。 |
2 |
| DBInstanceClass |
string |
インスタンスタイプ。詳細については、「インスタンスタイプ」をご参照ください。 |
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 |
インスタンスがリリースされた時間。時刻は yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。 |
2018-11-05T11:26:02Z |
| Engine |
string |
インスタンスのデータベースエンジン。 |
MySQL |
| EngineVersion |
string |
データベースエンジンバージョン。 |
5.7 |
| ExpireTime |
string |
サブスクリプションインスタンスの有効期限。時刻は yyyy-MM-ddTHH:mm:ssZ 形式に従います。時刻は協定世界時 (UTC) で表示されます。 説明
従量課金インスタンスは有効期限がありません。 |
2019-02-27T16:00:00Z |
| GeneralGroupName |
string |
専用クラスター内でインスタンスが属する汎用グループの名前。 |
TestGroup |
| GuardDBInstanceId |
string |
プライマリインスタンスにアタッチされているディザスタリカバリインスタンスの ID。 |
rm-uf64zsu**** |
| InstanceNetworkType |
string |
インスタンスのネットワークタイプ。有効な値:
|
Classic |
| IoAccelerationEnabled |
string |
I/O アクセラレーション機能が有効かどうかを示します。有効な値:
|
0 |
| LockMode |
string |
インスタンスのロック状態。有効な値:
|
Unlock |
| LockReason |
string |
インスタンスがロックされた理由。 |
instance_expired |
| MasterInstanceId |
string |
プライマリインスタンスの ID。このパラメーターが返されない場合、インスタンスはプライマリインスタンスです。 |
rm-uf6wjk5**** |
| MutriORsignle |
boolean |
インスタンスがマルチゾーンインスタンスであるかどうかを示します。有効な値:
説明
マルチゾーンインスタンスは、ゾーン ID に |
true |
| PayType |
string |
インスタンスの課金方法。有効な値:
|
Postpaid |
| ReadOnlyDBInstanceIds |
object |
読み取り専用インスタンスの ID。 |
|
| ReadOnlyDBInstanceId |
array<object> |
プライマリインスタンスにアタッチされている読み取り専用インスタンスの ID。 |
|
|
object |
読み取り専用インスタンスの詳細。 |
||
| DBInstanceId |
string |
読み取り専用インスタンスの ID。 |
rr-uf6wjk5**** |
| RegionId |
string |
リージョン ID。 |
cn-hangzhou |
| ResourceGroupId |
string |
リソースグループ ID。 |
rg-acfmy**** |
| SwitchWeight |
integer |
専用クラスターで MySQL を実行する汎用インスタンスの重みベースの切り替えがサポートされているかどうかを示します。有効な値:
|
100 |
| TempDBInstanceId |
string |
プライマリインスタンスにアタッチされている一時インスタンスの ID。 |
rm-uf64zsu**** |
| Tips |
string |
専用クラスターで MySQL を実行する汎用インスタンスに関する例外情報。 |
normal |
| TipsLevel |
integer |
専用クラスターで 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 |
自動更新が有効かどうかを示します。有効な値:
説明
このパラメーターは、PayType が Prepaid に設定されている場合にのみ返されます。 |
false |
| ColdDataEnabled |
boolean |
予約済み。 |
false |
| IsAnalyticIns |
string |
||
| NextToken |
string |
次のページの結果を取得するために使用されるトークン。レスポンスが切り捨てられた場合、このトークンを使用して次のページの結果を取得できます。 |
o7PORW5o2TJg**** |
| PageNumber |
integer |
ページ番号。 説明
MaxResults または NextToken パラメーターを指定した場合、このパラメーターは返されません。 |
1 |
| PageRecordCount |
integer |
現在のページで返されるインスタンスの数。 |
10 |
| RequestId |
string |
リクエスト ID。 |
1AD222E9-E606-4A42-BF6D-8A4442913CEF |
| TotalRecordCount |
integer |
返されるエントリの総数。 説明
|
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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。