ModifyDBInstanceSSL操作を呼び出して、ApsaraDB RDSインスタンスのSSL暗号化設定を変更できます。

この操作は、インスタンスのSSL暗号化を設定するために使用されます。 詳細については、「Secure Sockets Layer」をご参照ください。

説明
  • この操作を呼び出す前に、インスタンスが次のいずれかのインスタンスであることを確認してください。
    • RDS Basic Editionを実行しないApsaraDB RDS for MySQLインスタンス
    • ApsaraDB RDS for SQL Serverインスタンス
    • 標準SSDまたは拡張SSD (ESSD) を使用するApsaraDB RDS for PostgreSQLインスタンス
  • インスタンスの読み書き分離エンドポイントへの接続では、SSL暗号化はサポートされていません。

デバッグ

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

リクエストパラメーター

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

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

DBInstanceIdString必須rm-uf6wjk5xxxxxxx

インスタンスの ID です。

ConnectionStringString必須rm-uf6wjk5xxxxx.mysql.rds.aliyuncs.com

サーバー証明書を作成または更新する必要がある内部エンドポイントまたはパブリックエンドポイント。

SSLEnabledIntegerいいえ1

SSL暗号化を有効にするか無効にするかを指定します。 有効な値:

  • 1: SSL暗号化を有効にする
  • 0: SSL暗号化を無効にする
CATypeString任意aliyun

サーバー証明書のタイプ。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 SSLEnabledパラメーターを1に設定した場合、このパラメーターのデフォルト値はaliyunです。

有効な値:

  • aliyun: クラウド証明書
  • custom: カスタム証明書
ServerCertString任意----- CERTIFICATE-----MIIDを開始 ***** 証明書EP-----END Qq ----

サーバー証明書の内容。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 CATypeパラメーターをcustomに設定した場合、このパラメーターも指定する必要があります。

ServerKeyString任意----- プライベートKEY-----MIIEを開始 **** ihfg==----- プライベートキーを終了 -----

サーバー証明書の秘密鍵。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 CATypeパラメーターをcustomに設定した場合、このパラメーターも指定する必要があります。

ClientCAEnabledIntegerいいえ1

クライアント証明書を発行するCAの公開鍵を有効にするかどうかを指定します。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 有効な値:

  • 1: 公開キーを有効にします。
  • 0: 公開キーを無効にします。
ClientCACertString任意----- CERTIFICATE-----MIIDを開始 ***** viXk=----- 証明書を終了 -----

クライアント証明書を発行するCAの公開鍵。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 ClientCAEbabledパラメーターを1に設定する場合は、このパラメーターも指定する必要があります。

ClientCrlEnabledIntegerいいえ1

失効したクライアント証明書を含む証明書失効リスト (CRL) を有効にするかどうかを指定します。 このパラメーターは、インスタンスが標準SSDまたは拡張SSDでPostgreSQLを実行している場合にのみサポートされます。 また、このパラメーターは、クライアント証明書を発行するCAの公開鍵が有効な場合にのみ使用できます。 有効な値:

  • 1: CRLを有効にします
  • 0: CRLを無効にします
ClientCertRevocationListString任意----- 開始X509 CRL-----MIIB **** 19mg==----- END X509 CRL ----

取り消されたクライアント証明書を含むCRL。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 ClientCrlEnabledパラメーターを1に設定する場合は、このパラメーターも指定する必要があります。

ACLString任意cert

クライアントのIDを検証するために使用されるメソッド。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 また、このパラメーターは、クライアント証明書を発行するCAの公開鍵が有効な場合にのみ使用できます。 有効な値:

  • cert
  • パーファー
  • verify-ca
  • verify-full (インスタンスがPostgreSQL 12以降を実行している場合のみサポート)
複製ACLString任意cert

レプリケーション権限の検証に使用されるメソッド。 このパラメーターは、インスタンスが標準SSDまたはESSDでPostgreSQLを実行している場合にのみサポートされます。 また、このパラメーターは、クライアント証明書を発行するCAの公開鍵が有効な場合にのみ使用できます。 有効な値:

  • cert
  • パーファー
  • verify-ca
  • verify-full (インスタンスがPostgreSQL 12以降を実行している場合のみサポート)

レスポンスパラメーター

項目データ型例:説明 
RequestIdString777C4593-8053-427B-99E2-105593277CAB

リクエストの ID です。

リクエストの例

http(s):// rds.aliyuncs.com/?Action=ModifyDBInstanceSSL
&ConnectionStrin g=rm-uf6wjk5xxxxx.mysql.rds.aliyuncs.com
&DBInstanceId=rm-uf6wjk5xxxxxxx
&<共通リクエストパラメーター>

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

XML 形式

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

<RequestId>777C4593-8053-427B-99E2-105593277CAB</RequestId>

JSON 形式

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

{
  "RequestId" : "777C4593-8053-427B-99E2-105593277CAB"
}

エラーコード

HTTP ステータスコードエラーコードエラーメッセージ説明 
400InvalidServerCertOrPrivateKeyサーバー証明書または秘密鍵の指定が無効です。指定されたサーバー証明書または秘密鍵が無効な場合に返されるエラーメッセージ。
400InvalidClientCACertクライアントca証明書の指定が無効です。ClientCACertパラメーターの値が無効な場合に返されるエラーメッセージ。
400InvalidClientCrlクライアント証明書失効リストの指定が無効です。指定されたCRLが無効な場合に返されるエラーメッセージ。
400InvalidCAType.NotFound指定caタイプが見つかりません。指定されたサーバー証明書の種類が無効な場合に返されるエラーメッセージ。
400InvalidACL.NotFoundaclが見つかりません。ACLパラメーターの値が無効な場合に返されるエラーメッセージ。
400InvalidSSLStatussslステータスの指定が無効です。SSLEnabledパラメーターの値が無効な場合に返されるエラーメッセージ。
403InvalidClientCrl. 権限クライアント証明書失効リストを設定する必要がある場合、クライアントca証明書が最初に設定されます。該当の操作を実行する権限がない場合に返されるエラーメッセージです。 この操作を実行する前に、クライアントCA証明書を設定する必要があります。
403InvalidACL.Permissionaclを設定する必要がある場合、クライアントca証明書が最初に設定されます。クライアントCA証明書が指定されていない場合に返されるエラーメッセージ。

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