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