設(shè)備證書是由CA根證書簽發(fā)給客戶端設(shè)備使用的數(shù)字證書，用于客戶端和服務(wù)端連接時，服務(wù)端對客戶端進(jìn)行安全認(rèn)證。認(rèn)證通過后服務(wù)端和客戶端可基于證書內(nèi)的加密密鑰進(jìn)行安全通信，若認(rèn)證不通過則服務(wù)端拒絕客戶端接入。 本接口用于查詢指定實例下所有注冊的設(shè)備證書。
接口說明
- 僅鉑金版和專業(yè)版實例支持使用 ListDeviceCertificate 接口。
- 單用戶請求頻率限制為 500 次/秒。如有特殊需求，請聯(lián)系云消息隊列 MQTT 版技術(shù)支持，釘釘群號：35228338。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無授權(quán)信息透出。
請求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MqttInstanceId | string | 是 | 云消息隊列 MQTT 版的實例 ID，表示需要查看哪個實例下的所有設(shè)備證書。 | post-cn-7mz2d****** |
| PageNo | string | 是 | 查詢第幾頁的返回結(jié)果。起始頁從第 1 頁開始計算。 | 2 |
| PageSize | string | 是 | 每頁最多顯示幾條查詢記錄。 取值范圍：1~100。 | 10 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Data": {
"Total": 1,
"PageNo": 2,
"PageSize": 10,
"DeviceCertificateVOS": [
{
"ValidBegin": "1654137303000",
"ValidEnd": "1969497303000",
"DeviceSn": "356217374433******",
"DeviceContent": "-----BEGIN DEVICECERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END DEVICECERTIFICATE-----",
"Status": "1",
"CaSn": "00f26900ba87******",
"DeviceName": "mqtt_device"
}
]
}
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 參數(shù)校驗失敗，可能缺失或者傳入值非法。 |
| 500 | FindDeviceBySnError | Failed to find the device certificate by the SN. Please check sn is valid | 獲取設(shè)備證書失敗 |
| 500 | MqttInstanceNotFound | Specified instance is not found | 實例不存在 |
| 500 | MqttOwnerCheckError | Failed to validate the instance permission | 實例權(quán)限校驗失敗 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內(nèi)容概要 | 操作 |
|---|
暫無變更歷史
控制臺操作
除了調(diào)用 ListDeviceCertificate 接口，您還可以通過微消息隊列 MQTT 版控制臺查看指定實例下所有注冊的設(shè)備證書。具體操作，請參見設(shè)備證書管理。