使用DescribeDBInstanceSSL查詢MongoDB執行個體的SSL設定-ApsaraDB for MongoDB-阿里雲

介面說明

調用該介面時，執行個體必須滿足以下條件：

執行個體狀態為運行中。
執行個體類型為複本集或分區叢集執行個體。
- 複本集執行個體的版本需為 3.4 及以上版本。
- 分區叢集執行個體的儲存模式需要為 ESSD 雲端硬碟版。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

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

樣本

正常返回樣本

JSON格式

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。