调用 RevokeToken 接口吊销 Token。

使用场景

吊销 Token 的接口应该由应用服务器发起,在需要提前中止之前的 Token 授权时调用。应用服务器的详细说明请参见 Token 鉴权概述

使用限制

单用户请求频率限制为 5 次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String RevokeToken

系统规定参数。取值:RevokeToken。

InstanceId String post-cn-0pp12gl****

微消息队列 MQTT 版实例的 ID,一定要和客户端实际使用的实例 ID 匹配。在控制台实例详情页面获取。

RegionId String mq-internet-access

微消息队列 MQTT 版实例所在地域(Region)。

Token String LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng==

您需吊销的 Token。

说明 更多参数说明请参见公共参数调用方式

返回数据

名称 类型 示例值 描述
RequestId String 833EDFCB-C447-4CE3-B21F-3A4C2D1B487D

公共参数,每个请求的 ID 都是唯一的。

示例

请求示例

http(s)://onsmqtt.cn-hangzhou.aliyuncs.com/?Action=RevokeToken
&InstanceId=post-cn-0pp12gl****
&RegionId=mq-internet-access
&Token=LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng==
&<公共请求参数>

正常返回示例

XML 格式

<RevokeTokenResponse>
  <RequestId>833EDFCB-C447-4CE3-B21F-3A4C2D1B487D</RequestId>
</RevokeTokenResponse>

JSON 格式

{
  "RequestId": "833EDFCB-C447-4CE3-B21F-3A4C2D1B487D"
}

错误码

HttpCode 错误码 错误信息 描述
404 ApiNotSupport The specified API is not supported. 当前接口不支持,请检查。
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 实例的所属关系以及授权策略。
500 InternalError An error occurred while processing your request. Try again later. MQTT 后端服务异常,请重试。
400 ParameterCheckFailed An error occurred while validating the parameters. The parameters may be missing or invalid. 参数校验失败,可能缺失或者传入值非法。
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 RevokeTokenOverFlow You have revoked tokens too many times. Please try again later. 禁用 Token 频率过高,系统限流,请稍后重试。
500 SystemOverFlow An error occurred while processing your request. Please try again. 系统限流,请重试。
400 InvalidParameter.%s An error occurred while validating the parameter. The parameter may be missing or invalid. 参数校验失败,可能缺失或者传入值非法。

访问错误中心查看更多错误码。