调用该接口查询项目的分享设备列表。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值：QueryProjectShareDeviceList。
ProductKey String 是 a1BwAGV****

设备所属的产品ProductKey。

IotInstanceId String 否 iot_instc_pu****_c*-v64********

实例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

设备名称。
IotId String Q7uOhVRdZRRlDnTLv****00100

物联网平台为设备颁发的ID，是设备的唯一标识符。
ProductKey String a1BwAGV****

设备所属产品的ProductKey。

Sharable Long 1

是否可以分享。

  • 1：可以。
  • 0：不可以。
PageId Integer 1

当前页码。
PageSize Integer 20

每页返回的数据条数。
Total Integer 200

返回数据的总条数。
ErrorMessage String An internal error occurred. Try again later.

调用失败时，返回的错误信息。
RequestId String 671D0F8F-FDC7-4B12-93FA-336C079C965A

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

是否调用成功。

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

示例

请求示例

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

正常返回示例

XML格式 

<QueryProjectShareDeviceListResponse>
  <RequestId>671D0F8F-FDC7-4B12-93FA-336C079C965A</RequestId>
  <Data>
        <PageId>1</PageId>
        <PageSize>20</PageSize>
        <Total>200</Total>
        <DeviceList>
              <items>
                    <IotId>Q7uOhVRdZRRlDnTLv****00100</IotId>
                    <Sharable>1</Sharable>
                    <ProductKey>a1BwAGV****</ProductKey>
                    <DeviceName>test</DeviceName>
              </items>
        </DeviceList>
  </Data>
  <Success>true</Success>
</QueryProjectShareDeviceListResponse>

JSON格式 

{
    "RequestId": "671D0F8F-FDC7-4B12-93FA-336C079C965A",
    "Data": {
        "PageId": "1",
        "PageSize": "20",
        "Total": "200",
        "DeviceList": {
            "items": [
                {
                    "IotId": "Q7uOhVRdZRRlDnTLv****00100",
                    "Sharable": "1",
                    "ProductKey": "a1BwAGV****",
                    "DeviceName": "test"
                }
            ]
        }
    },
    "Success": "true"
}