云消息隊(duì)列 MQTT 版支持X.509證書認(rèn)證，客戶端可通過設(shè)備證書完成接入認(rèn)證。CA證書用于為客戶端簽發(fā)設(shè)備證書，并驗(yàn)證設(shè)備證書的正確性。 本接口用于查詢指定實(shí)例下所有注冊(cè)的CA證書。
接口說明
- 僅鉑金版和專業(yè)版實(shí)例支持使用 ListCaCertificate 接口。
- 單用戶請(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)信息
當(dāng)前API暫無(wú)授權(quán)信息透出。
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| MqttInstanceId | string | 是 | 云消息隊(duì)列 MQTT 版的實(shí)例 ID，表示需要查看哪個(gè)實(shí)例下的所有 CA 證書。 | post-cn-7mz2d****** |
| PageNo | string | 是 | 查詢第幾頁(yè)的返回結(jié)果。起始頁(yè)從第 1 頁(yè)開始計(jì)算。 | 2 |
| PageSize | string | 是 | 每頁(yè)最多顯示幾條查詢記錄。 取值范圍：1~100。 | 10 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Data": {
"Total": 1,
"PageNo": 2,
"PageSize": 10,
"CaCertificateVOS": [
{
"RegistrationCode": "13274673-8f90-4630-bea1-9cccb25756ad2089******",
"CaName": "mqtt_ca",
"Sn": "007269004887******",
"CaContent": "-----BEGIN CERTIFICATE-----\\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\\n-----END CERTIFICATE-----",
"VerificationContent": "-----BEGIN CERTIFICATE-----\\nMIID/DCCAu+Y5sRMpp9tnd+4s******\\n-----END CERTIFICATE-----",
"ValidBegin": "1654137303000",
"ValidEnd": "1969497303000",
"Status": "1"
}
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 500 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 參數(shù)校驗(yàn)失敗，可能缺失或者傳入值非法。 |
| 500 | MqttOwnerCheckError | Failed to validate the instance permission | 實(shí)例權(quán)限校驗(yàn)失敗 |
| 500 | MqttInstanceNotFound | Specified instance is not found | 實(shí)例不存在 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2022-08-24 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
控制臺(tái)操作
除了調(diào)用 ListCaCertificate 接口，您還可以通過微消息隊(duì)列 MQTT 版控制臺(tái)查看指定實(shí)例下所有已注冊(cè)的 CA 證書。具體操作，請(qǐng)參見 CA 證書管理。