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

ApsaraDB RDS for MySQLインスタンスの専用プロキシ機能を有効にするか、ApsaraDB RDS for PostgreSQLインスタンスのデータベースプロキシ機能を有効にすると、デフォルトのプロキシエンドポイントが作成されます。 この操作では、さまざまなネットワークタイプのプロキシエンドポイントを作成できます。 詳細については、「データベースプロキシとは」をご参照ください。 ApsaraDB RDS for PostgreSQLインスタンスのデータベースプロキシ機能のアクティブ化と設定を行います。

説明
  • ローカルSSDを使用するインスタンスでは、VPC、クラシック、およびパブリックのネットワークタイプがサポートされています。
  • 標準SSDまたは拡張SSD (ESSD) を使用するインスタンスでは、次のネットワークタイプがサポートされています。 パブリックネットワークタイプのプロキシエンドポイントを作成する場合は、インスタンスとその読み取り専用インスタンスのIPアドレスホワイトリストを設定して、クライアントとインスタンス間の接続を確保する必要があります。 ModifySecurityIpsを呼び出して、インスタンスのIPアドレスホワイトリストを設定できます。

デバッグ

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

リクエストパラメーター

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

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

RegionId String 必須 cn-hangzhou

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

DBInstanceId String 必須 rm-t4n3axxxxx

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

DBProxyEndpointId String 必須 ta9um4xxxxx

プロキシエンドポイントのID。 DescribeDBProxyEndpoint操作を呼び出して、プロキシエンドポイントのIDを照会できます。

ConnectionStringPrefix String 必須 test1234

プロキシエンドポイントのプレフィックス。 カスタムプレフィックスを入力します。

DBProxyNewConnectStringPort String 任意 3306

プロキシエンドポイントに関連付けられているポート番号。

  • インスタンスがMySQLを実行する場合、デフォルト値は3306です。
  • インスタンスがPostgreSQLを実行している場合、デフォルト値は5432です。
DBProxyConnectStringNetType String 必須 Public

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

  • パブリック
  • [VPC]
  • クラシック

デフォルト値: Classic。

VPCId String 任意 vpc-bpxxxxxx

プロキシエンドポイントが属する仮想プライベートクラウド (VPC) のID。 DescribeDBInstanceAttributeを呼び出して、VPCのIDを照会できます。

説明 DBProxyConnectStringNetTypeパラメーターをVPCに設定した場合、VPCIdパラメーターも指定する必要があります。
VSwitchId String 任意 vsw-bpxxxxxx

指定されたVPCに関連付けられているvSwitchのID。 DescribeDBInstanceAttributeを呼び出して、vSwitchのIDを照会できます。

説明 DBProxyConnectStringNetTypeパラメーターをVPCに設定した場合、VSwitchIdパラメーターも指定する必要があります。
DBProxyEngineType String 任意 normal

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

ResourceGroupId String 任意 rg-acfmy *****

リソースグループの ID です。

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String F2911788-25E8-42E5-A3A3-1B38D263F01E

リクエストの ID です。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=CreateDBProxyEndpointAddress
&RegionId=cn-hangzhou
&DBInstanceId=m-t4n3axxxxx
&DBProxyEndpointId=ta9um4xxxxx
&DBProxyConnectStringNetType=パブリック
&ConnectionStringPrefix=test1234
&<共通リクエストパラメーター>

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

XML 形式

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

<CreateDBProxyEndpointAddressResponse>
<RequestId>F2911788-25E8-42E5-A3A3-1B38D263F01E</RequestId>
</CreateDBProxyEndpointAddressResponse>

JSON 形式

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

{
  "RequestId" : "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 InvalidPort.Malformed Specified port is not valid. 指定したポート番号が無効な場合に返されるエラーメッセージ。
400 NetTypeExists Specified net type already existed. 指定されたネットワークタイプのプロキシエンドポイントがすでに存在する場合に返されるエラーメッセージ。
400 IncorrectDBInstanceNetType 現在のDBインスタンスのネットタイプは、この操作をサポートしていません。 インスタンスのネットワークタイプがこの操作をサポートしていない場合に返されるエラーメッセージ。
400 InvalidConnectionString.Duplicate 指定された接続文字列は既にAliyun RDS に存在します。 指定したプロキシエンドポイントが既に存在する場合に返されるエラーメッセージ。 別のエンドポイントを指定します。
400 InvalidVpcInstanceId 指定されたvpcインスタンスidは無効です。 指定したVPC IDが無効な場合に返されるエラーメッセージ。
400 InvalidDBInstanceName 指定されたパラメーターDBInstanceNameは無効です。 DBInstanceNameパラメーターの値が無効な場合に返されるエラーメッセージ。 値がnullまたは空の文字列であるかどうかを確認します。
403 IncorrectDBInstanceType Current DB instance type does not support this operation. インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
403 IncorrectDBInstanceState Current DB instance state does not support this operation. インスタンスが現在の状態の場合、この操作がサポートされていない場合に返されるエラーメッセージ。
404 Endpoint.NotFound 指定されたエンドポイントが見つかりません。 専用プロキシエンドポイントへの接続に使用されるポートが見つからない場合に返されるエラーメッセージ。
404 InvalidVSwitchId.NotFound 指定されたVSwitchは無効です。 指定したvSwitch IDが無効な場合に返されるエラーメッセージ。
404 Maxscale.NotFound 関連するmaxscaleインスタンスが見つかりません。 関連付けられたMaxScaleインスタンスが見つからない場合に返されるエラーメッセージ。

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