文档

CreateSmartAccessGateway - 智能接入网关实例

更新时间:

创建智能接入网关实例。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
smartag:CreateSmartAccessGatewayWrite
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/*

请求参数

名称类型必填描述示例值
RegionIdstring

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

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

cn-shanghai
MaxBandWidthinteger

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

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

智能接入网关实例名称。

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

testname
Descriptionstring

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

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

testdesc
Periodinteger

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

取值:1~9122436

12
AutoPayboolean

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

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

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

false
HardWareSpecstring

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

  • sag-100wm
  • sag-1000
  • sag-vcpe
sag-100wm
ReceiverCountrystring

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

中国
ReceiverStatestring

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

浙江
ReceiverCitystring

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

杭州
ReceiverDistrictstring

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

西湖
ReceiverTownstring

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

转塘
ReceiverZipstring

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

310000
ReceiverPhonestring

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

8585****
ReceiverMobilestring

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

1884085****
ReceiverNamestring

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

张三
ReceiverEmailstring

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

xx@example.com
BuyerMessagestring

买家留言信息。

留言
ReceiverAddressstring

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

XX号
HaTypestring

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

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

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

取值: PREPAY,预付费。

PREPAY
AlreadyHaveSagboolean

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

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

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

取值:basic,基础版。

basic

返回参数

名称类型描述示例值
object

智能接入网关实例信息。

Descriptionstring

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

testdesc
RequestIdstring

请求 ID。

A6B9EB0F-57DB-4843-A372-04678ABF490E
OrderIdstring

订单 ID。

20337777****
SmartAGIdstring

智能接入网关实例 ID。

sag-nylv14tghsk26c*****
Namestring

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

testname
ResourceGroupIdstring

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

rg-acfm2iu4fnc****

示例

正常返回示例

JSON格式

{
  "Description": "testdesc",
  "RequestId": "A6B9EB0F-57DB-4843-A372-04678ABF490E",
  "OrderId": "20337777****",
  "SmartAGId": "sag-nylv14tghsk26c*****",
  "Name": "testname",
  "ResourceGroupId": "rg-acfm2iu4fnc****"
}

错误码

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

  • 本页导读 (1)
文档反馈