调用该接口将网关分配到边缘实例中。

限制条件

单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。

说明 子账号共享主账号配额。

调试

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

请求参数

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

系统规定参数。取值:BindGatewayToEdgeInstance。

InstanceId String F3APY0tPLhmgGtx0****

边缘实例ID。

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

公共实例不传此参数;您购买的实例需传入实例ID。

ProductKey String a1mAdeG****

网关所属的产品Key,产品的唯一标识符。

如果传入此参数,需同时传入DeviceName

DeviceName String device1

网关设备名称。

如果传入此参数,需同时传入ProductKey

IotId String 4z819VQHk6VSLmmBJfrf0010******

网关设备的ID,物联网平台为设备生成的唯一标识符。

如果传入该参数,则无需传入ProductKeyDeviceName。IotId作为设备唯一标识符,与ProductKey&DeviceName组合是一一对应的关系。如果您同时传入IotIdProductKeyDeviceName组合,则以IotId为准。

调用API时,除了本文介绍的该API的特有请求参数,还需传入公共请求参数。公共请求参数说明,请参见 公共参数文档

返回数据

名称 类型 示例值 描述
Code String Success

接口返回码。Success表示成功,其它表示错误码。详情请参见错误码

ErrorMessage String request parameter error

调用失败时,返回的出错信息。

RequestId String 28D159F4-980F-423D-95F0-F705E9DFC016

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

Success Boolean true

表示是否调用成功。true表示调用成功,false表示调用失败。

示例

请求示例

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=BindGatewayToEdgeInstance
&InstanceId=F3APY0tPLhmgGtx0****
&ProductKey=a1mAdeG****
&DeviceName=e46ea1a4347c42a0a83b8c956ab1ab
&<公共请求参数>

正常返回示例

XML 格式

<BindGatewayToEdgeInstanceResponse>
      <RequestId>E3817065-2A17-4814-82FA-66FAB2CC01DF</RequestId>
      <Code>Success</Code>
      <Success>true</Success>
</BindGatewayToEdgeInstanceResponse>

JSON 格式

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