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