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

限制说明

  • 单阿里云账号调用该接口的每秒请求数(QPS)最大限制为10。
    说明 子账号共享主账号配额。
  • 单客户端出口IP的最大QPS限制为100,即来自单个客户端出口IP,调用阿里云接口的每秒请求总数不能超过100。

请求参数

名称 类型 是否必需 描述
Action String 要执行的操作,取值:BindGatewayToEdgeInstance
InstanceId String 边缘实例ID。
IotId String 网关设备的ID,物联网平台为设备生成的唯一标识符。

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

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

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

DeviceName String 网关设备名称。

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

公共请求参数 - 公共请求参数,请参见公共参数

返回参数

名称 类型 描述
RequestId String 阿里云为该请求生成的唯一标识符。
Success Boolean 表示是否调用成功。true表示调用成功,false表示调用失败。
ErrorMessage String 调用失败时,返回的出错信息。
Code String 接口返回码。

示例

请求示例

https://iot.cn-shanghai.aliyuncs.com/?Action=BindGatewayToEdgeInstance
&InstanceId=F3APY0tPLhmgGtx0****
&ProductKey=a1mAdeG****
&DeviceName=e46ea1a4347c42a0a83b8c956ab1ab
&公共请求参数

返回示例

  • JSON格式
    {
      "RequestId": "E3817065-2A17-4814-82FA-66FAB2CC01DF",
      "Code": "Success",
      "Success": true
    }
  • XML格式
    <?xml version="1.0" encoding="UTF-8"?>
    <BindGatewayToEdgeInstanceResponse>
        <RequestId>E3817065-2A17-4814-82FA-66FAB2CC01DF</RequestId>
        <Code>Success</Code>
        <Success>true</Success>
    </BindGatewayToEdgeInstanceResponse>