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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateSmartAccessGatewaySoftware

The operation that you want to perform. Set the value to CreateSmartAccessGatewaySoftware.

RegionId String Yes cn-shanghai

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

Period Integer Yes 12

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

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

AutoPay Boolean Yes false

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.

ChargeType String Yes PREPAY

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.

UserCount Integer Yes 5

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

DataPlan Long Yes 5

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.

Response parameters

Parameter Type Example Description
RequestId String 24675405-74DF-4C94-82C6-B749580C498E

The ID of the request.

OrderId String 203000000000000

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

SmartAGId String sag-gnhe6sywtare5******

The ID of the SAG app instance.

ResourceGroupId String rg-acfm2iu4fnc****

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

Examples

Sample requests

http(s)://[Endpoint]/?Action=CreateSmartAccessGatewaySoftware
&RegionId=cn-shanghai
&Period=12
&AutoPay=true
&ChargeType=PREPAY
&UserCount=5
&DataPlan=5
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateSmartAccessGatewaySoftwareResponse>
    <RequestId>24675405-74DF-4C94-82C6-B749580C498E</RequestId>
    <OrderId>203000000000000</OrderId>
    <SmartAGId>sag-gnhe6sywtare5******</SmartAGId>
    <ResourceGroupId>rg-acfm2iu4fnc****</ResourceGroupId>
</CreateSmartAccessGatewaySoftwareResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

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