Creates a Smart Access Gateway (SAG) instance.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description
AutoPay Boolean Yes true

Indicates whether to automatically pay the bill for a subscription instance.

Valid values: true | false

Default value: false

BuyerMessage String Yes pls. deliver asap

The message that you can leave for extra information.

ChargeType String Yes PREPAY

The billing method of the SAG instance. Valid values:

  • PayOnDemand: pay-as-you-go
  • PREPAY: subscription
Note Currently, only subscription is supported.
HaType String Yes no_backup

Indicates whether to use a backup SAG device. Valid values:

  • no_backup: Purchase one SAG device to connect to Alibaba Cloud.
  • cold_backup: Purchase two SAG devices. When the active device fails, the system switches to the standby device. The two devices share a bandwidth.
HardWareSpec String Yes sag-100wm

The type of the SAG device. Valid values: sag-100wm | sag-1000

MaxBandWidth Integer Yes 12

The bandwidth of the SAG instance.

  • Value range for an SAG-100WM device: 2 to 50. Unit: Mbit/s
  • Value range for an SAG-1000 device: 10 to 500. Unit: Mbit/s
Period Integer Yes 12

The validity period of the subscription. Unit: month If the value exceeds 12, it must be a multiple of 12.

ReceiverAddress String Yes Room XX, XX Building

The information of room and building in the delivery address to receive the purchased SAG device.

ReceiverCity String Yes Long Beach

The city of the delivery address.

ReceiverCountry String Yes US

The country of the delivery address.

ReceiverDistrict String Yes Queen District

The district of the delivery address.

ReceiverEmail String Yes xx@example.com

The email address of the person to receive the SAG device.

ReceiverMobile String Yes 13*********

The mobile phone number of the person to receive the SAG device.

ReceiverName String Yes Tony

The name of the person to receive the SAG device.

ReceiverState String Yes California

The state of the delivery address.

ReceiverTown String Yes Fairy Town

The town of the delivery address.

ReceiverZip String Yes 310000

The postal code of the delivery address.

RegionId String Yes US (Virginia)

The ID of region to which the SAG instance belongs. To query the region ID, call DescribeRegions.

Action String No CreateSmartAccessGateway

The name of this action.

Value: CreateSmartAccessGateway

Description String No sag

The description of the SAG instance.

Name String No test

The name of the SAG instance.

ReceiverPhone String No 13*********

The fixed-line phone number of the person to receive the SAG device.

Response parameters

Parameter Type Example value Description
Description String sag

The description of the SAG instance.

Name String sag-1

The name of the SAG instance.

OrderId String 203377778550296

The ID of the order.

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

The ID of the request.

SmartAGId String sag-nylv14tghsk26c*****

The ID of the SAG instance.

Examples

Request example


http(s)://[Endpoint]/? Action=CreateSmartAccessGateway
&AutoPay=true
&BuyerMessage=pls. deliver asap
&ChargeType=PREPAY
&HardWareSpec=sag-100wm
&HaType=no_backup
&MaxBandWidth=12
&Period=12
&ReceiverAddress=Room XX, XX Building
&ReceiverCity=Long Beach
&ReceiverCountry=US
&ReceiverDistrict=Queen District
&ReceiverEmail=xx@example.com
&ReceiverMobile=13*********
&ReceiverName=Tony
&ReceiverState=California
&ReceiverTown=Fairy Town
&ReceiverZip=310000
&RegionId=us-east-1
&<CommonParameters>

Response example

XML format

<CreateSmartAccessGatewayResponse>
    <SmartAGId>sag-nylv14tghsk26cp41n</SmartAGId>
    <RequestId>A6B9EB0F-57DB-4843-A372-04678ABF490E</RequestId>
    <OrderId>203377778550296</OrderId>
</CreateSmartAccessGatewayResponse>

JSON format

{
	"SmartAGId":"sag-nylv14tghsk26cp41n",
	"RequestId":"A6B9EB0F-57DB-4843-A372-04678ABF490E",
	"OrderId":203377778550296
}

Errors

For a list of error codes, visit the API Error Center.