All Products
Search

This Product

    Smart Access Gateway:ModifySagWan

    Document Center

    Smart Access Gateway:ModifySagWan

    Last Updated:Aug 27, 2026

    Modifies WAN port configurations of a Smart Access Gateway (SAG) device.

    Operation description

    Before you modify WAN port settings, understand WAN port functionality. Configure a WAN port.

    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:ModifySagWan

    update

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

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

    Call DescribeRegions to query available regions.

    cn-shanghai
    SmartAGId

    string

    Yes

    The ID of the SAG instance.

    sag-whfn****
    SmartAGSn

    string

    Yes

    The serial number of the SAG device.

    sag32a30****
    PortName

    string

    Yes

    The number of the WAN port.

    0
    IPType

    string

    Yes

    The connection type of the WAN port. Valid values:

    • DHCP: connects to the Internet through a dynamically assigned IP address.

    • STATIC: connects to the Internet through a static IP address. You must also set the IP, Mask, and Gateway parameters.

    • PPPOE: connects to the Internet through dial-up. You must also set the Username and Password parameters.

    DHCP
    IP

    string

    No

    The IP address of the WAN port.

    Note

    Required when IPType is set to STATIC.

    192.XX.XX.1
    Mask

    string

    No

    The subnet mask of the WAN port IP address.

    Note

    Required when IPType is set to STATIC.

    255.255.255.0
    Gateway

    string

    No

    The IP address of the gateway.

    Note

    • Required when IPType is set to STATIC.

    • Setting this parameter causes the SAG device to generate a default route.

    192.XX.XX.254
    Username

    string

    No

    The username of the PPPoE account. Must be 6 to 30 characters, containing digits and letters.

    Note

    Required when IPType is set to PPPOE.

    P12ppp***
    Password

    string

    No

    The password of the PPPoE account. Must be 6 to 30 characters, containing digits and letters.

    Note

    Required when IPType is set to PPPOE. Skip this parameter if you do not need to change the password.

    P12ppq***
    Priority

    integer

    No

    The priority of the WAN port. Valid values: -1 and 1 to 50. A smaller value indicates a higher priority. -1 disables traffic forwarding on the WAN port.

    1
    Weight

    integer

    No

    The weight of the WAN port. Valid values: 1 to 100. Default value: 100.

    100
    ISP

    string

    No

    The ISP of the WAN port. Valid values:

    • CT: China Telecom.

    • CM: China Mobile.

    • CU: China Unicom.

    • Other: other ISPs.

    CT
    Bandwidth

    integer

    No

    The maximum bandwidth of the WAN port. Unit: Mbit/s.

    50

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    AFF7E5A6-6897-4FDC-A5A8-1978B5B3E545

    Examples

    Success response

    JSON format

    {
  "RequestId": "AFF7E5A6-6897-4FDC-A5A8-1978B5B3E545"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Sag.PortNotExist The specified port does not exist. The specified port does not exist.
    400 Sag.PortRoleInvalid The port role is invalid. The specified device port role is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.