调用QueryToken校验Token的有效性_云消息队列 MQTT 版-阿里云帮助中心

使用场景

校验Token的接口应该由应用服务器发起，应用服务器可以使用QueryToken接口确认单个Token是否有效。详细信息，请参见Token鉴权概述。

使用限制

单用户请求频率限制为100次/秒。如有特殊需求，请联系云消息队列 MQTT 版技术支持，钉钉群号：35228338。

说明每成功调用一次QueryToken接口，都会计算为一次消息TPS，从而影响您的计费。计费详情，请参见计费说明。

调试

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

请求参数


名称	类型	是否必选	示例值	描述
Action	String	是	QueryToken	系统规定参数。取值：QueryToken。
Token	String	是	LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng==	您需查询的Token。
InstanceId	String	是	post-cn-0pp12gl****	云消息队列 MQTT 版实例的ID，一定要和客户端实际使用的实例ID匹配。该实例ID在控制台实例详情页面获取。

说明更多参数说明请参见公共参数和服务接入点。

返回数据


名称	类型	示例值	描述
TokenStatus	Boolean	true	您所校验的Token的状态。取值说明如下： true：该Token有效。 false：该Token无效。
RequestId	String	5C8AADD0-6A95-436D-AFA0-3405CCE3****	公共参数，每个请求的ID都是唯一的。

示例

请求示例

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

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<QueryTokenResponse>
<RequestId>5C8AADD0-6A95-436D-AFA0-3405CCE3****</RequestId>
<TokenStatus>true</TokenStatus>
</QueryTokenResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "5C8AADD0-6A95-436D-AFA0-3405CCE3****",
  "TokenStatus" : true
}

错误码


HttpCode	错误码	错误信息	描述
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.	参数校验失败，可能缺失或者传入值非法。
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	QueryTokenOverFlow	You have queried tokens too many times. Please try again later.	查询 token 频率过高，系统限流，请稍后重试。
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
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.	系统限流，请重试。
404	ApiNotSupport	The specified API is not supported.	当前接口不支持，请检查。

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