Binds a gateway to an edge instance.


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.


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 BindGatewayToEdgeInstance

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

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.

ProductKey String No a1mAdeG****

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

If you specify this parameter, you must also specify theDeviceNameparameter.

DeviceName String No device1

The name of the gateway.

If you specify this parameter, you must also specify theProductKeyparameter.

IotId String No 4z819VQHk6VSLmmBJfrf0010******

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

If you specify this parameter, you do not need to specify theProductKeyorDeviceNameparameter. The IotId parameter uniquely identifies a device and corresponds to theProductKey&DeviceNamecombination. If you use theIotIdparameter and the combination ofProductKeyandDeviceNameparameters at the same time, the IotId parameter takes precedence.

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.


Sample requests

http(s):// Action=BindGatewayToEdgeInstance
&<Common request parameters>

Sample success responses

XML format


JSON format

  "RequestId": "E3817065-2A17-4814-82FA-66FAB2CC01DF",
  "Code": "Success",
  "Success": true

Error codes

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