一型一密免注册场景下,调用该接口查看单个设备的标识列表。

QPS限制

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

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

调试

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

请求参数

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

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

IotId String y4u2weAIrpp****WHMle1234

设备ID。您可调用QueryDeviceInfo接口查询IotId

IotInstanceId String iot-a****13l

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

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

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

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

返回数据

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

调用失败时,返回的错误码。更多信息,请参见错误码

Data Struct

设备包含标识ID时,返回的标识列表。详细内容,请参见DynamicRegClientIds信息。

DynamicRegClientIds Array of DynamicRegClientId

设备标识列表。

ClientId String 9rSzYt4js92********f000112

设备标识。

CreateTime Long 1636514022424

设备标识创建时间。

IotId String y4u2weAI********HMle1234

设备ID。

ErrorMessage String request parameter error

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

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

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

Success Boolean true

表示是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryClientIds
&IotId=y4u2weAIrpp****WHMle1234
&<公共请求参数>

正常返回示例

XML格式

<QueryClientIdsResponse>
  <RequestId>CA991E7C-BDE7-5887-B3B7-E08C68C0D346</RequestId>
  <Data>
        <IotId>kRLP***0000</IotId>
        <DynamicRegClientIds>
              <CreateTime>1635847637823</CreateTime>
              <ClientId>K19uYV***000100</ClientId>
        </DynamicRegClientIds>
        <DynamicRegClientIds>
              <CreateTime>1635846982286</CreateTime>
              <ClientId>bpQwyW***000100</ClientId>
        </DynamicRegClientIds>
        <DynamicRegClientIds>
              <CreateTime>1635847426368</CreateTime>
              <ClientId>ntnIvez***000100</ClientId>
        </DynamicRegClientIds>
  </Data>
  <Success>true</Success>
</QueryClientIdsResponse>

JSON格式

{
    "RequestId": "CA991E7C-BDE7-5887-B3B7-E08C68C0D346",
    "Data": {
        "IotId": "kRLP***0000",
        "DynamicRegClientIds": [
            {
                "CreateTime": 1635847637823,
                "ClientId": "K19uYV***000100"
            },
            {
                "CreateTime": 1635846982286,
                "ClientId": "bpQwyW***000100"
            },
            {
                "CreateTime": 1635847426368,
                "ClientId": "ntnIvez***000100"
            }
        ]
    },
    "Success": true
}