Modifies the configuration of a Smart Access Gateway (SAG) instance.
Debugging
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 Resourcesis 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:ModifySmartAccessGateway | Write |
|
| 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 | |
| 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 |
| Position | string | No | The location where the SAG instance is deployed. | |
| EnableSoftwareConnectionAudit | boolean | No | Specifies whether to audit the network connection logs of the SAS app instance.
| true |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892"
}Error codes
| 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. |
| 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. |
| 500 | SmartAccessGatewayInArrears | The specified Smart Access Gateway has expired. | The specified Smart Access Gateway has expired. |
| 500 | SmartAccessGatewayNotActivated | The specified Smart Access Gateway has not been activated. | The specified SAG instance is inactive. You must activate the instance first. |
| 500 | InternalError | An error occurred while processing your request. | An error occurred while processing your request. |
For a list of error codes, visit the Service error codes.