DescribeDBProxyEndpoint操作を呼び出して、ApsaraDB RDSインスタンスのデータベースプロキシへの接続に使用されるプロキシエンドポイントに関する詳細を照会できます。

DescribeDBProxyEndpoint操作を呼び出す前に、インスタンスのデータベースプロキシ機能を有効にするためにModifyDBProxy操作が呼び出されていることを確認してください。

デバッグ

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

リクエストパラメーター

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

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

DBInstanceId String 必須 rm-bp1ja4f56s7us ****

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

DBProxyEndpointId String 任意 keaxncrjluwu0gue ****

プロキシエンドポイントが属するプロキシ端末の名前。 DescribeDBProxy操作を呼び出して、プロキシ端末の名前を照会できます。

DBProxyConnectString String 任意 testproxy **** .rwlb.rds.aliyuncs.com

クエリするプロキシエンドポイント。 DescribeDBProxy操作を呼び出して、プロキシエンドポイントを照会できます。

RegionId String 必須 cn-hangzhou

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

DBProxyEngineType String 任意 normal

内部パラメーター。 指定する必要はありません。

レスポンスパラメーター

項目 データ型 例: 説明　
DBProxyConnectStringNetType String InnerString

プロキシエンドポイントのネットワークタイプ。 有効な値：

  • InnerString: 内部ネットワーク
  • OuterString: インターネット
DBProxyFeatures String TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1

プロキシ端末の設定。 このパラメーターの値は、次のフィールドで構成されるJSON文字列です。

  • TransactionReadSqlRouteOptimizeStatus: トランザクション分割機能のステータス。 有効な値: 0と1。 値0は、機能が無効であることを示します。 値1は、機能が有効になっていることを示します。
  • ConnectionPersist: 接続プール機能のステータス。 有効な値: 0、1、2 値0は、接続プール機能が無効であることを示します。 値1は、セッション接続プール機能が有効になっていることを示します。 値2は、トランザクション接続プール機能が有効になっていることを示します。
  • ReadWriteSpliting: 読み書き分離機能のステータス。 有効な値: 0と1。 値0は、機能が無効であることを示します。 値1は、機能が有効になっていることを示します。
  • PinPreparedStmt: ApsaraDB RDS for PostgrSQLインスタンスでのみ使用可能な内部フィールド。
    説明 インスタンスがPostgreSQLを実行している場合、ReadWriteSplitingフィールドの値のみを変更できます。 TransactionReadSqlRouteOptimizeStatusおよびPinPreparedStmtフィールドは、デフォルト値1に設定されます。
RequestId String 847BA085-B377-4BFA-8267-F82345ECE1D2

リクエストの ID です。

