调用CreateSmartAccessGateway接口创建智能接入网关硬件版实例或vCPE版实例。

调试

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

请求参数

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

要执行的操作。取值:CreateSmartAccessGateway

RegionId String cn-shanghai

智能接入网关实例的地域ID。

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

MaxBandWidth Integer 12

智能接入网关实例的带宽。

  • 如果要创建智能接入网关硬件版实例,且智能接入网关设备规格为sag-100wm,带宽取值范围为2~50 Mbps。
  • 如果要创建智能接入网关硬件版实例,且智能接入网关设备规格为sag-1000,带宽取值范围为10~500 Mbps。
  • 如果要创建智能接入网关vCPE版实例,带宽取值范围为10~1000 Mbps。
Name String testname

智能接入网关实例名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)或短划线(-)。

Description String testdesc

智能接入网关实例的描述信息。

描述长度为2~256个字符,以大小写字母或中文开头,可包含数字、半角句号(.)、下划线(_)或短划线(-)。

Period Integer 12

智能接入网关实例的购买时长,单位:月。

取值:1~9122436

AutoPay Boolean false

是否自动支付预付费实例的账单。取值:

  • true:是。
  • false(默认值):否。

如果您选择不自动支付账单,在您调用本接口后,请前往控制台的订单中心完成支付,实例才能创建成功。

HardWareSpec String sag-100wm

智能接入网关实例类型。取值:

  • sag-100wm
  • sag-1000
  • sag-vcpe
ReceiverCountry String 中国

智能接入网关设备收货国家。

ReceiverState String 浙江

智能接入网关设备收货省份。

ReceiverCity String 杭州

智能接入网关设备收货城市。

ReceiverDistrict String 西湖

智能接入网关设备收货街区。

ReceiverTown String 转塘

智能接入网关设备收货乡镇。

ReceiverZip String 310000

智能接入网关设备收货省份邮编。

ReceiverPhone String 8585****

智能接入网关设备收件人电话。

ReceiverMobile String 1884085****

智能接入网关设备收件人手机号。

ReceiverName String 张三

智能接入网关设备收件人姓名。

ReceiverEmail String xx@example.com

智能接入网关设备收货人的电子邮箱。

BuyerMessage String 留言

买家留言信息。

ReceiverAddress String XX号

智能接入网关设备收货详细地址。

HaType String no_backup

选择一种使用方式。取值:

  • no_backup:只购买一台智能接入网关设备接入阿里云。
  • cold_backup:购买两台智能接入网关设备共享带宽,仅主设备在线。当主设备发生故障时,需手动切换至备设备。
  • warm_backup:购买两台智能接入网关设备共享带宽,两台设备同时在线。当主设备故障时自动切换到备设备。
说明 在您创建智能接入网关vCPE实例时,本参数仅取值warm_backup
ChargeType String PREPAY

智能接入网关实例的计费类型。

取值: PREPAY,预付费。

AlreadyHaveSag Boolean false

是否已拥有智能接入网关设备。取值:

  • true:是。
  • false(默认值):否。
CPEVersion String basic

在创建智能接入网关vCPE实例时的版本。

取值:basic,基础版。

返回数据

名称 类型 示例值 描述
Description String testdesc

智能接入网关实例的描述信息。

RequestId String A6B9EB0F-57DB-4843-A372-04678ABF490E

请求ID。

OrderId String 20337777****

订单ID。

SmartAGId String sag-nylv14tghsk26c*****

智能接入网关实例ID。

Name String testname

智能接入网关实例的名称。

ResourceGroupId String rg-acfm2iu4fnc****

智能接入网关实例所属的资源组ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateSmartAccessGateway
&RegionId=cn-shanghai
&MaxBandWidth=12
&Name=testname
&Description=testdesc
&Period=12
&AutoPay=false
&HardWareSpec=sag-100wm
&ReceiverCountry=中国
&ReceiverState=浙江
&ReceiverCity=杭州
&ReceiverDistrict=西湖
&ReceiverTown=转塘
&ReceiverZip=310000
&ReceiverPhone=8585****
&ReceiverMobile=1884085****
&ReceiverName=张三
&ReceiverEmail=xx@example.com
&BuyerMessage=留言
&ReceiverAddress=XX号
&HaType=no_backup
&ChargeType=PREPAY
&AlreadyHaveSag=false
&CPEVersion=basic
&公共请求参数

正常返回示例

XML格式

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

<CreateSmartAccessGatewayResponse>
    <SmartAGId>sag-nylv14tghsk26c****</SmartAGId>
    <OrderId>20337777121212</OrderId>
    <RequestId>A6B9EB0F-57DB-4843-A372-04678ABF490E</RequestId>
</CreateSmartAccessGatewayResponse>

JSON格式

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

{
  "SmartAGId" : "sag-nylv14tghsk26c****",
  "OrderId" : 20337777121212,
  "RequestId" : "A6B9EB0F-57DB-4843-A372-04678ABF490E"
}

错误码

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