All Products
Search
Document Center

Smart Access Gateway:CreateSmartAccessGatewaySoftware

Last Updated:Mar 29, 2024

Creates a Smart Access Gateway (SAG) app instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-shanghai
PeriodintegerYes

The subscription duration of the SAG app instance. Unit: months.

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

12
AutoPaybooleanYes

Specifies whether to automatically complete the payment of the order. Valid values:

  • true: yes
  • false (default): no

If you set the parameter to false, go to Billing Management to complete the payment after you call this operation. The instance is created only after you complete the payment.

false
ChargeTypestringYes

The billing method of the SAG app instance. Set the value to PREPAY. This value indicates that the SAG app instance is a subscription resource.

PREPAY
UserCountintegerYes

The maximum number of client accounts that can be created on the SAG app instance.

5
DataPlanlongYes

The size of the free data plan that is allocated to each client account per month. Unit: GB. Valid value: 5.

Note This value specifies that a free data plan of 5 GB is allocated to each client account per month.
5

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

24675405-74DF-4C94-82C6-B749580C498E
OrderIdstring

The ID of the order that you placed to purchase the SAG app instance.

203000000000000
SmartAGIdstring

The ID of the SAG app instance.

sag-gnhe6sywtare5******
ResourceGroupIdstring

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

rg-acfm2iu4fnc****

Examples

Sample success responses

JSONformat

{
  "RequestId": "24675405-74DF-4C94-82C6-B749580C498E",
  "OrderId": "203000000000000",
  "SmartAGId": "sag-gnhe6sywtare5******",
  "ResourceGroupId": "rg-acfm2iu4fnc****"
}

Error codes

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