All Products
Search
Document Center

Smart Access Gateway:ModifySagWifi

Last Updated:Mar 29, 2024

You can call this operation to modify the Wi-Fi 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:ModifySagWifiWrite
  • SmartAccessGateway
    acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-shanghai
SmartAGIdstringYes

The ID of the SAG instance.

sag-whfn****
SmartAGSnstringYes

The serial number of the SAG device.

sag32a30****
IsEnablestringYes

Specifies whether Wi-Fi is enabled. Valid values:

  • true: enables Wi-Fi.
  • False: disables Wi-Fi.
True
SSIDstringYes

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****
IsBroadcaststringNo

Specifies whether broadcast over Wi-Fi is enabled. Valid values:

  • true: enables broadcast.
  • False: disables broadcast.
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
ChannelstringNo

The Wi-Fi channel.

Valid values: 0 to 11.

0
BandwidthstringNo

The bandwidth of the channel. Valid values:

  • Automatic
  • 20 MHz
  • 40 MHz
20 MHz
IsAuthstringNo

Specifies whether wireless security is enabled. Valid values:

  • true: enables wireless security.
  • False: disables wireless security.
True
AuthenticationTypestringNo

The authentication type. Valid values:

  • NONE
  • WPA-PSK
  • WPA2-PSK
WPA2-PSK
EncryptAlgorithmstringNo

The encryption algorithm. Valid values:

  • AUTO: automatically selects the encryption algorithm.
  • TKIP: uses the Temporal Key Integrity Protocol (TKIP).
  • AES: uses the Advanced Encryption Standard authorized by Wi-Fi®.
AUTO
PasswordstringNo

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

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

1120228A-E5E1-4E9C-B56D-96887E1A2B2F

Examples

Sample success responses

JSONformat

{
  "RequestId": "1120228A-E5E1-4E9C-B56D-96887E1A2B2F"
}

Error codes

HTTP status codeError codeError message
400InvalidId.SMARTAG The specified smart access gateway instance ID does not exist.

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