You can call this operation to modify the Wi-Fi settings of a Smart Access Gateway (SAG) device.
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 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.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
smartag:ModifySagWifi | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region where the SAG instance is deployed. | cn-shanghai |
SmartAGId | string | Yes | The ID of the SAG instance. | sag-whfn**** |
SmartAGSn | string | Yes | The serial number of the SAG device. | sag32a30**** |
IsEnable | string | Yes | Specifies whether Wi-Fi is enabled. Valid values:
| True |
SSID | string | Yes | The service set identifier (SSID) of the Wi-Fi network. The name must be 1 to 31 characters in length, and can contain digits and letters. | aliyun_sag_123456**** |
IsBroadcast | string | No | Specifies whether broadcast over Wi-Fi is enabled. Valid values:
Note
Only after you enable broadcast, terminals that support wireless connections can search the Wi-Fi network by its SSID and receive Wi-Fi signals.
| True |
Channel | string | No | The Wi-Fi channel. Valid values: 0 to 11. | 0 |
Bandwidth | string | No | The bandwidth of the channel. Valid values:
| 20 MHz |
IsAuth | string | No | Specifies whether wireless security is enabled. Valid values:
| True |
AuthenticationType | string | No | The authentication type. Valid values:
| WPA2-PSK |
EncryptAlgorithm | string | No | The encryption algorithm. Valid values:
| AUTO |
Password | string | No | The password used to connect to the Wi-Fi network. The password must be 8 to 32 characters in length, and can contain digits and letters. | 12345678 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "1120228A-E5E1-4E9C-B56D-96887E1A2B2F"
}
Error codes
HTTP status code | Error code | Error message |
---|---|---|
400 | InvalidId.SMARTAG | The specified smart access gateway instance ID does not exist. |
For a list of error codes, visit the Service error codes.