設(shè)備證書是由CA根證書簽發(fā)給客戶端設(shè)備使用的數(shù)字證書，用于客戶端和服務(wù)端連接時(shí)，服務(wù)端對(duì)客戶端進(jìn)行安全認(rèn)證。認(rèn)證通過后服務(wù)端和客戶端可基于證書內(nèi)的加密密鑰進(jìn)行安全通信，若認(rèn)證不通過則服務(wù)端拒絕客戶端接入。 您可以調(diào)用本接口獲取設(shè)備證書的詳細(xì)信息。
接口說明
- 僅鉑金版實(shí)例支持使用 GetDeviceCertificate 接口。
- 單用戶請求頻率限制為 500 次/秒。如有特殊需求，請聯(lián)系云消息隊(duì)列 MQTT 版技術(shù)支持，釘釘群號(hào)：35228338。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MqttInstanceId | string | 是 | 設(shè)備證書所綁定的實(shí)例 ID，即云消息隊(duì)列 MQTT 版的實(shí)例 ID。 | post-cn-7mz2d****** |
| DeviceSn | string | 是 | 待查詢設(shè)備證書的 SN 序列號(hào)，用于唯一標(biāo)識(shí)一個(gè)設(shè)備證書。 取值范圍：不超過 128 Byte。 | 356217374433****** |
| CaSn | string | 是 | 待查詢設(shè)備證書所屬的 CA 證書的 SN 序列號(hào)，用于唯一標(biāo)識(shí)一個(gè) CA 證書。 取值范圍：不超過 128 Byte。 | 007269004887****** |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Data": {
"ValidBegin": "1654137303000",
"ValidEnd": "1969497303000",
"DeviceSn": "356217374433******",
"DeviceName": "mqtt_device",
"DeviceContent": "-----BEGIN DEVICECERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END DEVICECERTIFICATE-----",
"CaSn": "00f26900ba87******",
"Status": "1"
}
}錯(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)失敗 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|
暫無變更歷史
控制臺(tái)操作
除了調(diào)用 GetDeviceCertificate 接口，您還可以通過微消息隊(duì)列 MQTT 版控制臺(tái)查看指定設(shè)備證書的詳細(xì)信息。具體操作，請參見 CA 證書管理。