DescribeSmartAccessGatewayHa - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries the high availability (HA) settings of a Smart Access Gateway (SAG) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:DescribeSmartAccessGatewayHa	Read	SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
SmartAGId	string	Yes	The ID of the SAG instance.	sag-pno62188piyc6txxxxx
RegionId	string	Yes	The ID of the region where the SAG instance is deployed.	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object
DeviceLevelBackupState	string	Indicates whether device-based HA is enabled. Valid values: ON: enabled OFF: disabled	OFF
RequestId	string	The ID of the request.	582FE511-FEFE-42BC-BBF4-4F8ECF92Exxx
BackupDeviceId	string	The serial number of the standby SAG device.	sag11axxxx
LinkBackupInfoList	object []	The information about standby connections.
MainLinkId	string	The ID of the active connection.	lte
BackupLinkState	string	The status of the standby connection. Valid values: up: available down: unavailable	down
LinkLevelBackupState	string	Indicates whether HA is enabled to provide standby connections. Valid values: ON: enabled OFF: disabled	ON
BackupLinkId	string	The ID of the standby connection.	wan1
MainLinkState	string	The status of the active connection. Valid values: up: available down: unavailable	up
LinkLevelBackupType	string	The HA mode. Valid values: DedicatedLineBackupMode: Express Connect circuit and SAG. StandbyMode: active and standby WAN ports. Off: HA is disabled.	StandbyMode
SmartAGId	string	The ID of the SAG instance.	sag-i8mogwi9kisigc3xxxx
DeviceLevelBackupType	string	The deployment mode of the SAG devices that have HA enabled. Valid values: warm_backup: active-active mode. cold_backup: active-standby mode. no_backup: HA is disabled.	cold_backup
MainDeviceId	string	The serial number of the active SAG device.	sag11axxxx

Examples

Sample success responses

JSONformat

{
  "DeviceLevelBackupState": "OFF",
  "RequestId": "582FE511-FEFE-42BC-BBF4-4F8ECF92Exxx",
  "BackupDeviceId": "sag11axxxx",
  "LinkBackupInfoList": {
    "LinkBackupInfoList": [
      {
        "MainLinkId": "lte",
        "BackupLinkState": "down",
        "LinkLevelBackupState": "ON",
        "BackupLinkId": "wan1",
        "MainLinkState": "up",
        "LinkLevelBackupType": "StandbyMode"
      }
    ]
  },
  "SmartAGId": "sag-i8mogwi9kisigc3xxxx",
  "DeviceLevelBackupType": "cold_backup",
  "MainDeviceId": "sag11axxxx"
}

Error codes

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