All Products
Search
Document Center

Smart Access Gateway:CreateSmartAccessGateway

Last Updated:Aug 18, 2023

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

debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

debugging

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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:CreateSmartAccessGatewayWrite
  • Smartag
    acs:smartag:{#regionId}:{#accountId}:smartag/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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.
cn-shanghai
MaxBandWidthintegerYes

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.

12
NamestringNo

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.

testname
DescriptionstringNo

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

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

testdesc
PeriodintegerYes

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.

12
AutoPaybooleanYes

The type of the SAG instance. Valid values:

  • sag-100wm
  • sag-1000
  • sag-vcpe
false
HardWareSpecstringYes

The country of the recipient address.

sag-100wm
ReceiverCountrystringYes

The province of the recipient address.

ReceiverStatestringYes

The city of the recipient address.

ReceiverCitystringYes

The district of the recipient address.

ReceiverDistrictstringYes

The town of the recipient address.

ReceiverTownstringYes

The postcode of the recipient address.

ReceiverZipstringYes

The landline phone number of the recipient.

310000
ReceiverPhonestringNo

The mobile phone number of the recipient.

8585****
ReceiverMobilestringYes

The name of the recipient.

1884085****
ReceiverNamestringYes

The email address of the recipient.

ReceiverEmailstringYes

The remarks left by the buyer.

xx@example.com
BuyerMessagestringYes

The detailed address of the recipient.

ReceiverAddressstringYes

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.
HaTypestringYes

The billing method of the SAG instance.

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

no_backup
ChargeTypestringYes

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

  • true: yes
  • false (default): no
PREPAY
AlreadyHaveSagbooleanNo

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

Set the value to basic, which specifies Basic Edition.

false
CPEVersionstringNo

The description of the SAG instance.

basic

Response parameters

ParameterTypeDescriptionExample
object
Descriptionstring

The ID of the request.

testdesc
RequestIdstring

The ID of the order.

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

The ID of the SAG instance.

20337777****
SmartAGIdstring

The name of the SAG instance.

sag-nylv14tghsk26c*****
Namestring

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

testname

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.