Creates a Smart Access Gateway (SAG) CPE or vCPE instance.
Debugging
Authorization information
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The bandwidth of the SAG instance.
| cn-shanghai |
MaxBandWidth | integer | Yes | 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 |
Name | 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. | testname |
Description | string | No | The subscription period of the SAG instance. Unit: months. Valid values: 1 to 9, 12, 24, and 36. | testdesc |
Period | integer | Yes | Specifies whether to enable auto-payment for the instance. Valid values:
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 |
AutoPay | boolean | Yes | The type of the SAG instance. Valid values:
| false |
HardWareSpec | string | Yes | The country of the recipient address. | sag-100wm |
ReceiverCountry | string | Yes | The province of the recipient address. | |
ReceiverState | string | Yes | The city of the recipient address. | |
ReceiverCity | string | Yes | The district of the recipient address. | |
ReceiverDistrict | string | Yes | The town of the recipient address. | |
ReceiverTown | string | Yes | The postcode of the recipient address. | |
ReceiverZip | string | Yes | The landline phone number of the recipient. | 310000 |
ReceiverPhone | string | No | The mobile phone number of the recipient. | 8585**** |
ReceiverMobile | string | Yes | The name of the recipient. | 1884085**** |
ReceiverName | string | Yes | The email address of the recipient. | |
ReceiverEmail | string | Yes | The remarks left by the buyer. | xx@example.com |
BuyerMessage | string | Yes | The detailed address of the recipient. | |
ReceiverAddress | string | Yes | The deployment mode. Valid values:
Note
If you want to create an SAG vCPE instance, set the value to warm_backup.
| |
HaType | string | Yes | The billing method of the SAG instance. Set the value to PREPAY, which specifies the subscription billing method. | no_backup |
ChargeType | string | Yes | Specifies whether you already have an SAG device. Valid values:
| PREPAY |
AlreadyHaveSag | boolean | No | The edition of SAG when you create an SAG vCPE instance. Set the value to basic, which specifies Basic Edition. | false |
CPEVersion | string | No | The description of the SAG instance. | basic |
Response parameters
Examples
Sample success responses
JSON
format
{
"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.