RevokeToken - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Revokes a Token.

Scenario

This method is called by the application server to terminate previous token authorization in advance. For more information about the application server, see Overview of token authentication.

Limits

Single-user requests the frequency is limited to 5 times /sec.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	RevokeToken	The operation that you want to perform. Value: RevokeToken
InstanceId	String	Yes	post-cn-0pp12gl****	The ID of the MQTT instance, which must match the client-used instance ID. In the console instance details page.
Region ID	String	Yes	mq-internet-access	The Region where the message queue for MQTT instance is located.
Token	String	Yes	LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYxn8aQbALNtml7QZKl9L9kPe6LqUb95tEVo+zUqOogs9+jZwDUSzsd4X4qaD3n2TrBEuMOqKkk1Xdrvu9VBQQvIYbz7MJWZDYC3DlW7gLEr33Cuj54iIhagtBi3epStJitsssWs7otY9zhKOSZxhr49G3d0bh35mwyP18EMvDas8UlzeSozsSrujNUqZXOGK0PEBSd+rWMGDJlCt6GFmJgm2JFY7PJwf/7OOSmUYIYFs5o/PuPpoTMF+hcVXMs+0yDukIMTOzG9m3t8k36PVrghFmnK6pC3Rt3mibjW****ng==	The Token that you want to revoke.

Note For more information about these parameters, see Common parameters and Make API requests.

Response parameters


Parameter	Type	Example	Description
RequestId	String	833 EDFCB-C447-4CE3-B21F-3A4C2D1B487D	The ID of the request, which is a common parameter. Each request has a unique ID.

Examples

Sample requests

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==
&<Common request parameters>

Sample success responses

XML format

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

JSON format

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

Error codes


HTTP status code	Error	Error message	Description
404	ApiNotSupport	The specified API is not supported.	The current interface is not supported. Please check.
400	CheckAccountInfoFailed	An error occurred while checking the account information by the STS token.	An error occurred while parsing the account information in 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.	The error message returned because the instance permission verification fails. Check the ownership and authorization policy of the MQTT instance.
500	InternalError	An error occurred while processing your request. Try again later.	The MQTT backend service is abnormal. Please try again.
400	ParameterCheckFailed	An error occurred while validating the parameters. The parameters may be missing or invalid.	The parameter verification fails. This parameter 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.	The error message returned because the resource permission verification failed. Check the instance, Topic, and Group ID for their permissions and authorization policies.
400	RevokeTokenOverFlow	You have revoked tokens too many times. Please try again later.	The Token is disabled frequently and is subject to traffic control. Retry later.
500	SystemOverFlow	An error occurred while processing your request. Please try again.	System throttling. Please try again.
400	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.	The parameter verification fails. This parameter may be missing or invalid.

For a list of error codes, visit the API Error Center.