You can call this operation to create 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 No CreateSmartAccessGatewaySoftware

The operation that you want to perform.

Set the value to CreateSmartAccessGatewaySoftware.

AutoPay Boolean Yes true

Specify whether the order belongs to an auto renewal subscription instance.

Valid values: true|false

Default value: false

ChargeType String Yes PREPAY

The billing method of the instance. Valid values:

  • PayOnDemand: pay-as-you-go
  • PREPAY: subscription
Note SAG supports only subscription.
DataPlan Long Yes 5

The data transfer plan for each client account. Unit: GB.

Note The data transfer plan per account is 5 GB.
Period Integer Yes 12

The use duration of the data transfer plan under each client account. The duration of use is measured in months. If the duration of use exceeds 12 months, the value must be a multiple of 12.

RegionId String Yes cn-shanghai

The region where the SAG APP instance is deployed.

UserCount Integer Yes 5

The quota of clients that can be added to the SAG APP instance. Typically, you need to create an account for each user that needs to log on to SAG APP.

Note The quota must be a positive multiple of 5, for example, 5, 10, and 15.

Response parameters

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

The ID of the request.

SmartAGId String sag-gnhe6sywtare5******

The ID of the SAG APP instance.

OrderId String 203782300920296

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

Examples

Sample requests

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

Sample success responses

XML format

<CreateSmartAccessGatewaySoftwareResponse>
      <SmartAGId>sag-gnhe6sywtare5nt***</SmartAGId>
      <OrderId>203782300920296</OrderId>
      <RequestId>B35789C0-A570-4C2F-96D6-2B46FBB9D64A</RequestId>
    </CreateSmartAccessGatewaySoftwareResponse>

JSON format

{
    "SmartAGId": "sag-gnhe6sywtare5nt***", 
    "OrderId": 203782300920296, 
    "RequestId": "B35789C0-A570-4C2F-96D6-2B46FBB9D64A"
}

Error codes

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