Token鑒權方式下,云消息隊列 MQTT 版服務端會頒發(fā)Token(臨時憑證)給客戶端,客戶端訪問云消息隊列 MQTT 版服務端時需要攜帶Token用于權限驗證。 本接口用于向云消息隊列 MQTT 版申請臨時Token。
接口說明
- 單用戶請求頻率限制為 100 次/秒。如有特殊需求,請聯(lián)系云消息隊列 MQTT 版技術支持,釘釘群號:35228338。
- 每成功調(diào)用一次 ApplyToken 接口,都會計算為一次消息 TPS,從而影響您的計費。計費詳情,請參見計費說明。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Resources | string | 是 | 資源名稱,即云消息隊列 MQTT 版的 Topic,多個 Topic 以逗號(,)分隔,每個 Token 最多運行操作 100 個資源。當有多個 Topic 時,需要按照字典順序排序。 申請 Token 時注冊的資源參數(shù)支持 MQTT 通配符語法,包含加號單級通配符(+)和井號多級通配符(#)。 例如,如果申請 Token 時指定 Resources 為“Topic1/+”,則客戶端可以操作“Topic1/xxx”的任意 Topic;如果申請 Token 時指定 Resources 為“Topic1/#”,則客戶端可以操作“Topic1/xxx/xxx/xxx”的任意多級 Topic。 說明
云消息隊列 MQTT 版支持匹配子級 Topic,子級 Topic 無需在控制臺創(chuàng)建,直接在消息收發(fā)代碼中設置即可。Topic 名稱中的正斜線(/)用于分隔父級 Topic 和各子級 Topic。更多信息,請參見基本概念。
| TopicA/+ |
InstanceId | string | 是 | 云消息隊列 MQTT 版實例的 ID,一定要和客戶端實際使用的實例 ID 匹配。該實例 ID 在控制臺實例詳情頁面獲取。 | post-cn-0pp12gl**** |
ExpireTime | long | 是 | Token 失效的毫秒時間戳。允許設置的失效最小間隔是 60 秒,最長為 30 天。如果輸入的取值超過 30 天,申請接口不會報錯,但實際生效時間為 30 天。 示例:如果 Token 的失效間隔需設置為 60 秒,當前的系統(tǒng)時間毫秒時間戳為 1609434061000,那么該參數(shù)的取值需設置為 1609434121000,即 1609434061000+60x1000 之和。 | 1609434121000 |
Actions | string | 是 | Token 的權限類型,取值說明如下:
| R |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"Token": "LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng==",
"RequestId": "31782AAF-D0CC-44C3-ABFD-1B500276****"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ApplyTokenOverFlow | You have applied for tokens too many times. Please try again later. | 申請Token頻率過高,系統(tǒng)限流,請重試。 |
400 | CheckAccountInfoFailed | An error occurred while checking the account information by the STS token. | 解析STS Token賬號信息失敗。 |
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 | ParameterCheckFailed | An error occurred while validating the parameters. The parameters may be missing or invalid. | 參數(shù)校驗失敗,可能缺失或者傳入值非法。 |
400 | PermissionCheckFailed | An error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings. | 資源權限校驗失敗,請檢查實例、Topic和Group ID的所屬權限和授權策略。 |
400 | InvalidParameter.%s | An error occurred while validating the parameter. The parameter may be missing or invalid. | 參數(shù)校驗失敗,可能缺失或者傳入值非法。 |
404 | ApiNotSupport | The specified API is not supported. | 當前接口不支持,請檢查。 |
500 | InternalError | An error occurred while processing your request. Try again later. | MQTT后端服務異常,請重試。 |
500 | SystemOverFlow | An error occurred while processing your request. Please try again. | 系統(tǒng)限流,請重試。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|