CreateSmartAccessGatewayClientUser - API Reference| Alibaba Cloud Documentation Center

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters


Parameter	Type	Required?	Example value	Description
Bandwidth	Long	Yes	20	The SAG APP bandwidth that the user can use. Unit: Kbit/s. Maximum value: 2000 Kbit/s
RegionId	String	Yes	cn-shanghai	The ID of the region to which the SAG instance created for the SAG APP belongs.
SmartAGId	String	Yes	sag-gnhe6sywtare5******	The ID of the SAG instance created for the SAG APP.
UserMail	String	Yes	test@example.com	The email address of the user. The administrator uses this address to send the account information for logging on to the APP to the user.
Action	String	No	CreateSmartAccessGatewayClientUser	The name of this action. Value: CreateSmartAccessGatewayClientUser
ClientIp	String	No	10.. . **	The IP address of the SAG APP. If you specify this parameter, the current account always uses the specified IP address. Note The IP address must be in the private CIDR block of the SAG client. If you do not specify this parameter, the system automatically allocates an IP address from the private CIDR block of the SAG client. In this case, each re-connection uses a different IP address.
Password	String	No	duuf**	The password used to log on to the SAG APP. Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.
UserName	String	No	doctest	The user name. User names in the same SAG APP must be unique. Both the user name and the password must be specified. If you specify the user name, the password must be specified, too.

Response parameters


Parameter	Type	Example value	Description
Bandwidth	Integer	2	The SAG APP bandwidth that the user can use.
ClientIp	String	10.*. . **	The IP address of the SAG APP.
RequestId	String	72E82F5E-66E8-4C22-BF1F-5CEB7DC132E7	The ID of the request.
UserMail	String	test@example.com	The email address of the user.
UserName	String	doc	The user name. User names in the same SAG APP must be unique.

Examples

Request example


http(s)://[Endpoint]/? Action=CreateSmartAccessGatewayClientUser
&Bandwidth=20
&RegionId=cn-shanghai
&SmartAGId=sag-gnhe6sywtare5******
&UserMail=test@example.com
&<CommonParameters>

Response example

XML format

<CreateSmartAccessGatewayClientUserResponse>
      <IsStaticIp>0</IsStaticIp>
	  <RequestId>72E82F5E-66E8-4C22-BF1F-5CEB7DC132E7</RequestId>
	  <UserMail>dd@example.com</UserMail>
	  <UserName>dd@example.com</UserName>
	  <Bandwidth>2</Bandwidth>
    </CreateSmartAccessGatewayClientUserResponse>

JSON format

{
	"IsStaticIp":0,
	"RequestId":"72E82F5E-66E8-4C22-BF1F-5CEB7DC132E7",
	"UserMail":"dd@example.com",
	"UserName":"dd@example.com",
	"Bandwidth":2
}

Error codes


HTTP status code	Error code	Error message	Description
400	ClientUser.BandwidthInvalid	The specified Bandwidth is invalid.	The specified Bandwidth is invalid.
400	ClientUser.EmailEmpty	You must specify UserEmail.	You must specify the UserEmail.
400	ClientUser.EmailInvalid	The format of the specified UserEmail is invalid.	The format of the specified UserEmail is invalid.
400	ClientUser.InvalidClientIp	The specified ClientIp is invalid.	The specified ClientIp is invalid.
400	ClientUser.IpEmpty	You must specify ClientIp.	You must specify the ClientIp.
400	ClientUser.IpInvalid	The specified ClientIp is invalid.	The specified ClientIp is invalid.
400	ClientUser.NameEmpty	You must specify UserName.	You must specify the UserName.
400	ClientUser.NameInvalid	The specified UserName is invalid.	The specified UserName is invalid.
400	ClientUser.UserExist	The specified user already exists.	The specified user already exists.
400	ClientUser.UserOverLimit	The maximum number of users is exceeded.	The number of users has exceeded the limit.
400	SAG.CidrEmpty	You must specify the CIDR blocks of SAG.	You must specify the CIDR block of the SAG client.

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