この API は、MongoDB インスタンスの SSL 構成を変更する場合に呼び出すことができます。

この API を呼び出すときに、インスタンスが次の条件を満たしていることが必要です。

  • インスタンスが実行中の状態にある必要があります。
  • インスタンスタイプはレプリカセット。
  • インスタンスのデータベースバージョンは 3.4 または 4.0 です。
注 SSL 暗号化を有効または無効にするか、SSL 証明書を更新するたびに、インスタンスが再起動されます。 そのため、ピーク時間外にこの API を実行することを推奨します。

デバッグ

OpenAPI Explorer は API の使用を簡素化します。 OpenAPI Explorer を使用して、API の取得、API の呼び出し、SDK サンプルコードの動的生成などのデバッグ操作を実行できます。

リクエストパラメータ

パラメータ データ型 必須 例 説明
Action String はい ModifyDBInstanceSSL

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

DBInstanceId String はい dds-bpxxxxxxxx

インスタンス ID。

SSLAction String はい Open

SSL 機能を実行するために実行する操作。 有効値：

  • Open ：SSL 暗号化を有効にします。
  • Close ：SSL 暗号化を無効にします。
  • Update：SSL 証明書を更新します。
AccessKeyId String いいえ LTAIgbTGpxxxxxx

Alibaba Cloud から提供された AccessKey ID。

レスポンスパラメータ

パラメータ タイプ 例 説明
RequestId String 6D806B11-078F-4154-BF9F-844F56D08964

リクエスト ID。

例

リクエストの例


http(s)://mongodb.aliyuncs.com/? Action=ModifyDBInstanceSSL
&DBInstanceId=dds-bpxxxxxxxx
&SSLAction=Open
&<Common request parameters>

通常のレスポンスの例

XML 形式 

<ModifyDBInstanceSSLResponse>
  <RequestId>6D806B11-078F-4154-BF9F-844F56D08964</RequestId>
</ModifyDBInstanceSSLResponse>

JSON 形式 

{
	"RequestId":"6D806B11-078F-4154-BF9F-844F56D08964"
}

エラーコード

HTTP ステータスコード エラーコード エラーメッセージ 説明
403 IncorrectDBInstanceState Current DB instance state does not support this operation. 現行状態のインスタンスでは該当の操作が実行できない場合に表示されるエラーメッセージ。 指定したパラメーターが正しいかどうかをご確認ください。
403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation. インスタンスが解放されている場合に表示されるエラーメッセージ。

エラーコードの表示