Revokes a token.

Scenarios

This operation is called by an application server to terminate previous token authorization in advance. For more information, see Token authentication overview.

Limits

A single user can send a maximum of 5 requests per second.

Note Each successful call to the RevokeToken operation is calculated as a message transaction per second (TPS). This way, you are billed for the call. For more information, seeBilling.

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. Set the value to RevokeToken.

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

The ID of the Message Queue for MQTT instance. The value must match the instance ID used on the Message Queue for MQTT client. You can obtain the instance ID from the instance details page in the Message Queue for MQTT console.

RegionId String Yes mq-internet-access

The region ID of the Message Queue for MQTT instance.

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 Endpoints.

Response parameters

Parameter Type Example Description
RequestId String 833EDFCB-C447-4CE3-B21F-3A4C2D1B****

The ID of the request.

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-3A4C2D1B****</RequestId>
</RevokeTokenResponse>

JSON format

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

Error codes

HTTP status code Error code Error message Description
404 ApiNotSupport The specified API is not supported. The error message returned because the current operation is not supported.
400 CheckAccountInfoFailed An error occurred while checking the account information by the STS token. The error message returned because the account information of the Security Token Service (STS) token failed to be parsed.
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 instance permission verification failed. Check the ownership and authorization policy of the Message Queue for MQTT instance.
500 InternalError An error occurred while processing your request. Try again later. The error message returned because an internal error occurred to the Message Queue for MQTT instance. Please try again.
400 ParameterCheckFailed An error occurred while validating the parameters. The parameters may be missing or invalid. The error message returned because parameter verification failed. 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 resource permission verification failed. Check the permissions and authorization policies of the instance, topic, and group ID.
400 RevokeTokenOverFlow You have revoked tokens too many times. Please try again later. The error message returned because token revocation is too frequent and throttling is triggered. Please try again later.
500 SystemOverFlow An error occurred while processing your request. Please try again. The error message returned because throttling is triggered. Please try again.
400 InvalidParameter.%s An error occurred while validating the parameter. The parameter may be missing or invalid. The error message returned because parameter verification failed. This parameter may be missing or invalid.

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