UnRegisterDeviceCredential - 注销设备的访问凭证 - 云消息队列 MQTT 版

一机一密认证方法，即预先为每个设备申请唯一的访问凭证（ClientId、DeviceAccessKeyId和DeviceAccessKeySecret）。当设备与云消息队列 MQTT 版建立连接时，需要将设备访问凭证中的信息按照约定的形式设置到Username和Password中，向云消息队列 MQTT 版发起认证请求，云消息队列 MQTT 版认证通过后激活设备，设备与云消息队列 MQTT 版间才可传输数据。若您不需要再使用某个设备访问凭证，您可以调用本接口注销指定的设备访问凭证。

接口说明

指定设备访问凭证被注销后，使用该访问凭证连接的客户端暂时不受影响，若客户端连接断开，则无法再次使用该访问凭证通过服务端认证。
本接口的单用户 QPS 限制为 500 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
每成功调用一次 UnRegisterDeviceCredential 接口，都会计算为一次消息 TPS，从而影响您的计费。详细信息，请参见计费说明。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ClientId	string	是	需要注销访问凭证的设备的 Client ID。	GID_test@@@test
InstanceId	string	是	云消息队列 MQTT 版实例的 ID，一定要和客户端实际使用的实例 ID 匹配。您可以在控制台实例详情页面获取该 ID。	post-cn-0pp12gl****

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的。	E4581CCD-62AF-44D9-B5B4-D1DBDC0E****

示例

正常返回示例

JSON格式

{
  "RequestId": "E4581CCD-62AF-44D9-B5B4-D1DBDC0E****"
}

错误码

HTTP status code	错误码	错误信息	描述
400	ApplyTokenOverFlow	You have applied for tokens too many times. Please try again later.	申请Token频率过高，系统限流，请重试。
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	InvalidParameter.%s	An error occurred while validating the parameter. The parameter may be missing or invalid.	参数校验失败，可能缺失或者传入值非法。
400	DeviceCredentialNotFound	Device Credential Not Found. Check if the device certificate is registered.	设备证书不存在，请检查是否注册了该设备证书
404	ApiNotSupport	The specified API is not supported.	当前接口不支持，请检查。
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.	系统限流，请重试。

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

变更历史

变更时间	变更内容概要	操作
2023-12-28	OpenAPI 错误码发生变更	查看变更详情