Creates a Smart Access Gateway (SAG) CPE or vCPE instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String No CreateSmartAccessGateway

The operation that you want to perform. Set the value to CreateSmartAccessGateway.

RegionId String Yes cn-shanghai

The ID of the region where you want to deploy the SAG instance.

You can call the DescribeRegions operation to query the most recent region list.

MaxBandWidth Integer Yes 12

The bandwidth of the SAG instance.

  • If you want to create an SAG CPE instance and the model is sag-100wm, valid values of this parameter are 2 to 50. Unit: Mbit/s.
  • If you want to create an SAG CPE instance and the model is sag-1000, valid values of this parameter are 10 to 500. Unit: Mbit/s.
  • If you want to create an SAG vCPE instance, valid values of this parameter are 10 to 1000. Unit: Mbit/s.
Name String No testname

The name of the SAG instance.

The name must be 2 to 128 characters in length and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

Description String No testdesc

The description of the SAG instance.

The description must be 2 to 256 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

Period Integer Yes 12

The subscription period of the SAG instance. Unit: months.

Valid values: 1 to 9, 12, 24, and 36.

AutoPay Boolean Yes false

Specifies whether to enable auto-payment for the instance. Valid values:

  • true: yes
  • false: no

If you set the parameter to false, go to Billing Management to complete the payment after you call this operation. After you complete the payment, the instance can be created.

HardWareSpec String Yes sag-100wm

The type of the SAG instance. Valid values:

  • sag-100wm
  • sag-1000
  • sag-vcpe
ReceiverCountry String Yes China

The country of the recipient address.

ReceiverState String Yes Zhejiang

The province of the recipient address.

ReceiverCity String Yes Hangzhou

The city of the recipient address.

ReceiverDistrict String Yes West Lake

The district of the recipient address.

ReceiverTown String Yes Zhuan Tang

The town of the recipient address.

ReceiverZip String Yes 310000

The postcode of the recipient address.

ReceiverPhone String No 8585****

The landline phone number of the recipient.

ReceiverMobile String Yes 1884085****

The mobile phone number of the recipient.

ReceiverName String Yes Alice

The name of the recipient.

ReceiverEmail String Yes xx@example.com

The email address of the recipient.

BuyerMessage String Yes Remarks

The remarks left by the buyer.

ReceiverAddress String Yes No.XX

The detailed address of the recipient.

HaType String Yes no_backup

The deployment mode. Valid values:

  • no_backup: You buy only one SAG device to connect private networks to Alibaba Cloud.
  • cold_backup: You buy two SAG devices in active-standby mode. One SAG device serves as an active device and the other serves as a standby device. Only the active device is connected to Alibaba Cloud. If the active device is not working as expected, you must manually perform a switchover.
  • warm_backup: You buy two SAG devices in active-active mode. Both SAG devices are connected to Alibaba Cloud. If an active device is not working as expected, a failover is automatically performed.
Note If you want to create an SAG vCPE instance, set the value to warm_backup.
ChargeType String Yes PREPAY

The billing method of the SAG instance.

Set the value to PREPAY, which specifies the subscription billing method.

AlreadyHaveSag Boolean No false

Specifies whether you already have an SAG device. Valid values:

  • true: yes
  • false (default): no
CPEVersion String No basic

The edition of SAG when you create an SAG vCPE instance.

Set the value to basic, which specifies Basic Edition.

Response parameters

Parameter Type Example Description
Description String testdesc

The description of the SAG instance.

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

The ID of the request.

OrderId String 20337777****

The ID of the order.

SmartAGId String sag-nylv14tghsk26c*****

The ID of the SAG instance.

Name String testname

The name of the SAG instance.

ResourceGroupId String rg-acfm2iu4fnc****

The ID of the resource group to which the SAG instance belongs.

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateSmartAccessGateway
&RegionId=cn-shanghai
&MaxBandWidth=12
&Name=testname
&Description=testdesc
&Period=12
&AutoPay=false
&HardWareSpec=sag-100wm
&ReceiverCountry=China
&ReceiverState=Zhejiang
&ReceiverCity=Hangzhou
&ReceiverDistrict=West Lake
&ReceiverTown=Zhuan Tang
&ReceiverZip=310000
&ReceiverPhone=8585****
&ReceiverMobile=1884085****
&ReceiverName=Alice
&ReceiverEmail=xx@example.com
&BuyerMessage=Remarks
&ReceiverAddress=No.XX
&HaType=no_backup
&ChargeType=PREPAY
&AlreadyHaveSag=false
&CPEVersion=basic
&Common request parameters

Sample responses

XML format

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 format

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

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

Error codes

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