You can call this operation to query the Wi-Fi settings of a Smart Access Gateway (SAG) instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | No | DescribeSagWifi |
The operation that you want to perform. Set the value to DescribeSagWifi. |
RegionId | String | Yes | cn-shanghai |
The ID of the region where the SAG instance is deployed. |
SmartAGId | String | Yes | sag-whfn**** |
The ID of the SAG instance. |
SmartAGSn | String | Yes | sag32a30**** |
The serial number (SN) of the SAG device. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
AuthenticationType | String | WPA2-PSK |
The authentication type. Valid values:
|
Bandwidth | String | Automatic |
The bandwidth of the Wi-Fi channel. Valid values:
|
Channel | String | 0 |
The Wi-Fi channel. |
EncryptAlgorithm | String | AES |
The encryption algorithm.
|
IsAuth | String | True |
Indicates whether wireless security is enabled.
|
IsBroadcast | String | True |
Indicates whether broadcast over Wi-Fi is enabled. Valid values:
|
IsEnable | String | True |
Indicates whether wireless connections are enabled. Valid values:
|
RequestId | String | E93884AC-6C21-4FEA-8E3A-7377D33B194F |
The ID of the request. |
Ssid | String | aliyun_sag_123456*** |
The service set identifier (SSID) of the Wi-Fi network. |
TaskStates | Array |
The information about the query task. |
|
CreateTime | String | 1586843621000 |
The time when the query task was created. |
ErrorCode | String | 200 |
The error code returned for a query task. The 200 error code indicates that the query task is successful. |
ErrorMessage | String | Successful |
The error message returned for a query task. The Successful error message indicates that the query task is successful. |
State | String | Succeed |
The status of the query task. Valid values:
|
Examples
Sample requests
http(s)://smartag.cn-shanghai.aliyuncs.com/? Action=DescribeSagWifi
&RegionId=cn-shanghai
&SmartAGId=sag-whfn****
&SmartAGSn=sag32a30****
&<Common request parameters>
Sample success responses
XML
format
<DescribeSagWifiResponse>
<IsEnable>False</IsEnable>
<RequestId>C1ECD42E-B896-487B-8FCD-4A3364D00F21</RequestId>
<TaskStates>
<State>Succeed</State>
<CreateTime>1586843621000</CreateTime>
<ErrorCode>200</ErrorCode>
<ErrorMessage>Successful</ErrorMessage>
</TaskStates>
</DescribeSagWifiResponse>
JSON
format
{
"IsEnable": "False",
"RequestId": "C1ECD42E-B896-487B-8FCD-4A3364D00F21",
"TaskStates": [
{
"State": "Succeed",
"CreateTime": 1586843621000,
"ErrorCode": "200",
"ErrorMessage": "Successful"
}
]
}
Error codes
HttpCode | 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 version of the specified SAG instance does not support ACLs. |
500 | SmartAccessGatewayInArrears | The specified Smart Access Gateway has expired. | The error message returned because the specified SAG instance has expired. Renew the SAG instance first. |
500 | SmartAccessGatewayNotActivated | The specified Smart Access Gateway has not been activated. | The error message returned because the specified SAG instance has not been activated. Activate the SAG instance first. |
403 | SmartAccessGatewayNotOnline | The specified smart access gateway is not online. | The error message returned because the specified SAG device is not connected to Alibaba Cloud. |
500 | SmartAccessGatewayOffline | The request cannot be completed. The Smart Access Gateway is offline. | The error message returned because the specified SAG device is disconnected form Alibaba Cloud. |
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 settings are not synchronized between the SAG device and instance. |
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 instance 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.