调用该接口查询分享任务的设备列表。

QPS限制

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

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

调试

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

调试

请求参数

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

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

ShareTaskId String Md3ZiTL888K9llXDy7890***********

分享任务ID。

IotInstanceId String iot-e3***

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

注意
  • 若有ID值,必须传入该ID值,否则调用会失败。
  • 若无实例概览页面或ID值,则无需传入。

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

PageSize Integer 20

指定每页返回数据的最大条数,取值范围:1~50,默认值为20。

PageId Integer 1

当前页码,从1开始,最大为10000。

DeviceName String test

设备名称查询条件,模糊匹配。

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

返回数据

名称类型示例值描述
名称 类型 示例值 描述
Code String iot.system.SystemException

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

Data Struct

查询结果。

DeviceList Array of items

设备列表。

items
DeviceName String test

设备名称。

GmtAdded Long 1620624606000

添加时间。

IotId String Q7uOhVRdZRRlDnTLv****00100

物联网平台为设备颁发的ID,是设备的唯一标识符。

ProductKey String a1BwAGV****

设备所属产品的ProductKey

PageId Integer 1

当前页码。

PageSize Integer 20

每页返回的数据条数。

Total Integer 200

返回数据的总条数。

ErrorMessage String request parameter error

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

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

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

Success Boolean true

是否调用成功。

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

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=QueryShareTaskDeviceList
&ShareTaskId=Md3ZiTL888K9llXDy7890***********
&<公共请求参数>

正常返回示例

XML格式

<QueryShareTaskDeviceListResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <PageId>1</PageId>
        <PageSize>20</PageSize>
        <Total>200</Total>
        <DeviceList>
              <items>
                    <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
                    <GmtAdded>1620624606000</GmtAdded>
                    <ProductKey>a1BwAGV****</ProductKey>
                    <DeviceName>test</DeviceName>
              </items>
        </DeviceList>
  </Data>
  <Success>true</Success>
</QueryShareTaskDeviceListResponse>

JSON格式

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "PageId": "1",
        "PageSize": "20",
        "Total": "200",
        "DeviceList": {
            "items": [
                {
                    "IotId": "Q7uOhVRdZRRlDnTLv****00100",
                    "GmtAdded": "1620624606000",
                    "ProductKey": "a1BwAGV****",
                    "DeviceName": "test"
                }
            ]
        }
    },
    "Success": "true"
}