All Products
Search
Document Center

Smart Access Gateway:ModifySagHa

Last Updated:Mar 03, 2024

Modifies the high availability (HA) 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:ModifySagHaRead
  • 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 associated with the SAG instance.

sag32a30****
ModestringYes

The HA mode. Valid values:

  • NONE: disables HA.
  • STATIC: enables static HA.
  • DYNAMIC: enables dynamic HA.
NONE
PortNamestringYes

The name of the port.

Note If you select the static HA mode, you must specify the port name.
5
VirtualIpstringNo

The virtual IP address of the SAG instance.

Note If you select the static HA mode, you must specify the virtual IP address.
192.XX.XX.5

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

3200E8A3-563F-4FFC-8BDB-0F1263FA69E8

Examples

Sample success responses

JSONformat

{
  "RequestId": "3200E8A3-563F-4FFC-8BDB-0F1263FA69E8"
}

Error codes

HTTP status codeError codeError messageDescription
400Sag.HaPortExistThe specified port is used by the HA configuration.The specified port is used as an HA port.
400Sag.HaPortRoleErrorThe specified port does not support HA configuration.The specified port role does not support HA.
400Sag.HaTypeNotAllowThe 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 timeSummary of changesOperation
No change history