Queries configuration information of one or more devices that are bound to an edge instance.

Limits

A single Alibaba Cloud account can run a maximum of 5 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 BatchGetEdgeInstanceDeviceConfig

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

InstanceId String Yes F3APY0tPLhmgGtx0****

The ID of the edge instance.

IotIds.N RepeatList Yes BXPV9Ks3bxwM9fDl****000101

The IDs of devices that you want to query. You can call theQueryEdgeInstanceDeviceoperation to query edge instance devices.

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 D4A102C2-36A5-4964-9694-0F8EFF95CCA8

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.

DeviceConfigList Array

The device configuration information returned if the call was successful.

IotId String sjI0Sd124XFYyjBY****000101

The ID of the device.

Config Struct

The configuration information of the device.

Format String JSON

The format of the configuration file. Valid values: KV, JSON, and FILE.

Content String {\"test\": \"device_config_demo\"}

The configuration content or the Object Storage Service (OSS) path of the configuration file.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=BatchGetEdgeInstanceDeviceConfig
&IotIds.2=BXPV9Ks3bxwM9fDl****000101
&IotIds.1=sjI0Sd124XFYyjBY****000101
&InstanceId=F3APY0tPLhmgGtx0****
&<Common request parameters>

Sample success responses

XML format

<BatchGetEdgeInstanceDeviceConfigResponse>
    <DeviceConfigList>
        <DeviceConfig>
            <IotId>sjI0Sd124XFYyjBY****000101</IotId>
            <Config>
                <Format>JSON</Format>
                <Content>{"test": "device_config_demo"}</Content>
            </Config>
        </DeviceConfig>
        <DeviceConfig>
            <IotId>BXPV9Ks3bxwM9fD****0000101</IotId>
            <Config>
                <Format>JSON</Format>
                <Content>{"test": "device_config_demo"}</Content>
            </Config>
        </DeviceConfig>
    </DeviceConfigList>
    <RequestId>D4A102C2-36A5-4964-9694-0F8EFF95CCA8</RequestId>
    <Code>Success</Code>
    <Success>true</Success>
</BatchGetEdgeInstanceDeviceConfigResponse>

JSON format

{
  "DeviceConfigList": [
    {
      "IotId": "sjI0Sd124XFYyjBY****000101",
      "Config": {
        "Format": "JSON",
        "Content": "{\"test\": \"device_config_demo\"}"
      }
    },
    {
      "IotId": "BXPV9Ks3bxwM9fD****0000101",
      "Config": {
        "Format": "JSON",
        "Content": "{\"test\": \"device_config_demo\"}"
      }
    }
  ],
  "RequestId": "D4A102C2-36A5-4964-9694-0F8EFF95CCA8",
  "Code": "Success",
  "Success": true
}

Error codes

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