调用CreateCustomerGateway接口创建用户网关。

调试

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

请求参数

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

要执行的操作。取值:CreateCustomerGateway

IpAddress String 101.XX.XX.12

本地数据中心网关设备的公网IP地址。

RegionId String cn-shanghai

用户网关所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

ClientToken String 02fb3da4-130e-11e9-8e44****

客户端Token,用于保证请求的幂等性。

由客户端生成该参数值,需保证该参数在不同请求间唯一,最大值不超过64个ASCII字符。

Name String nametest

用户网关的名称。

长度为2~128个字符,必须以字母或中文开头,可包含数字、半角句号(.)、下划线(_)和短划线(-)。但不能以http://https://开头。

Description String desctest

用户网关的描述信息。

长度为2~256个字符,必须以字母或中文开头,但不能以http://https://开头。

Asn String 65530

本地数据中心网关设备的自治系统号。

Asn是一个4字节的号码,支持按照两段位的格式进行输入,即:前16位比特.后16位比特。每个段位使用十进制输入。

例如输入123.456,则表示自治系统号:123*65536+456=8061384。

AuthKey String AuthKey****

本地数据中心网关设备BGP路由协议的认证密钥。

密钥长度为1~64个字符,只支持ASCII字符,不支持空格、中文和半角问号(?)。

返回数据

名称 类型 示例值 描述
CustomerGatewayId String cgw-bp1jrawp82av6bws9****

用户网关的实例ID。

IpAddress String 101.XX.XX.12

本地数据中心网关设备的公网IP地址。

Name String nametest

用户网关的名称。

Description String desctest

用户网关的描述信息。

CreateTime Long 1493363486000

创建用户网关的时间戳。

RequestId String D32B3C26-6C6C-4988-93E9-D2A6444CE6AE

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateCustomerGateway
&IpAddress=101.XX.XX.12
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

<CreateCustomerGatewayResponse>
      <CustomerGatewayId>cgw-bp1aw0a5nfff03xp****</CustomerGatewayId>
      <RequestId>D32B3C26-6C6C-4988-93E9-D2A6444CE6AE</RequestId>
      <CreateTime>1493363486000</CreateTime>
      <IpAddress>101.XX.XX.12</IpAddress>
</CreateCustomerGatewayResponse>

JSON格式

{
    "CustomerGatewayId": "cgw-bp1jrawp82av6bws9****",
    "CreateTime": 1493363599000,
    "RequestId": "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
    "IpAddress": "101.XX.XX.12"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidAuthkey.Malformed The specified BGP authentication key (%s) is malformed. 该BGP认证密钥不合法。
400 InvalidIpAddress.AlreadyExist Specified IpAddress is already exist. 该IP地址已经存在。原因是同一个用户在同一个地域内,IP地址不可重复。
400 InvalidIpAddress.WrongFormat Specified IpAddress is invalid. 该IP不合法。
400 InvalidName The name is not valid 该名称格式不合法。
400 InvalidDescription The description is not valid 描述格式不合法。
400 Resource.QuotaFull The quota of resource is full 资源配额已达上限。
400 OperationDenied.MissingAsn The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified. 当指定了用户网关的BGP验证密钥时,必须指定自治系统号。
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. 您没有权限操作该资源,请您申请操作权限后再试。
403 Forbidden User not authorized to operate on the specified resource. 您没有权限操作指定资源,请提交工单咨询。

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