QueryClientIds - IoT Platform

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
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。