DescribeDBProxy操作を呼び出して、ApsaraDB RDSインスタンスのデータベースプロキシに関する設定を照会できます。
DescribeDBProxy操作を呼び出す前に、インスタンスのデータベースプロキシ機能を有効にするためにModifyDBProxy操作が呼び出されていることを確認してください。
- ApsaraDB RDS for MySQLの専用プロキシ機能は、読み書き分離や短期間の接続最適化などの機能を提供します。 詳細については、「データベースプロキシとは」をご参照ください。
- ApsaraDB RDS for PostgreSQLのデータベースプロキシ機能は、読み書き分離をサポートしています。 詳細については、「データベースプロキシとは」をご参照ください。
デバッグ
リクエストパラメーター
項目 | データ型 | 必須/任意 | 例: | 説明 |
---|---|---|---|---|
操作 | String | 必須 | DescribeDBProxy |
実行する操作です。 値をDescribeDBProxyに設定します。 |
DBInstanceId | String | 必須 | rm-bp1ja4f56s7us **** |
インスタンスの ID です。 DescribeDBInstancesを呼び出して、インスタンスのIDを照会できます。 |
RegionId | String | 任意 | cn-hangzhou |
インスタンスのリージョン ID です。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。 |
DBProxyEngineType | String | 任意 | normal |
内部パラメーター。 指定する必要はありません。 |
ResourceGroupId | String | 任意 | rg-acfmy ***** |
リソースグループの ID です。 |
レスポンスパラメーター
項目 | データ型 | 例: | 説明 |
---|---|---|---|
DBProxyInstanceLatestMinorVersion | String | 1.13.12 |
インスタンスで使用可能な最新のプロキシバージョン。 |
RequestId | String | 909A69EE-71C8-4417-A0B9-FF085407E1E3 |
リクエストの ID です。 |
DBProxyInstanceCurrentMinorVersion | String | 1.13.11 |
インスタンスによって実行されるプロキシのバージョン。 |
DBProxyInstanceNum | Integer | 1 |
インスタンスで有効になっているプロキシの数。 |
DBProxyInstanceType | String | 2 |
インスタンスで有効になっているデータベースプロキシのタイプ。 有効な値:
説明 ApsaraDB RDS for PostgreSQLインスタンスは、専用プロキシのみをサポートします。
|
DBProxyInstanceStatus | String | Running |
プロキシインスタンスのステータス。 有効な値:
|
DBProxyServiceStatus | String | 起動 |
データベースプロキシ機能のステータス。 有効な値:
|
DBProxyInstanceName | String | gos787jog2wk0ye1 **** |
プロキシインスタンスの名前。 |
DBProxyInstanceSize | String | 4/8 |
プロキシインスタンスの仕様。 このパラメーターは、ApsaraDB RDS for PostgreSQLインスタンスでのみ使用できます。 フォーマット: コア数 /メモリ容量。 たとえば、値4/8は、プロキシインスタンスに4コアと8 GBのメモリがあることを示します。 |
DBProxyEngineType | String | normal |
内部パラメーター。 指定する必要はありません。 |
DBProxyConnectStringItems | DBProxyConnectStringItemsの配列 |
インスタンスに対して作成されたプロキシエンドポイントに関する情報で構成される配列。 |
|
DBProxyConnectStringItems | |||
DBProxyConnectStringNetWorkType | String | 2 |
データベースプロキシのネットワークタイプ。 有効な値:
|
DBProxyConnectStringNetType | String | InnerString |
プロキシエンドポイントのネットワークタイプ。 有効な値:
|
DBProxyVpcInstanceId | String | rm-bp145737x5 **** 131161274792 **** |
プロキシインスタンスのID。 |
DBProxyEndpointName | String | gos787jog2wk0ye1 **** |
プロキシエンドポイントが属するプロキシ端末の名前。 |
DBProxyEndpointId | String | 20 **** |
プロキシエンドポイントが属するプロキシ端末のID。 |
DBProxyConnectStringPort | String | 3306 |
プロキシエンドポイントに関連付けられているポート番号。 |
DBProxyConnectString | String | gos787jog2wk0ye1 **** -rw4rm.rwlb.rds.aliyuncs.com |
プロキシ端末のエンドポイント。 |
DbProxyEndpointItems | DbProxyEndpointItemsの配列 |
プロキシ端末に関する情報で構成される配列。 |
|
DbProxyEndpointItems | |||
DbProxyEndpointAliases | String | proxy-test |
プロキシ端末の説明。 |
DbProxyEndpointName | String | gos787jog2wk0ye1 **** |
プロキシ端末のID。 |
DbProxyEndpointType | String | RWSplit |
プロキシ端末のタイプ。 有効な値:
|
DbProxyReadWriteMode | String | ReadWrite |
プロキシ端末の読み取りおよび書き込み属性。
|
ResourceGroupId | String | rg-acfmy ***** |
リソースグループの ID です。 |
例
リクエストの例
http(s):// rds.aliyuncs.com/?Action=DescribeDBProxy
&DBInstanceId=rm-bp1ja4f56s7us ****
&<共通リクエストパラメーター>
正常に処理された場合のレスポンス例
XML
形式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBProxyResponse>
<DBProxyInstanceName>gos787jog2wk0ye1 ****</DBProxyInstanceName>
<DBProxyInstanceCurrentMinorVersion>1.13.11</DBProxyInstanceCurrentMinorVersion>
<DBProxyServiceStatus> スタートアップ </DBProxyServiceStatus>
<DBProxyInstanceNum>1</DBProxyInstanceNum>
<DBProxyInstanceLatestMinorVersion>1.13.12</DBProxyInstanceLatestMinorVersion>
<RequestId>909A69EE-71C8-4417-A0B9-FF085407E1E3</RequestId>
<DbProxyEndpointItems>
<DbProxyEndpointItems>
<DbProxyEndpointName>gos787jog2wk0ye1 ****</DbProxyEndpointName>
<DbProxyEndpointAliases> プロキシテスト </DbProxyEndpointAliases>
<DbProxyEndpointType>RWSplit</DbProxyEndpointType>
<DbProxyReadWriteMode>ReadWrite</DbProxyReadWriteMode>
</DbProxyEndpointItems>
</DbProxyEndpointItems>
<DBProxyConnectStringItems>
<DBProxyConnectStringItems>
<DBProxyConnectString>gos787jog2wk0ye1 **** -rw4rm.rwlb.rds.aliyuncs.com</DBProxyConnectString>
<DBProxyEndpointId>209090</DBProxyEndpointId>
<DBProxyEndpointName>gos787jog2wk0ye1 ****</DBProxyEndpointName>
<DBProxyConnectStringNetWorkType>2</DBProxyConnectStringNetWorkType>
<DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
<DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
<DBProxyVpcInstanceId>rm-bp145737x5 **** 131161274792 ****</DBProxyVpcInstanceId>
</DBProxyConnectStringItems>
</DBProxyConnectStringItems>
<DBProxyInstanceStatus> 実行中 </DBProxyInstanceStatus>
<DBProxyInstanceType>2</DBProxyInstanceType>
</DescribeDBProxyResponse>
JSON
形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"DBProxyInstanceName" : "gos787jog2wk0ye1 ****" 、
"DBProxyInstanceCurrentMinorVersion" : "1.13.11" 、
"DBProxyServiceStatus" : "スタートアップ" 、
"DBProxyInstanceNum" : 1、
"DBProxyInstanceLatestMinorVersion" : "1.13.12" 、
"RequestId" : "909A69EE-71C8-4417-A0B9-FF085407E1E3" 、
"DbProxyEndpointItems" : {
"DbProxyEndpointItems" : [ {
"DbProxyEndpointName" : "gos787jog2wk0ye1 ****" 、
"DbProxyEndpointAliases" : "proxy-test" 、
"DbProxyEndpointType" : "RWSplit" 、
"DbProxyReadWriteMode" : "ReadWrite"
} ]
},
"DBProxyConnectStringItems" : {
"DBProxyConnectStringItems" : [ {
"DBProxyConnectString" : "gos787jog2wk0ye1 **** -rw4rm.rwlb.rds.aliyuncs.com" 、
"DBProxyEndpointId" : 209090、
"DBProxyEndpointName" : "gos787jog2wk0ye1 ****" 、
"DBProxyConnectStringNetWorkType" : 2、
"DBProxyConnectStringNetType" : "InnerString" 、
"DBProxyConnectStringPort" : "3306" 、
"DBProxyVpcInstanceId" : "rm-bp145737x5 **** 131161274792 ****"
} ]
},
"DBProxyInstanceStatus" : "Running" 、
"DBProxyInstanceType" : "2"
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
400 | InvalidDBInstanceName | 指定されたパラメーターDBInstanceNameは無効です。 | DBInstanceNameパラメーターの値が無効な場合に返されるエラーメッセージ。 値がnullまたは空の文字列であるかどうかを確認します。 |
403 | IncorrectKindCode | 現在のcustins kindCodeはこの操作をサポートしていません。 | インスタンスの設定がこの操作をサポートしていない場合に返されるエラーメッセージ。 インスタンスの設定を確認します。 |
403 | IncorrectDBInstanceType | データベースインスタンスタイプは操作をサポートしていません。 | この操作がインスタンスで実行されているデータベースエンジンでサポートされていない場合に返されるエラーメッセージ。 |
エラーコードリストについては、「API エラーセンター」をご参照ください。