CreateSmartAccessGateway - Smart Access Gateway - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:CreateSmartAccessGateway	Write	SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	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.	cn-shanghai
MaxBandWidth	integer	Yes	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.	12
Name	string	No	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.	testname
Description	string	No	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.	testdesc
Period	integer	Yes	The subscription period of the SAG instance. Unit: months. Valid values: 1 to 9, 12, 24, and 36.	12
AutoPay	boolean	Yes	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.	false
HardWareSpec	string	Yes	The type of the SAG instance. Valid values: sag-100wm sag-1000 sag-vcpe	sag-100wm
ReceiverCountry	string	Yes	The country of the recipient address.	China
ReceiverState	string	Yes	The province of the recipient address.	Zhejiang
ReceiverCity	string	Yes	The city of the recipient address.	Hangzhou
ReceiverDistrict	string	Yes	The district of the recipient address.	West Lake
ReceiverTown	string	Yes	The town of the recipient address.	Zhuan Tang
ReceiverZip	string	Yes	The postcode of the recipient address.	310000
ReceiverPhone	string	No	The landline phone number of the recipient.	8585****
ReceiverMobile	string	Yes	The mobile phone number of the recipient.	1884085****
ReceiverName	string	Yes	The name of the recipient.	Alice
ReceiverEmail	string	Yes	The email address of the recipient.	xx@example.com
BuyerMessage	string	Yes	The remarks left by the buyer.	Remarks
ReceiverAddress	string	Yes	The detailed address of the recipient.	No.XX
HaType	string	Yes	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.	no_backup
ChargeType	string	Yes	The billing method of the SAG instance. Set the value to PREPAY, which specifies the subscription billing method.	PREPAY
AlreadyHaveSag	boolean	No	Specifies whether you already have an SAG device. Valid values: true: yes false (default): no	false
CPEVersion	string	No	The edition of SAG when you create an SAG vCPE instance. Set the value to basic, which specifies Basic Edition.	basic

Response parameters

Parameter	Type	Description	Example
	object
Description	string	The description of the SAG instance.	testdesc
RequestId	string	The ID of the request.	A6B9EB0F-57DB-4843-A372-04678ABF490E
OrderId	string	The ID of the order.	20337777****
SmartAGId	string	The ID of the SAG instance.	sag-nylv14tghsk26c*****
Name	string	The name of the SAG instance.	testname
ResourceGroupId	string	The ID of the resource group to which the SAG instance belongs.	rg-acfm2iu4fnc****

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.