一机一密认证方法，即预先为每个设备申请唯一的访问凭证（ClientId、DeviceAccessKeyId和DeviceAccessKeySecret）。当设备与云消息队列 MQTT 版建立连接时，需要将设备访问凭证中的信息按照约定的形式设置到Username和Password中，向云消息队列 MQTT 版发起认证请求，云消息队列 MQTT 版认证通过后激活设备，设备与云消息队列 MQTT 版间才可传输数据。 本接口用于为指定设备申请访问凭证。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientId | string | 是 | 需要注册访问凭证的设备的 Client ID。 | GID_test@@@test |
| InstanceId | string | 是 | 云消息队列 MQTT 版实例的 ID，一定要和客户端实际使用的实例 ID 匹配。您可以在控制台实例详情页面获取该 ID。 | post-cn-0pp12gl**** |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "E4581CCF-62AF-44D9-B5B4-D1DBDC0E****",
"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 | DeviceCredentialNumExceed | The number of device credentia exceeds the limit. Please revoke unused device certificates | - |
| 400 | DeviceCredentialExsit | Device Credential Exsit | - |
| 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-04-06 | OpenAPI 错误码发生变更 | 查看变更详情 |