Queries a list of edge instance devices.

Limits

A single Alibaba Cloud account can run a maximum of 10 queries per second (QPS).

Note RAM users share the quota of the Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes QueryEdgeInstanceDevice

The operation that you want to perform. Set the value to QueryEdgeInstanceDevice.

CurrentPage Integer Yes 1

The number of the page from which the results are displayed. The minimum value is 1. If you specify a value smaller than 1, the system uses 1.

InstanceId String Yes tG7sKuOQ7ylb7qS4****

The ID of the edge instance.

PageSize Integer Yes 15

The number of entries to return on each page. Valid values: 10 to 30. If you specify a value smaller than 10, the system uses 10.

IotInstanceId String No iot_instc_pu****_c*-v64********

The ID of the Internet of Things (IoT) service instance. This parameter is not required for public instances. However, this parameter is required for the instances that you have purchased.

In addition to the preceding exclusive request parameters, you must specify common request parameters when calling this API operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String AC76932E-E0C9-41EE-843D-B1CA3279B053

The ID of the request.

Success Boolean true

Indicates whether the call was successful. true: indicates that the call was successful. false: indicates that the call failed.

Code String Success

The error code. Success indicates that the call was successful. Other values indicate that specific errors occurred. For more information, see Error codes.

ErrorMessage String request parameter error

The error message returned if the call failed.

Data Struct

The data returned if the call was successful.

Total Integer 4

The number of devices.

PageSize Integer 15

The number of entries returned per page.

CurrentPage Integer 1

The page number of the returned page.

DeviceList Array

The list of device information.

IotId String XSpPdtxzE6ebtCkx****000101

The ID of the device.

ProductKey String a1p5QfE****

The key that uniquely identifies the product to which the device belongs.

DeviceName String test_tmp_zdy

The name of the device.

DriverId String 44c090ba7b104641a4b9bcf10241****

The ID of the driver.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryEdgeInstanceDevice
&PageSize=15
&InstanceId=tG7sKuOQ7ylb7qS4****
&CurrentPage=1
&<Common request parameters>

Sample success responses

XML format

<QueryEdgeInstanceDeviceResponse>
    <RequestId>AC76932E-E0C9-41EE-843D-B1CA3279B053</RequestId>
    <Data>
        <PageSize>15</PageSize>
        <CurrentPage>1</CurrentPage>
        <Total>4</Total>
        <DeviceList>
            <Device>
                <IotId>XSpPdtxzE6ebtCkx****000101</IotId>
                <DriverId>44c090ba7b104641a4b9bcf10241****</DriverId>
                <ProductKey>a1p5QfE****</ProductKey>
                <DeviceName>test_tmp_zdy</DeviceName>
            </Device>
            <Device>
                <IotId>ixX7TRWtewDxZnus****000101</IotId>
                <DriverId>021d154d2a2f4dd7a489773d9e04****</DriverId>
                <ProductKey>a1p5QfE****</ProductKey>
                <DeviceName>test_name19</DeviceName>
            </Device>
            <Device>
                <IotId>MkzMNGVF3wOk62J6****000101</IotId>
                <DriverId>021d154d2a2f4dd7a489773d9e04****</DriverId>
                <ProductKey>a11jTlJ****</ProductKey>
                <DeviceName>testsss</DeviceName>
            </Device>
            <Device>
                <IotId>6nFJ9ewglx7aBWPb****000101</IotId>
                <DriverId>021d154d2a2f4dd7a489773d9e04****</DriverId>
                <ProductKey>a1PcD3R****</ProductKey>
                <DeviceName>device01</DeviceName>
            </Device>
        </DeviceList>
    </Data>
    <Code>Success</Code>
    <Success>true</Success>
</QueryEdgeInstanceDeviceResponse>

JSON format

{
  "RequestId": "AC76932E-E0C9-41EE-843D-B1CA3279B053",
  "Data": {
    "PageSize": 15,
    "CurrentPage": 1,
    "Total": 4,
    "DeviceList": [
      {
        "IotId": "XSpPdtxzE6ebtCkx****000101",
        "DriverId": "44c090ba7b104641a4b9bcf10241****",
        "ProductKey": "a1p5QfE****",
        "DeviceName": "test_tmp_zdy"
      },
      {
        "IotId": "ixX7TRWtewDxZnus****000101",
        "DriverId": "021d154d2a2f4dd7a489773d9e04****",
        "ProductKey": "a1p5QfE****",
        "DeviceName": "test_name19"
      },
      {
        "IotId": "MkzMNGVF3wOk62J6****000101",
        "DriverId": "021d154d2a2f4dd7a489773d9e04****",
        "ProductKey": "a11jTlJ****",
        "DeviceName": "testsss"
      },
      {
        "IotId": "6nFJ9ewglx7aBWPb****000101",
        "DriverId": "021d154d2a2f4dd7a489773d9e04****",
        "ProductKey": "a1PcD3R****",
        "DeviceName": "device01"
      }
    ]
  },
  "Code": "Success",
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.