Modifies the high availability (HA) 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:ModifySagHa | Write |
|
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The region ID of the SAG instance. | cn-shanghai |
SmartAGId | string | Yes | The SAG instance ID. | sag-whfn**** |
SmartAGSn | string | Yes | The serial number of the SAG device associated with the SAG instance. | sag32a30**** |
Mode | string | Yes | The HA mode. Valid values:
| NONE |
PortName | string | Yes | The port name. Note
If Mode is set to STATIC, you must specify a port name.
| 5 |
VirtualIp | string | No | The virtual IP address. Note
If Mode is set to STATIC, you must specify a virtual IP address.
| 192.XX.XX.5 |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "3200E8A3-563F-4FFC-8BDB-0F1263FA69E8"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | Sag.HaPortExist | The specified port is used by the HA configuration. | The specified port is used as an HA port. |
400 | Sag.HaPortRoleError | The specified port does not support HA configuration. | The specified port role does not support HA. |
400 | Sag.HaTypeNotAllow | The specified device does not support the configuration of the specified type. | - |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|
No change history