You can call this operation to create a Smart Access Gateway (SAG) 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.

AutoPay Boolean Yes true

Specifies whether it is an auto-renewal order generated by a subscription instance. Valid values:

  • true: Yes.
  • false: No. This is the default value.
BuyerMessage String Yes Remarks

The remarks left by the buyer.

ChargeType String Yes PREPAY

The billing method of the SAG instance. Valid values:

  • PayOnDemand: pay-as-you-go
  • PREPAY: subscription
Note Only subscription is supported.
HardWareSpec String Yes sag-100wm

The model of the SAG device. Valid values:

  • sag-100wm.
  • sag-1000.
HaType String Yes no_backup

The deployment mode. Valid values:

  • no_backup: purchase only one SAG device to connect your private network to Alibaba Cloud.
  • cold_backup: purchase two SAG devices that share the bandwidth. When an error occurs on the active device, network connections are switched to the standby device.
MaxBandWidth Integer Yes 12

The bandwidth of the SAG instance.

  • If the model of the SAG device is SAG-100WM, set the bandwidth to 2 to 50 Mbit/s.
  • If the model of the SAG device is SAG-1000, set the bandwidth to 10 to 500 Mbit/s.
Period Integer Yes 12

The subscription period. Unit: month.

The subscription period exceeds 12 months, the value must be a multiple of 12.

ReceiverAddress String Yes No.XX

The recipient address of the SAG device.

ReceiverCity String Yes Hangzhou

The city to which the recipient address belongs.

ReceiverCountry String Yes China

The country to which the recipient address belongs.

ReceiverDistrict String Yes West Lake

The community to which the recipient address belongs.

ReceiverEmail String Yes xx@example.com

The email address of the recipient.

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

The mobile phone number of the recipient.

ReceiverName String Yes Zhang San

The name of the recipient.

ReceiverState String Yes Zhejiang

The province to which the recipient address belongs.

ReceiverTown String Yes Zhuan Tang

The town to which the recipient address belongs.

ReceiverZip String Yes 310000

The zip code of the province to which the recipient address belongs.

RegionId String Yes cn-hangzhou

The ID of the region where the SAG instance is deployed.

Name String No test

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 or Chinese character.

Description String No sag

The description of the SAG instance.

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

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

The phone number of the recipient.

Response parameters

Parameter Type Example 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

Sample requests

http(s)://[Endpoint]/? Action=CreateSmartAccessGateway
&AutoPay=true
&BuyerMessage=Remarks
&ChargeType=PREPAY
&HardWareSpec=sag-100wm
&HaType=no_backup
&MaxBandWidth=12
&Period=12
&ReceiverAddress=No.XX
&ReceiverCity=Hangzhou
&ReceiverCountry=China
&ReceiverDistrict=West Lake
&ReceiverEmail=xx@example.com
&ReceiverMobile=13*********
&ReceiverName=Zhang San
&ReceiverState=Zhejiang
&ReceiverTown=Zhuan Tang
&ReceiverZip=310000
&RegionId=cn-hangzhou
&<Common request parameter>

Sample success responses

XML format

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

JSON format

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

Error codes

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