使用GetDeviceCredential查询一机一密设备访问凭证-云消息队列 MQTT 版-阿里云

一机一密认证方式下，设备与云消息队列 MQTT 版建立连接时，需要携带提前申请的设备访问凭证信息向云消息队列 MQTT 版发起认证请求，请求通过则允许设备接入服务端。本接口用于查询指定设备的访问凭证。

接口说明

本接口的单用户 QPS 限制为 500 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 QPS 限制。
每成功调用一次 GetDeviceCredential 接口，都会计算为一次消息 TPS，从而影响您的计费。详细信息，请参见计费说明。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

mq:GetDeviceCredential

get

*Instance

acs:mq:{#regionId}:{#accountId}:{#InstanceId}

无

请求参数

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

说明

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

返回参数

名称	类型	描述	示例值
	object
RequestId	string	公共参数，每个请求的 ID 都是唯一的。	E4581CCF-62AF-44D9-B5B4-D1DQDC0E****
DeviceCredential	object	设备的访问凭证信息。
UpdateTime	integer	设备访问凭证上一次更新的毫秒时间戳。	1605541382000
DeviceAccessKeyId	string	设备的 AccessKey ID。	DC.Z5fXh9sRRVufyLi6wo****
CreateTime	integer	设备访问凭证创建的毫秒时间戳。	1605541382000
InstanceId	string	云消息队列 MQTT 版实例的 ID。	post-cn-0pp12gl****
DeviceAccessKeySecret	string	设备的 AccessKey Secret。	DC.BJMkn4eMQJK2vaApTS****
ClientId	string	设备的 Client ID。	GID_test@@@test

示例

正常返回示例

JSON格式

{
  "RequestId": "E4581CCF-62AF-44D9-B5B4-D1DQDC0E****",
  "DeviceCredential": {
    "UpdateTime": 1605541382000,
    "DeviceAccessKeyId": "DC.Z5fXh9sRRVufyLi6wo****",
    "CreateTime": 1605541382000,
    "InstanceId": "post-cn-0pp12gl****",
    "DeviceAccessKeySecret": "DC.BJMkn4eMQJK2vaApTS****",
    "ClientId": "GID_test@@@test"
  }
}

错误码

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.	设备证书不存在，请检查是否注册了该设备证书
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.	当前接口不支持，请检查。

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

变更历史

更多信息，参考变更详情。