QueryToken - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Queries the status of a token. If token-based authentication is used for permission authentication on an ApsaraMQ for MQTT broker, a token that is issued by the broker is required for authentication each time a client is connected to the broker. A token is a temporary credential and is valid only within a specific period of time. You can call this operation to query whether a token expires.

Operation description

You can call this operation up to 100 times per second per account. If you want to increase the limit, join the DingTalk group 35228338 to contact ApsaraMQ for MQTT technical support.
Each successful call to the QueryToken operation increases the messaging transactions per second (TPS) by one. This affects the billing of your instance. For more information, see Billing rules.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Token	string	Yes	The token that you want to query.	LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng==
InstanceId	string	Yes	The ID of the ApsaraMQ for MQTT instance. The ID must be consistent with the ID of the instance that the ApsaraMQ for MQTT client uses. You can obtain the instance ID on the Instance Details page that corresponds to the instance in the ApsaraMQ for MQTT console.	post-cn-0pp12gl****

Note For information about other parameters, see Common parameters and Endpoints .

Response parameters

Parameter	Type	Description	Example
	object
TokenStatus	boolean	The status of the queried token. Valid values: true: indicates the token is valid. false: indicates the token is invalid.	true
RequestId	string	The unique ID that the system generates for the request. This parameter is a common parameter.	5C8AADD0-6A95-436D-AFA0-3405CCE3****

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	CheckAccountInfoFailed	An error occurred while checking the account information by the 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.
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.
400	QueryTokenOverFlow	You have queried tokens too many times. Please try again later.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.
404	ApiNotSupport	The specified API is not supported.
500	InternalError	An error occurred while processing your request. Try again later.
500	SystemOverFlow	An error occurred while processing your request. Please try again.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history