添加賬號身份認證信息,可以具體到客戶端。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 云消息隊列 MQTT 版實例的 ID。 | mqtt-cn-xxxx |
Username | string | 是 | 用戶名,不超過 64 位 | test |
Secret | string | 是 | 密鑰。 | xxxxx |
IdentityType | string | 是 | 身份類型。
| USER |
ClientId | string | 否 | 當身份類型是 CLIENT 時,指定設備的 ClientID。 | GID_test@@@test |
SignMode | string | 否 | 簽名校驗方式,ORIGIN:原始值比較,即比較 password 與 secret,SIGNED: 對 clientId 進行 HmacSHA1 加簽(使用 secret,參考簽名模式)驗證,然后比較 password。 | SIGNED |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "020F6A43-19E6-4B6E-B846-44EB31DF****",
"Code": 200,
"Success": true,
"Message": "operation success."
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
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 | InvalidParameter.%s | An error occurred while validating the parameter. The parameter may be missing or invalid. | 參數校驗失敗,可能缺失或者傳入值非法。 |
400 | Customauth.over.capacity | Over custom auth capacity. | 自定義權限數量容量超限 |
404 | ApiNotSupport | The specified API is not supported. | 當前接口不支持,請檢查。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史