雲Message QueueTT 版支援X.509認證認證,用戶端可通過裝置認證完成接入認證。CA認證用於為用戶端簽發裝置認證,並驗證裝置認證的正確性。 本介面用於查詢指定執行個體下所有註冊的CA認證。
介面說明
僅鉑金版執行個體支援使用 ListCaCertificate 介面。
單使用者請求頻率限制為 500 次/秒。如有特殊需求,請聯絡微Message QueueTT 版支援人員,DingTalk群號:35228338。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
mq:ListCaCertificate |
list |
*Instance
|
無 |
|
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| MqttInstanceId |
string |
是 |
雲Message QueueTT 版的執行個體 ID,表示需要查看哪個執行個體下的所有 CA 憑證。 |
post-cn-7mz2d****** |
| PageNo |
string |
是 |
查詢第幾頁的返回結果。起始頁從第 1 頁開始計算。 |
2 |
| PageSize |
string |
是 |
每頁最多顯示幾條查詢記錄。 取值範圍:1~100。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
公用參數,每個請求的 ID 都是唯一的,可用於排查和定位問題。 |
020F6A43-19E6-4B6E-B846-44EB31DF**** |
| Data |
object |
查詢結果。 |
|
| Total |
integer |
查詢結果最大頁數。 |
1 |
| PageNo |
integer |
當前返回的查詢記錄是第幾頁。 |
2 |
| PageSize |
integer |
每頁顯示的最大結果數。 |
10 |
| CaCertificateVOS |
array<object> |
CA 憑證的詳細資料。 |
|
|
object |
|||
| RegistrationCode |
string |
CA 憑證的註冊碼。 |
13274673-8f90-4630-bea1-9cccb25756ad2089****** |
| CaName |
string |
CA 憑證的名稱。 |
mqtt_ca |
| Sn |
string |
CA 憑證的 SN 序號。 |
007269004887****** |
| CaContent |
string |
CA 憑證內容。 說明
\n 表示換行。 |
-----BEGIN CERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END CERTIFICATE----- |
| VerificationContent |
string |
驗證認證內容。 說明
\n 表示換行。 |
-----BEGIN CERTIFICATE-----\nMIID/DCCAu+Y5sRMpp9tnd+4s******\n-----END CERTIFICATE----- |
| ValidBegin |
string |
CA 憑證生效的起始時間。格式為毫秒層級的 Unix 時間戳記。 |
1654137303000 |
| ValidEnd |
string |
CA 憑證生效的終止時間。格式為毫秒層級的 Unix 時間戳記。 |
1969497303000 |
| Status |
string |
CA 憑證的狀態。取值如下:
說明
CA 憑證註冊後,預設為啟用狀態。 |
1 |
樣本
正常返回樣本
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"
}
]
}
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | MqttOwnerCheckError | Failed to validate the instance permission | 執行個體許可權校正失敗 |
| 500 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | |
| 500 | MqttInstanceNotFound | Specified instance is not found | |
| 403 | PermissionCheckFailed | Failed to verify API permissions. | ram許可權檢查失敗 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。