云消息隊列 MQTT 版支持X.509證書認(rèn)證,客戶端可通過設(shè)備證書完成接入認(rèn)證。CA證書用于為客戶端簽發(fā)設(shè)備證書,并驗證設(shè)備證書的正確性,需要在激活狀態(tài)下使用。 CA證書注冊后默認(rèn)為激活狀態(tài),若您需要使用的CA證書被修改為未激活狀態(tài),您可以調(diào)用本接口將CA證書重新激活。
接口說明
- 僅鉑金版和專業(yè)版實例支持使用 ActiveCaCertificate 接口。
- 單用戶請求頻率限制為 500 次/秒。如有特殊需求,請聯(lián)系云消息隊列 MQTT 版技術(shù)支持,釘釘群號:35228338。
- ActiveCaCertificate 接口僅支持對已在云消息隊列 MQTT 版服務(wù)端注冊的 CA 證書進(jìn)行操作,您可以通過 ListCaCertificate 接口查詢指定實例下已注冊的 CA 證書。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MqttInstanceId | string | 是 | CA 證書所綁定的實例 ID,即云消息隊列 MQTT 版的實例 ID。 | post-cn-7mz2d****** |
Sn | string | 是 | 待激活 CA 證書的 SN 序列號,用于唯一標(biāo)識一個 CA 證書。 取值范圍:不超過 128 Byte。 | 007269004887****** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Sn": "007269004887******"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 參數(shù)校驗失敗,可能缺失或者傳入值非法。 |
500 | FindCaBySnError | Failed to find the CA by the SN. Please check sn is valid. | SN不存在 |
500 | MqttOwnerCheckError | Failed to validate the instance permission | 實例權(quán)限校驗失敗 |
500 | MqttInstanceNotFound | Specified instance is not found | 實例不存在 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|
暫無變更歷史
控制臺操作
除了調(diào)用 ActiveCaCertificate 接口,您還可以通過微消息隊列 MQTT 版控制臺激活 CA 證書。具體操作,請參見 CA 證書管理。