一型一密免注册场景下,若设备包含多个设备标识,需调用该接口指定一个正确的设备标识,以防止非法的设备登录。

使用说明

您可调用QueryClientIds接口,查看设备的设备标识列表。

QPS限制

单个阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。

说明 RAM用户共享阿里云账号配额。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String TransformClientId

系统规定参数。取值:TransformClientId。

ClientId String 9rSz********UNMWj33f000112

设备标识ID。

IotId String BXPV9Ks3bxwM9fD****0000101

设备ID。

IotInstanceId String iot-02****43

实例ID。您可在物联网平台控制台的实例概览页面,查看当前实例的ID

注意
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无ID值,则无需传入。

实例的更多信息,请参见实例概述

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见公共参数文档

返回数据

名称 类型 示例值 描述
Code String Success

接口返回码。Success表示成功,其它表示错误码。错误码详情,请参见错误码

ErrorMessage String request parameter error

调用失败时,返回的出错信息。

RequestId String 89F22330-BAEE-****-****-41BA46D6E267

阿里云为该请求生成的唯一标识符。

Success Boolean true

表示是否调用成功。

  • true:表示调用成功。
  • false:表示调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=TransformClientId
&ClientId=9rSz********UNMWj33f000112
&IotId=BXPV9Ks3bxwM9fD****0000101
&<公共请求参数>

正常返回示例

XML格式

<TransformClientIdResponse>
  <RequestId>89F22330-BAEE-****-****-41BA46D6E267</RequestId>
  <Code>Success</Code>
  <Success>true</Success>
</TransformClientIdResponse>

JSON格式

{
    "RequestId": "89F22330-BAEE-****-****-41BA46D6E267",
    "Code": "Success",
    "Success": true
}