云消息隊列 MQTT 版支持X.509證書認證,客戶端可通過設備證書完成接入認證。CA證書用于為客戶端簽發設備證書,并驗證設備證書的正確性。 您可以調用本接口查詢指定CA證書的證書內容以及激活狀態等詳細信息。
接口說明
- 僅鉑金版和專業版實例支持使用 GetCaCertificate 接口。
- 單用戶請求頻率限制為 500 次/秒。如有特殊需求,請聯系云消息隊列 MQTT 版技術支持,釘釘群號:35228338。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MqttInstanceId | string | 是 | CA 證書所綁定的實例 ID,即云消息隊列 MQTT 版的實例 ID。 | post-cn-7mz2d****** |
Sn | string | 是 | 待查詢 CA 證書的 SN 序列號,用于唯一標識一個 CA 證書。 | 007269004887****** |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Data": {
"RegistrationCode": "13274673-8f90-4630-bea1-9cccb25756ad2089******",
"CaName": "mqtt_ca",
"Sn": "00f26900ba87******",
"CaContent": "-----BEGIN CERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END CERTIFICATE-----",
"VerificationContent": "-----BEGIN CERTIFICATE-----\\nMIID/DCCAu+Y5sRMpp9tnd+4s******\\n-----END CERTIFICATE-----",
"ValidBegin": "1654137303000",
"ValidEnd": "1969497303000",
"Status": "1"
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 參數校驗失敗,可能缺失或者傳入值非法。 |
500 | FindCaBySnError | Failed to find the CA by the SN. Please check sn is valid. | SN不存在 |
500 | MqttOwnerCheckError | Failed to validate the instance permission | 實例權限校驗失敗 |
500 | MqttInstanceNotFound | Specified instance is not found | 實例不存在 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-08-24 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
控制臺操作
除了調用 GetCaCertificate 接口,您還可以通過微消息隊列 MQTT 版控制臺查看指定的 CA 證書。具體操作,請參見 CA 證書管理。