All Products
Search
Document Center

Smart Access Gateway:DescribeSagWanList

Last Updated:Mar 03, 2024

Queries the WAN port settings of a Smart Access Gateway (SAG) device.

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:DescribeSagWanListList
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

You can call the DescribeRegions operation to query the most recent region list.

cn-shanghai
SmartAGIdstringYes

The ID of the SAG instance.

sag-whfn****
SmartAGSnstringYes

The serial number of the SAG device.

sag32a30****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

CE6642D4-21EB-4168-9BF9-F217953F9892
Wansobject []

The settings of the WAN port.

Weightinteger

The weight of the WAN port.

100
Maskstring

The subnet mask of the WAN port IP address.

255.255.255.240
Gatewaystring

The IP address of the gateway.

192.XX.XX.1
PortNamestring

The number of the WAN port.

1
IPTypestring

The connection type of the WAN port. Valid values:

  • DHCP: The WAN port connects to the Internet through an IP address that is dynamically assigned by the Dynamic Host Configuration Protocol (DHCP) server.
  • STATIC: The WAN port connects to the Internet through a static IP address.
  • PPPOE: The WAN port connects to the Internet through dial-up connections.
STATIC
Priorityinteger

The priority of the WAN port.

Valid values: -1 and 1 to 50. A smaller number represents a higher priority.

Note A value of -1 indicates that the WAN port is not used to forward network traffic.
1
BandWidthinteger

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

50
TrafficStatestring

The status of data transfer on the WAN port. Valid values:

  • active: The WAN port is the active port for data transfer.
  • standby: The WAN port is a standby port. If the active port is down, data transfer is switched to the WAN port.
active
IPstring

The IP address of the WAN port.

172.XX.XX.1
ISPstring

The Internet service provider (ISP) used by the WAN port.

  • CT: China Telecom
  • CM: China Mobile
  • CU: China Unicom
  • Other: Other ISPs
CT
Usernamestring

The username of the PPPoE account.

Usernamexx
TaskStatesobject []

The status of and information about the query task.

ErrorMessagestring

The error message returned to the query task. A value of Successful indicates that the query task is successful.

Successful
Statestring

The status of the query task. Valid values:

  • Initialized: The query task is initialized.
  • Offline: The SAG device is disconnected from Alibaba Cloud and Alibaba Cloud has not assigned the query task to the SAG device. After the SAG device is connected to Alibaba Cloud, Alibaba Cloud assigns the query task to the SAG device.
  • Succeed: Alibaba Cloud has assigned the query task to the SAG device.
  • Processing: Alibaba Cloud is assigning the query task to the SAG device.
  • VersionNotSupport: The query task is not supported by the current version of the SAG device.
  • BuildRequestError: The query task is not supported by the controller of the SAG device.
  • HardwareError: Alibaba Cloud failed to assign the query task to the SAG device because the SAG device is faulty.
  • TaskNotExist: The query task does not exist.
  • OfflineNotConfiged: The SAG device is disconnected from Alibaba Cloud and Alibaba Cloud has not assigned the query task to the SAG device. Alibaba Cloud does not assign the query task to the SAG device even after the SAG device is connected to Alibaba Cloud.
Succeed
ErrorCodestring

The error code returned to the query task. A value of 200 indicates that the query task is successful.

200
CreateTimestring

The time when the query task was created.

1586834861000

Examples

Sample success responses

JSONformat

{
  "RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892",
  "Wans": [
    {
      "Weight": 100,
      "Mask": "255.255.255.240",
      "Gateway": "192.XX.XX.1",
      "PortName": "1",
      "IPType": "STATIC",
      "Priority": 1,
      "BandWidth": 50,
      "TrafficState": "active",
      "IP": "172.XX.XX.1",
      "ISP": "CT",
      "Username": "Usernamexx"
    }
  ],
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586834861000"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
400SAG.SoftwareNotSupportThe specified SAG software edition instance does not support ACL.The specified SAG software edition instance does not support ACL.
400InstanceNotExitThe specified instance does not exist.The specified instance does not exist.
400ConfigUnsynchronizedThe network configuration is not synchronized.Network settings are not synchronized.
400Sag.PortRoleInvalidThe port role is invalid.The specified device port role is invalid.
400Sag.PortMgtErrorThe role of a management port cannot be changed.-
403SmartAccessGatewayNotOnlineThe specified smart access gateway is not online.The specified SAG device is disconnected. The operation cannot be processed.
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.
403FeatureNotSupportForActiveSmartAGThe current edition of the active smart access gateway does not support this feature.The current edition of the active SAG instance does not support this feature.
403FeatureNotSupportForStandBySmartAGThe current edition of the standby 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.
500SmartAccessGatewayOfflineThe request cannot be completed. The Smart Access Gateway is offline.The SAG device is disconnected. The request cannot be processed.

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