一型一密免注冊場景下,調用該接口查看單個設備的標識列表。

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
}