この操作を呼び出して、SSL (Secure Sockets Layer) 暗号化を有効または無効にしたり、認証局 (Certificate Authorities: CA) が発行した Apsara PolarDB クラスターの SSL 証明書を更新したりすることができます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須項目 例 説明
Action String いいえ ModifyDBClusterSSL

実行する操作。 この値を ModifyDBClusterSSL に設定します。

DBClusterId String はい pc-bpxxxxxxxxxx

管理する Apsara PolarDB クラスターの ID。
SSLEnabled String はい Enable

SSL 暗号化ステータスを変更する方法を指定します。 設定可能な値は以下のとおりです。

  • Disable：SSL 暗号化を無効にします。
  • Enable：SSL 暗号化を有効にします。
  • Update：CA が発行した SSL 証明書を更新します。
注 SSL 暗号化を有効にするか、CA によって発行された SSL 証明書を更新した後、証明書をダウンロードして構成する必要があります。
DBEndpointId String いいえ testxxxxx.mysql.polardb.rds.aliyuncs.com

SSL 接続をサポートするエンドポイント。

注
  • PolarDB for MySQL データベースの場合、このパラメーターは必須です。
  • PolarDB for PostgreSQL データベースまたは Oracle と互換性のある PolarDB データベースの場合、このパラメーターは必要ありません。 既定では、SSL 暗号化はすべてのエンドポイントに対して有効になっています。
NetType String いいえ Public

DBEndpointId で指定されたエンドポイントでサポートされているネットワークタイプ。 設定可能な値は以下のとおりです。

  • Public：インターネット
  • Private：VPC (Virtual Private Cloud) ネットワーク
  • Inner：クラシックネットワーク
注
  • PolarDB for MySQL データベースの場合、このパラメーターは必須です。
  • PolarDB for PostgreSQL データベースまたは Oracle と互換性のある PolarDB データベースの場合、このパラメーターは必要ありません。 既定では、SSL 暗号化はすべてのエンドポイントに対して有効になっています。

レスポンスパラメーター

パラメーター データ型 例 説明
RequestId String A94B1755-6D8B-4E27-BF3C-8562BC8A6893

リクエストの ID

例

リクエストの例

http(s)://[Endpoint]/? Action=ModifyDBClusterSSL
&DBClusterId=pc-bpxxxxxxxxxx
&SSLEnabled=Enable
&<共通リクエストパラメーター>

通常のレスポンス例

XML 形式 

<RequestId>A94B1755-6D8B-4E27-BF3C-8562BC8A6893</RequestId>

JSON 形式 

{
    "RequestId": "A94B1755-6D8B-4E27-BF3C-8562BC8A6893"
}

エラーコード

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