ModifyDbProxyInstanceSsl操作を呼び出して、ApsaraDB RDSインスタンスの専用プロキシエンドポイントにSSL暗号化を設定できます。

ApsaraDB RDSは専用プロキシ機能を提供します。 インスタンスの専用プロキシエンドポイントにSSL暗号化を設定できます。 これにより、インスタンスのデータセキュリティが保証されます。 詳細については、「専用プロキシ」をご参照ください。

この API を呼び出す場合、インスタンスは次の要件を満たしている必要があります。

  • インスタンスに対して専用プロキシ機能が有効になっています。
  • インスタンスの専用プロキシが実行するマイナーエンジンバージョンは1.12.8以降です。
  • RDSインスタンスは、次のMySQLバージョンとRDSエディションのいずれかを実行します。
    • ローカルSSDを使用したRDS High-availability EditionのMySQL 8.0。 マイナーエンジンのバージョンは20200831以降です。
    • ローカルSSDを使用したRDS High-availability EditionのMySQL 5.7。 マイナーエンジンのバージョンは20200831以降です。
    • ローカルSSDを使用したRDS High-availability EditionのMySQL 5.6。 マイナーエンジンのバージョンは20200831以降です。
説明 この操作を呼び出すと、インスタンスが再起動します。 操作は慎重に行ってください。

デバッグ

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

リクエストパラメーター

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

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

RegionId String 任意 cn-hangzhou

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

DbInstanceId String 必須 rm-t4n3axxxxx

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

DbProxyEndpointId String 必須 ta9um4xxxxx

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

DbProxyConnectString String 必須 test123456.rwlb.rds.aliyuncs.com

インスタンスの専用プロキシエンドポイント。

DbProxySslEnabled String 必須 1

インスタンスに適用するSSL設定。 有効な値：

  • 0: SSL暗号化を無効にします。
  • 1: SSL暗号化を有効にするか、SSL暗号化が必要なエンドポイントを変更します。
  • 2: SSL証明書の有効期間を更新します。
説明 この設定により、インスタンスが再起動します。 操作は慎重に行ってください。
DBProxyEngineType String 任意 normal

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

レスポンスパラメーター

項目 データ型 例: 説明　
RequestId String BF46A62B-3717-4397-9338-36BB95C898B3

リクエストの ID です。

例

リクエストの例

http(s):// rds.aliyuncs.com/?Action=ModifyDbProxyInstanceSsl
&DbInstanceId=rm-t4n3axxxxx
&DbProxyEndpointId=ta9um4xxxxx
&DbProxyConnectStrin g=test123456.rwlb.rds.aliyuncs.com
&DbProxySslEnabled=1
&<共通リクエストパラメーター>

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

XML 形式

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

<ModifyDbProxyInstanceSslResponse>
<RequestId>BF46A62B-3717-4397-9338-36BB95C898B3</RequestId>
</ModifyDbProxyInstanceSslResponse>

JSON 形式

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

{
  "RequestId" : "BF46A62B-3717-4397-9338-36BB95C898B3"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明　
400 MinorVersionNotSupport 現在のデータベースマイナーバージョンは、この操作をサポートしていません。 操作が現在のマイナーエンジンバージョンでサポートされていない場合に返されるエラーメッセージ。
400 InvalidDbProxyStatus データベースのプロキシステータスが異常です。 インスタンスのデータベースプロキシのステータスが異常な場合に返されるエラーメッセージ。
400 InvalidDBInstanceName 指定されたパラメーターDBInstanceNameは無効です。 DBInstanceNameパラメーターの値が無効な場合に返されるエラーメッセージ。 値がnullまたは空の文字列であるかどうかを確認します。
403 RDSCAategoryNotSupport 指定されたインスタンスカテゴリはこの操作をサポートしていません。 現在のインスタンスタイプで、該当の操作がサポートされていない場合に返されるエラーメッセージ。
404 Endpoint.NotFound 指定されたエンドポイントが見つかりません。 指定されたエンドポイントが見つからない場合に返されるエラーメッセージ。
404 EnabledSSLNotSupport バックエンドサービスはSSLをサポートしていません。 SSLがバックエンドサービスでサポートされていない場合に返されるエラーメッセージ。
404 InvalidDbProxyConnectionString.NotFound 指定されたデータベースプロキシ接続文字列が見つかりません。 指定されたデータベースプロキシエンドポイントが見つからない場合に返されるエラーメッセージ。

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