All Products
Search
Document Center

Smart Access Gateway:ModifySmartAccessGateway

Last Updated:Mar 03, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:
    • The required resource types are displayed in bold characters.
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
smartag:ModifySmartAccessGatewayWrite
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SmartAGIdstringYes

The ID of the SAG instance.

sag-0ovhf732a9j0******
NamestringNo

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
DescriptionstringNo

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://.

CidrBlockstringNo

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
RegionIdstringYes

The ID of the region where the SAG instance is deployed.

cn-hangzhou
SecurityLockThresholdintegerNo

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
RoutingStrategystringNo

The policy that is used to advertise routes to Alibaba Cloud. Valid values:

  • static: static routing
  • dynamic: dynamic routing
static
PositionstringNo

The location where the SAG instance is deployed.

EnableSoftwareConnectionAuditbooleanNo

Specifies whether to audit the network connection logs of the SAS app instance.

  • true: yes
  • false: no
true

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CE6642D4-21EB-4168-9BF9-F217953F9892

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400SAG.IpCountTooLittleThe 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.
400SAG.SslConnectionSpecInvalidThe number of SslConnectionSpec is invalid.The number of SslConnectionSpec is invalid.
400SAG.CcnCidrNoConfigYou must configure the CIDR block of CCN.You must configure the CIDR block of CCN.
400SAG.CidrEmptyYou must specify the CIDR blocks of SAG.You must specify the CIDR blocks of SAG.
400SAG.ConflictCidr.CcnSnatCidrThe SAG CIDR block is in conflict with the CCN CIDR block.The SAG CIDR block is in conflict with the CCN CIDR block.
400SAG.ConflictSnatIpThe specified SNAT IP address is invalid.The specified SNAT IP address is invalid.
400SAG.InstanceIdEmptyYou must specify the SAG instance ID.You must specify the SAG instance ID.
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
400SAG.InvalidCidrThe specified CIDR block is invalid.The specified CIDR block is invalid.
400SAG.InvalidCidr.NoBelongCcnCidrThe 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.
400SAG.InvalidSnatCidrThe specified SNAT CIDR block is invalid.The specified SNAT CIDR block is invalid.
400SAG.InvalidSnatIpThe specified SNAT IP address is invalid.The specified SNAT IP address is invalid.
400CCN.CidrEmptyYou must specify the CCN CIDR block.You must specify the CCN CIDR block.
400CCN.SnatCidrConflictThe specified SNAT CIDR block is invalid.The specified SNAT CIDR block is invalid.
400ActionNotSupportThe specified instance does not support this action.The specified instance does not support this action.
400CCN.SnatCidrNoConfigYou must configure the SNAT CIDR block of the CCN.You must configure the SNAT CIDR block of the CCN.
400SAG.CidrUsedByRoutableAddressA 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.
400InvalidNameThe specified name is invalid.The specified name is invalid.
400SAG.CidrAmountLimitThe maximum number of static routes for the SAG instance is exceeded.The maximum number of static routes for the SAG instance is exceeded.
400SAG.InvalidCidrFormatThe specified CIDR format is invalid.The specified CIDR format is invalid.
400SAG.CidrOverlapThe specified CIDR overlaps with an existing CIDR.The specified CIDR overlaps with an existing CIDR.
400SAG.ArrearageThe specified SAG instance has overdue payments. Renew the instance first.The specified SAG instance has overdue payments. Renew the instance first.
400SAG.NoActiveThe specified SAG instance has not been activated.The specified SAG instance has not been activated.
400SAG.NotAllowConfigCidrYou 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.
403CidrConflictCidr is conflict, Please Check your input.-
403MissingParameterThe input parameter is missing, please check your input.Missing parameters. Check whether all required parameters are set.
403InvalidId.SMARTAGThe specified smart access gateway instance id is invalid.The SAG instance ID is invalid.
403InvalidCidrCidr is illegal, please check your input.The specified CIDR block is invalid. Enter a correct CIDR block.
403ForbiddenUser not authorized to operate on the specified resource.You do not have permissions to manage the specified resource.
403VbrConflict.ChangeSubnetThe 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.
403VbrConflict.CreateBackupThe 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.
403SmartAccessGatewayNotBindThe instance has not yet been bound.The instance is not associated with a CCN instance.
403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.
500SmartAccessGatewayInArrearsThe specified Smart Access Gateway has expired.The specified Smart Access Gateway has expired.
500SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.The specified SAG instance is inactive. You must activate the instance first.
500InternalErrorAn error occurred while processing your request.An error occurred while processing your request.

For a list of error codes, visit the Service error codes.