Queries the SNAT settings of the WAN port 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSagWanSnat

The operation that you want to perform. Set the value to DescribeSagWanSnat.

RegionId String Yes cn-shanghai

The region ID of the SAG instance.

SmartAGId String Yes sag-whfn****

The ID of the SAG instance.

SmartAGSn String Yes sag32a30****

The serial number of the SAG device that is associated with the SAG instance.

Response parameters

Parameter Type Example Description
RequestId String CE6642D4-21EB-4168-9BF9-F217953F9892

The ID of the request.

Snat String ENABLE

Indicates whether SNAT is enabled.

  • ENABLE: SNAT is enabled.
  • DISABLE: SNAT is disabled.
TaskStates Array of TaskState

The details about the status of the query task.

ErrorMessage String Successful

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

State String Succeed

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.
ErrorCode String 200

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

CreateTime String 1586847787000

The timestamp when the task was created.

The value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

Examples

Sample requests

http(s)://smartag.cn-shanghai.aliyuncs.com/?Action=DescribeSagWanSnat
&RegionId=cn-shanghai
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSagWanSnatResponse>
<RequestId>C1DB5ADD-7AE0-4E15-8C84-7C1CE2B20693</RequestId>
<Snat>DISABLE</Snat>
<TaskStates>
    <State>Succeed</State>
    <CreateTime>1586847787000</CreateTime>
    <ErrorCode>200</ErrorCode>
    <ErrorMessage>Successful</ErrorMessage>
</TaskStates>
</DescribeSagWanSnatResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "C1DB5ADD-7AE0-4E15-8C84-7C1CE2B20693",
  "Snat" : "DISABLE",
  "TaskStates" : [ {
    "State" : "Succeed",
    "CreateTime" : 1586847787000,
    "ErrorCode" : "200",
    "ErrorMessage" : "Successful"
  } ]
}

Error codes

HTTP status code Error code Error message Description
400 SAG.InstanceNoFound The specified SAG instance does not exist. The error message returned because the specified SAG instance does not exist.
400 SAG.SoftwareNotSupport The specified SAG software edition instance does not support ACL. The error message returned because the SAG vCPE instance does not support access control lists (ACLs).
400 InstanceNotExit The specified instance does not exist. The error message returned because the specified instance does not exist.
400 ConfigUnsynchronized The network configuration is not synchronized. The error message returned because the network configurations are not synchronized.
400 SmartAccessGatewayNotActivated The specified Smart Access Gateway has not been activated. The error message returned because the specified SAG instance is not activated. Activate the SAG instance first.
400 SmartAccessGatewayOffline The request cannot be completed. The Smart Access Gateway is offline. The error message returned because the specified SAG device is disconnected from Alibaba Cloud and the system failed to process the request.
400 SmartAccessGatewayInArrears The specified Smart Access Gateway has expired. The error message returned because the specified SAG instance has expired. Renew the SAG instance.
403 SmartAccessGatewayNotOnline The specified smart access gateway is not online. The error message returned because the specified SAG device is disconnected from Alibaba Cloud and the system failed to process the request.
403 FeatureNotSupport The current edition of the smart access gateway does not support this feature. The error message returned because the current version of the specified SAG device does not support this feature.
403 FeatureNotSupportForActiveSmartAG The current edition of the active smart access gateway does not support this feature. The error message returned because the current version of the active SAG device does not support this feature.
403 FeatureNotSupportForStandBySmartAG The current edition of the standby smart access gateway does not support this feature. The error message returned because the current version of the standby SAG device does not support this feature.

For a list of error codes, visit the API Error Center.