Queries detailed information of a gateway that is bound to a specified edge instance.

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 QueryEdgeInstanceGateway

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

InstanceId String Yes F3APY0tPLhmgGtx0****

The ID of the edge instance.

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 28D159F4-980F-423D-95F0-F705E9DFC016

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.

GatewayList Array

The data returned if the call was successful.

ProductKey String a1mAdeG****

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

DeviceName String e46ea1a4347c42a0a83b8c956ab1ab

The name of the gateway.

IotId String LuD9x5hiRUdVemWU****000101

The globally unique ID that is generated by IoT Platform for the gateway device.

EdgeVersion String v1.0.0

The version of Link IoT Edge.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/? Action=QueryEdgeInstanceGateway
&InstanceId=F3APY0tPLhmgGtx0****
&<Common request parameters>

Sample success responses

XML format

<QueryEdgeInstanceGatewayResponse>
    <GatewayList>
        <Gateway>
            <IotId>LuD9x5hiRUdVemWU****000101</IotId>
            <ProductKey>a1mAdeG****</ProductKey>
            <DeviceName>e46ea1a4347c42a0a83b8c956ab1ab</DeviceName>
            <EdgeVersion>v1.0.0</EdgeVersion>
        </Gateway>
    </GatewayList>
    <RequestId>547A62E5-0D6D-4DB5-9CCC-58C706891976</RequestId>
    <Code>Success</Code>
    <Success>true</Success>
</QueryEdgeInstanceGatewayResponse>

JSON format

{
  "GatewayList": [
    {
      "IotId": "LuD9x5hiRUdVemWU****000101",
      "ProductKey": "a1mAdeG****",
      "DeviceName": "e46ea1a4347c42a0a83b8c956ab1ab",
      "EdgeVersion": "v1.0.0"
    }
  ],
  "RequestId": "547A62E5-0D6D-4DB5-9CCC-58C706891976",
  "Code": "Success",
  "Success": true
}

Error codes

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