ReadOnlyInstanceWeight String [{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp176984qewd8 ****\",\"DBInstanceType\":\"ReadOnly\",\"Weight\":400 },{\ "Availability\",\"DBInstanceId\":\"rm-bp1ja4f56s7us ****\" 、\"\" マスター \"、\" 重量 \":0}]

インスタンスとその読み取り専用インスタンスの読み取り重み。 このパラメーターの値は、次のフィールドで構成されるJSON文字列です。

  • DBInstanceId: インスタンスのID。
  • DBInstanceType: インスタンスのロール。 有効な値: MasterおよびReadOnly。
  • Weight: インスタンスの読み取り重み。 読み取り重みは100単位で増加し、10000を超えることはできません。
説明 読み取り専用インスタンスがインスタンスにアタッチされていない場合、この操作はこのパラメーターにnullを返します。
ReadOnlyInstanceDistributionType String スタンダード

読み取り重みを割り当てるために使用されるメソッド。 詳細については、「ApsaraDB RDS for MySQL インスタンスの遅延しきい値と読み取り重みの変更」をご参照ください。 有効な値：

  • 標準: ApsaraDB RDSは、インスタンスの仕様に基づいて、インスタンスとその読み取り専用インスタンスに読み取り重みを自動的に割り当てます。
  • カスタム: インスタンスとその読み取り専用インスタンスに読み取り重みを手動で割り当てる必要があります。
ReadOnlyInstanceMaxDelayTime String 30

読み取り /書き込み分割で許可されるレイテンシしきい値。 読み取り専用インスタンスのレイテンシが指定されたしきい値を超えると、ApsaraDB RDSは読み取り要求を読み取り専用インスタンスに転送しなくなります。

DbProxyEndpointReadWriteMode String ReadWrite

プロキシ端末の読み取りおよび書き込み属性。 有効な値：

  • ReadWrite: プロキシ端末は読み取りおよび書き込み要求をサポートします。
  • ReadOnly: プロキシ端末は読み取り要求のみをサポートします。
DbProxyEndpointAliases String proxyterminal-test

プロキシ端末の説明。

DBProxyEndpointId String keaxncrjluwu0gue ****

プロキシエンドポイントのID。

DBProxyConnectStringPort String 3306

プロキシエンドポイントにバインドされているポート番号。

DBProxyConnectString String testproxy **** .rwlb.rds.aliyuncs.com

照会されたプロキシエンドポイント。

DBProxyEngineType String normal

内部パラメーター。 この操作では、このパラメーターの値は返されません。

EndpointConnectItems EndpointConnectItemsの配列

プロキシエンドポイントに関する情報で構成される配列。

EndpointConnectItems
DbProxyEndpointPort String 3306

プロキシエンドポイントに関連付けられているポート番号。 デフォルト値: 3306

DbProxyEndpointConnectString String testproxy **** .rwlb.rds.aliyuncs.com

照会されたプロキシエンドポイント。

DbProxyEndpointNetType String 2

プロキシエンドポイントのネットワークタイプ。 有効な値：

  • 0: インターネット
  • 1: クラシックネットワーク
  • 2: 仮想プライベートクラウド (VPC)

例

リクエストの例

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

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

XML 形式 

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

<DescribeDBProxyEndpointResponse>
    <DbProxyEndpointReadWriteMode>ReadWrite</DbProxyEndpointReadWriteMode>
    <ReadOnlyInstanceDistributionType> 標準 </ReadOnlyInstanceDistributionType>
    <DBProxyConnectString>testproxy **** .rwlb.rds.aliyuncs.com</DBProxyConnectString>
    <RequestId>336E33D5-8C02-4265-9627-704BF9F3954B</RequestId>
    <DBProxyEndpointId>keaxncrjluwu0guehzae</DBProxyEndpointId>
    <DbProxyEndpointAliases>proxyterminal-test</DbProxyEndpointAliases>
    <DBProxyFeatures>TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1;PinPreparedStmt:0</DBProxyFeatures>
    <ReadOnlyInstanceWeight>[{"Availability":"Available" 、"DBInstanceId":"rr-bp176984qewd8 ****" 、"DBInstanceType":"ReadOnly" 、"Weight":400 },{ "Availability":"Available" 、"DBInstanceId":"rm-bp1ja4f56s7us ****" 、"DBInstanceType":":"
    <ReadOnlyInstanceMaxDelayTime>30</ReadOnlyInstanceMaxDelayTime>
    <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
    <EndpointConnectItems>
        <EndpointConnectItems>
            <DbProxyEndpointNetType>2</DbProxyEndpointNetType>
            <DbProxyEndpointPort>3306</DbProxyEndpointPort>
            <DbProxyEndpointConnectString>testproxy **** .rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
        </EndpointConnectItems>
        <EndpointConnectItems>
            <DbProxyEndpointNetType>0</DbProxyEndpointNetType>
            <DbProxyEndpointPort>3306</DbProxyEndpointPort>
            <DbProxyEndpointConnectString>test **** .rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
        </EndpointConnectItems>
    </EndpointConnectItems>
    <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
</DescribeDBProxyEndpointResponse>

JSON 形式 

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

{
  "DbProxyEndpointReadWriteMode" : "ReadWrite" 、
  "ReadOnlyInstanceDistributionType" : "標準" 、
  "DBProxyConnectString" : "testproxy **** .rwlb.rds.aliyuncs.com" 、
  "RequestId" : "336E33D5-8C02-4265-9627-704BF9F3954B" 、
  "DBProxyEndpointId" : "keaxncrjluwu0guehzae" 、
  "DbProxyEndpointAliases" : "proxyterminal-test" 、
  "DBProxyFeatures" : "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1;PinPreparedStmt:0" 、
  "ReadOnlyInstanceWeight" : "[{\" Availability\":\" Available\",\" DBInstanceId\"\" rr-bp176984qewd8 ****\",\" DBInstanceType\":\" ReadOnly\",\" Weight\":400 },{" Availability\":\"DBInstanceId\" \*** "、rm-bp1ja4f56s7us \" DBInstanceType\":\" Master\"、\" Weight\":0}" 、
  "ReadOnlyInstanceMaxDelayTime" : "30" 、
  "DBProxyConnectStringNetType" : "InnerString" 、
  "EndpointConnectItems" : {
    "EndpointConnectItems" : [ {
      "DbProxyEndpointNetType" : "2" 、
      "DbProxyEndpointPort" : "3306" 、
      "DbProxyEndpointConnectString" : "testproxy **** .rwlb.rds.aliyuncs.com"
    }, {
      "DbProxyEndpointNetType" : "0" 、
      "DbProxyEndpointPort" : "3306" 、
      "DbProxyEndpointConnectString" : "test **** .rwlb.rds.aliyuncs.com"
    } ]
  },
  "DBProxyConnectStringPort" : "3306"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 InvalidEndPoint. フォーマット 指定されたEndPointは無効です。 DBProxyEndpointIdパラメーターが指定されていない場合、またはDBProxyEndpointIdパラメーターで指定されたIDが見つからない場合に返されるエラーメッセージ。
400 InvalidDBInstanceName 指定されたパラメーターDBInstanceNameは無効です。 DBInstanceNameパラメーターの値が無効な場合に返されるエラーメッセージ。 値がnullまたは空の文字列であるかどうかを確認します。
400 Endpoint.NotFound 指定されたEndPointは無効です。 指定されたプロキシ端末が存在しない場合に返されるエラーメッセージ。
403 IncorrectKindCode カスティンの現在のKindCodeは操作をサポートしていません。 インスタンスの設定がこの操作をサポートしていない場合に返されるエラーメッセージ。 インスタンスの設定を確認します。
403 IncorrectDBInstanceType 現在のデータベースインスタンスタイプは、この操作をサポートしていません。 インスタンスの設定がこの操作をサポートしていない場合に返されるエラーメッセージ。
404 Endpoint.NotFound 指定されたエンドポイントが見つかりません。 指定したポート番号が見つからない場合に返されるエラーメッセージ。

エラーコードリストについては、「API エラーセンター」をご参照ください。