すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeDBInstanceSSL

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeDBInstanceSSL

    最終更新日:Dec 16, 2025

    MongoDB インスタンスの SSL 構成の詳細を照会します。

    操作説明

    インスタンスは、次の要件を満たす必要があります：

    • インスタンスのステータスが「実行中」であること。

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

      • レプリカセットインスタンスは、バージョン 3.4 以降である必要があります。

      • シャードクラスターインスタンスは、ESSD (Enhanced SSD) を使用する必要があります。

    今すぐお試しください

    この 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:DescribeDBInstanceSSL

    get

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    DBInstanceId

    string

    必須

    インスタンス ID。

    dds-bpxxxxxxxx

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    SSLExpiredTime

    string

    SSL 証明書の有効期限。時刻は yyyy-MM-ddTHH:mm:ssZ 形式の UTC 時刻です。

    2020-03-11T02:28:25Z
    SSLStatus

    string

    SSL 機能のステータス。

    • Open：SSL 機能が有効になっています。

    • Closed：SSL 機能が無効になっています。

    Open
    RequestId

    string

    リクエスト ID。

    36BB1BC2-789C-4BBA-A519-C5B388E4B0D4
    CertCommonName

    string

    SSL 証明書の名前。

    dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com
    ForceEncryption

    string

    接続を SSL を使用して暗号化する必要があるかどうかを指定します。有効な値：

    • 1：接続は SSL を使用して暗号化する必要があります。

    • 0：接続は SSL を使用して暗号化する必要はありません。

    列挙値:

    • 0 :

      0

    • 1 :

      1

    0

    例

    成功レスポンス

    JSONJSON

    {
  "SSLExpiredTime": "2020-03-11T02:28:25Z",
  "SSLStatus": "Open",
  "RequestId": "36BB1BC2-789C-4BBA-A519-C5B388E4B0D4",
  "CertCommonName": "dds-bpxxxxxxxx.mongodb.rds.aliyuncs.com",
  "ForceEncryption": "0"
}

    エラーコード

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

    変更履歴

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