雲Message QueueTT 版支援X.509認證認證,用戶端可通過裝置認證完成接入認證。CA認證用於為用戶端簽發裝置認證,並驗證裝置認證的正確性,您需要先將申請的CA憑證註冊到雲Message QueueTT 版的服務端上,才能用於認證裝置認證。本介面用於將指定CA憑證註冊到雲Message QueueTT 版服務端。
介面說明
僅鉑金版執行個體支援使用 RegisterCaCertificate 介面。
單使用者請求頻率限制為 500 次/秒。如有特殊需求,請聯絡雲Message QueueTT 版支援人員,DingTalk群號:35228338。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
mq:RegisterCa |
create |
*Instance
|
無 |
|
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| MqttInstanceId |
string |
是 |
雲Message QueueTT 版的執行個體 ID。註冊 CA 憑證時,需要指定一個執行個體進行綁定。 |
post-cn-7mz2d****** |
| CaName |
string |
是 |
待註冊 CA 憑證的名稱。 |
mqtt_ca |
| CaContent |
string |
是 |
待註冊 CA 憑證的內容。 說明
樣本中的\n 表示換行。 |
-----BEGIN CERTIFICATE-----\nMIIDuzCCAqdGVzdC5jbi1xaW5n******\n-----END CERTIFICATE----- |
| VerificationContent |
string |
是 |
待註冊 CA 憑證的驗證認證的內容。和 CA 憑證的註冊碼一起使用,用於驗證使用者擁有該 CA 憑證的私密金鑰。 說明
樣本中的\n 表示換行。 |
-----BEGIN CERTIFICATE-----\nMIID/DCCAu+Y5sRMpp9tnd+4s******\n-----END CERTIFICATE----- |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
公用參數,每個請求的 ID 都是唯一的,可用於排查和定位問題。 |
020F6A43-19E6-4B6E-B846-44EB31DF**** |
| Sn |
string |
登入的 CA 憑證的 SN 序號,用於唯一標識一個 CA 憑證。 |
007269004887****** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Sn": "007269004887******"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | 參數校正失敗,可能缺失或者傳入值非法。 |
| 400 | InstancePermissionCheckFailed | An error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings. | 執行個體許可權校正失敗,請確認MQTT執行個體的所屬關係以及授權策略。 |
| 400 | MqttOwnerCheckError | Failed to validate the instance permission | 執行個體許可權校正失敗 |
| 500 | RegisterCodeError | Register code error in verification certificate. | |
| 500 | RegisterCodeUsed | Register code has been used. | |
| 500 | ParameterFieldCheckFailed | Failed to validate the parameters. The parameters may be missing or invalid. | |
| 500 | GetCaNumError | Failed to get ca num. Try again later. | |
| 500 | CaNumExceed | CA certificate num exceed | |
| 500 | CertificateContentError | Certificate content error, please check ca/verification certificate content. BasicConstraints extension should be set to true in CA certificate | |
| 500 | SnNotUnique | Sn is not unique in gloabal | |
| 500 | MqttInstanceNotFound | Specified instance is not found | |
| 403 | PermissionCheckFailed | Failed to verify API permissions. | ram許可權檢查失敗 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。