CreateSmartAccessGatewaySoftware - Smart Access Gateway - Alibaba Cloud Documentation Center

Creates a Smart Access Gateway (SAG) app 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.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
smartag:CreateSmartAccessGatewaySoftware	create	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where you want to create the SAG app instance.	cn-shanghai
Period	integer	Yes	The subscription duration of the SAG app instance. Unit: months. Valid values: 1 to 9, 12, 24, and 36.	12
AutoPay	boolean	Yes	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
ChargeType	string	Yes	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
UserCount	integer	Yes	The maximum number of client accounts that can be created on the SAG app instance.	5
DataPlan	long	Yes	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

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	24675405-74DF-4C94-82C6-B749580C498E
OrderId	string	The ID of the order that you placed to purchase the SAG app instance.	203000000000000
SmartAGId	string	The ID of the SAG app instance.	sag-gnhe6sywtare5******
ResourceGroupId	string	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.