调用该接口录入网关。

调试

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

请求参数

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

系统规定参数。取值：CreateGateway。

IotInstanceId String 否 iot-***-v6***

实例ID。您可在物联网平台控制台的实例概览页面，查看当前实例的ID。

注意
  • 若有ID值，必须传入该ID值，否则调用会失败。
  • 若无ID值，则无需传入。

实例的更多信息，请参见实例概述。

GwEui String 是 0000000000000000

网关唯一标识。
PinCode String 是 000000

网关PinCode，用于确保录入者拥有该网关。
Name String 是 vmee

自定义网关名称。

  • 仅支持中文汉字、英文字母、数字、下划线（_）。
  • 必须以中文汉字、英文字母或数字开头。
  • 长度不超过30个字符，不少于4个字符（一个中文汉字算一个字符）。
Description String 否 my gateway

自定义网关描述信息，长度不超过100个字符（一个中文汉字算一个字符）。
FreqBandPlanGroupId Long 是 123

网关频段ID。
CommunicationMode String 是 HALF_DUPLEX

网关通信模式。取值：

  • FULL_DUPLEX：全双工。
  • HALF_DUPLEX：半双工。
City String 是 杭州

网关所在城市名称。
District String 是 滨江区

网关所在城区名称。
Address String 是 详细地址

网关所在详细地址。
GisCoordinateSystem String 是 GCJ_02

网关经纬度所采用的坐标系统，可取值为WGS_84, GCJ_02。

Longitude Float 是 123.45678

网关经度。
Latitude Float 是 23.45678

网关纬度。
AddressCode Long 是 123

网关所在地区ID，由http://lbs.amap.com/api/javascript-api/download定义。

返回数据

名称 类型 示例值 描述
Success Boolean true

是否调用成功。

  • true：调用成功。
  • false：调用失败。
RequestId String 89EF6CAA-958F-F32C-BE45-FE003C6DE097

请求ID。

示例

请求示例

http(s)://linkwan.cn-shanghai.aliyuncs.com/?Action=CreateGateway
&Address=详细地址
&AddressCode=123
&City=杭州
&CommunicationMode=HALF_DUPLEX
&District=滨江区
&FreqBandPlanGroupId=123
&GisCoordinateSystem=GCJ_02
&GwEui=0000000000000000
&Latitude=23.45678
&Longitude=123.45678
&Name=vme
&PinCode=000000
&<公共请求参数>

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateGatewayResponse>
      <RequestId>89EF6CAA-958F-F32C-BE45-FE003C6DE097</RequestId>
      <Success>true</Success>
</CreateGatewayResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "89EF6CAA-958F-F32C-BE45-FE003C6DE097",
  "Success" : true
}

错误码

HttpCode 错误码 错误信息 描述
400 ForbiddenByRam User not authorized to operate on the specified resource, or this API does not support RAM. 用户没有执行该操作所需要的RAM权限。
400 ForbiddenByRiskControl This operation cannot be performed because of security risks. 存在安全风险，无法执行该操作
400 GwEuiDuplicated A gateway with the same gwEui already exists. GwEUI 已存在
400 GatewayTupleAlreadyAbandoned The specified gateway tuple has been abandoned. 网关元组已经废弃
400 IotHubTripleMissing The IoT Platform trituple of this gateway does not exist. 找不到网关的物联网平台设备证书（ProductKey、DeviceName、DeviceSecret）
400 InvalidPinCode An error occurred while verifying PinCode. PinCode校验失败
400 GatewayAlreadyBoundToOthers This gateway has already been bound to another account. 网关已经绑定到其它账号
400 ExceedGatewayLimit The maximum number of gateways is exceeded. 超出网关可使用额度
400 InvalidFreqBandPlan The frequency band plan is invalid. 频段计划不可用
400 InvalidName The specified name is invalid. 名称不合法
400 GatewayInstanceInvalid The instance ID is invalid. 无效的实例id。
400 GatewayDistributeFail Failed to distribute the gateway tuple. 网关密钥分发失败。

访问错误中心查看更多错误码。