すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:ModifyDBInstanceSSL

    ドキュメントセンター

    ApsaraDB for MongoDB:ModifyDBInstanceSSL

    最終更新日:Jan 21, 2026

    MongoDB インスタンスの SSL 構成を変更します。

    操作説明

    ModifyDBInstanceSSL 操作を呼び出す前に、インスタンスが次の要件を満たしていることを確認してください。

    • インスタンスが実行中の状態であること。

    • インスタンスがレプリカセットインスタンスまたはシャードクラスターインスタンスであること。

      • レプリカセットインスタンスのバージョンが 3.4 以降であること。

      • シャードクラスターインスタンスが拡張ソリッドステートドライブ (ESSD) を使用していること。

    説明

    SSL の有効化、更新、または無効化を行うと、インスタンスが再起動します。これらの操作は、オフピーク時間に実行することを推奨します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    dds:ModifyDBInstanceSSL

    update

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    dds-bp2235****
    SSLAction

    string

    必須

    SSL 機能に対して実行する操作。有効な値：

    • Open：SSL 暗号化を有効にします。

    • Close：SSL 暗号化を無効にします。

    • Update：SSL 証明書を更新します。

    Open
    SwitchMode

    string

    任意

    MongoDB インスタンスの SSL 構成を変更する時間。有効な値：

    • 0：すぐに変更します。

    • 1：メンテナンスウィンドウ内に変更します。

    0
    ForceEncryption

    string

    任意

    接続に対して SSL 暗号化を強制的に有効にするかどうかを指定します。有効な値：

    • 1：SSL 暗号化を強制的に有効にします。

    • 0：SSL 暗号化を強制的に有効にしません。

    説明

    • 強制 SSL 暗号化は、クラウドディスクを使用し、かつ以下のマイナーエンジンバージョンの要件を満たす MongoDB 7.0 および 8.0 インスタンスでのみサポートされます。

      • バージョン 7.0 の場合、マイナーエンジンバージョンは 8.0.13 以降である必要があります。

      • バージョン 8.0 の場合、マイナーエンジンバージョンは 9.0.5 以降である必要があります。

    警告 強制 SSL 暗号化を有効にすると、インスタンスへの SSL 接続のみが許可されます。

    列挙値:

    • 0 :

      0

    • 1 :

      1

    0

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスパラメーター。

    RequestId

    string

    リクエスト ID。

    6D806B11-078F-4154-BF9F-844F56D08964

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParam Specified parameters is not valid.
    400 SSLAlreadyEnabled SSL have already been enabled.
    400 SSLAlreadyDisabled SSL have already been disabled.
    403 SSLNotEnabled SSL not enabled.
    403 IncorrectCharacterType Current DB instance CharacterType does not support this operation.
    403 IncorrectEngineVersion Current engine version does not support operations.
    403 IncorrectDBInstanceState Current DB instance state does not support this operation.
    403 IncorrectDBInstanceLockMode Current DB instance lock mode does not support this operation.
    404 EnabledSSLNotSupport Specified region does not support enable ssl.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。