Use ModifySmartAccessGateway to modify a Smart Access Gateway instance - Smart Access Gateway

Modifies the configuration of a Smart Access Gateway (SAG) instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:ModifySmartAccessGateway

update

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

Parameter	Type	Required	Description	Example
SmartAGId	string	Yes	The ID of the SAG instance.	sag-0ovhf732a9j0******
Name	string	No	The name of the SAG instance. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.	SAG
Description	string	No	The description of the SAG instance. The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.	SAG description
CidrBlock	string	No	The CIDR blocks of terminals in the private network. Make sure that the CIDR blocks do not overlap with each other. If the LAN ports of the terminals use dynamic routing, the IP addresses within the first private CIDR block are allocated to the terminals that have Dynamic Host Configuration Protocol (DHCP) enabled.	172.16.0.0/24
RegionId	string	Yes	The ID of the region where the SAG instance is deployed.	cn-hangzhou
SecurityLockThreshold	integer	No	The time during which the disconnected SAG instance remains locked. Valid values: an integer that is greater than or equal to 0. Unit: seconds.	3
RoutingStrategy	string	No	The policy that is used to advertise routes to Alibaba Cloud. Valid values: static: static routing dynamic: dynamic routing	static
Position	string	No	The location where the SAG instance is deployed.	[ { "adcode":"", "label":"No. xx, xx Road, xx District, Hangzhou, Zhejiang", "value":"B0FFGxxxx", "center":"120.190xxxx, 30.182xxxx", "_new":"true" } ]
EnableSoftwareConnectionAudit	boolean	No	Specifies whether to audit the network connection logs of the SAS app instance. true: yes false: no	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	CE6642D4-21EB-4168-9BF9-F217953F9892

Examples

Success response

JSON format

{
  "RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	SAG.IpCountTooLittle	The number of available IP addresses of the CIDR block is fewer than the number of SslConnectionSpec.	The number of connections has exceeded the number of available IP addresses in the CIDR block.
400	SAG.SslConnectionSpecInvalid	The number of SslConnectionSpec is invalid.	The number of SslConnectionSpec is invalid.
400	SAG.CcnCidrNoConfig	You must configure the CIDR block of CCN.	You must configure the CIDR block of CCN.
400	SAG.CidrEmpty	You must specify the CIDR blocks of SAG.	You must specify the CIDR blocks of SAG.
400	SAG.ConflictCidr.CcnSnatCidr	The SAG CIDR block is in conflict with the CCN CIDR block.	The SAG CIDR block is in conflict with the CCN CIDR block.
400	SAG.ConflictSnatIp	The specified SNAT IP address is invalid.	The specified SNAT IP address is invalid.
400	SAG.InstanceIdEmpty	You must specify the SAG instance ID.	You must specify the SAG instance ID.
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.
400	SAG.InvalidCidr	The specified CIDR block is invalid.	The specified CIDR block is invalid.
400	SAG.InvalidCidr.NoBelongCcnCidr	The specified SAG CIDR block does not belong to the CCN CIDR block.	The specified SAG CIDR block does not belong to the CCN CIDR block.
400	SAG.InvalidSnatCidr	The specified SNAT CIDR block is invalid.	The specified SNAT CIDR block is invalid.
400	SAG.InvalidSnatIp	The specified SNAT IP address is invalid.	The specified SNAT IP address is invalid.
400	CCN.CidrEmpty	You must specify the CCN CIDR block.	You must specify the CCN CIDR block.
400	CCN.SnatCidrConflict	The specified SNAT CIDR block is invalid.	The specified SNAT CIDR block is invalid.
400	ActionNotSupport	The specified instance does not support this action.	The specified instance does not support this action.
400	CCN.SnatCidrNoConfig	You must configure the SNAT CIDR block of the CCN.	You must configure the SNAT CIDR block of the CCN.
400	SAG.CidrUsedByRoutableAddress	A routable internal IP address belongs to the specified internal CIDR block. You cannot modify this CIDR block.	A routable internal IP address belongs to the specified internal CIDR block. You cannot modify this CIDR block.
400	InvalidName	The specified name is invalid.	The specified name is invalid.
400	SAG.CidrAmountLimit	The maximum number of static routes for the SAG instance is exceeded.	The maximum number of static routes for the SAG instance is exceeded.
400	SAG.InvalidCidrFormat	The specified CIDR format is invalid.	The specified CIDR format is invalid.
400	SAG.CidrOverlap	The specified CIDR overlaps with an existing CIDR.	The specified CIDR overlaps with an existing CIDR.
400	SAG.Arrearage	The specified SAG instance has overdue payments. Renew the instance first.	The specified SAG instance has overdue payments. Renew the instance first.
400	SAG.NoActive	The specified SAG instance has not been activated.	The specified SAG instance has not been activated.
400	SAG.NotAllowConfigCidr	You cannot specify a static CIDR block when the dynamic routing strategy is used.	You cannot specify a static CIDR block when the dynamic routing strategy is used.
500	SmartAccessGatewayInArrears	The specified Smart Access Gateway has expired.
500	SmartAccessGatewayNotActivated	The specified Smart Access Gateway has not been activated.
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
403	CidrConflict	Cidr is conflict, Please Check your input.
403	MissingParameter	The input parameter is missing, please check your input.	Missing parameters. Check whether all required parameters are set.
403	InvalidId.SMARTAG	The specified smart access gateway instance id is invalid.	The SAG instance ID is invalid.
403	InvalidCidr	Cidr is illegal, please check your input.	The specified CIDR block is invalid. Enter a correct CIDR block.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have permissions to manage the specified resource.
403	VbrConflict.ChangeSubnet	The subnet of the gateway conflicts with the VBR. Modify the subnet first.	The subnet CIDR block of the SAG instance is in conflict with the VBR. You must change the subnet CIDR block.
403	VbrConflict.CreateBackup	The subnet of the gateway conflicts with the VBR. Create a backup relationship first.	The subnet CIDR block of the SAG instance is in conflict with the VBR. You must add a leased line for backup.
403	SmartAccessGatewayNotBind	The instance has not yet been bound.	The instance is not associated with a CCN instance.
403	FeatureNotSupport	The current edition of the smart access gateway does not support this feature.	The current version of Smart Access Gateway does not support this feature.