All Products
Search
Document Center

Smart Access Gateway:DescribeSmartAccessGatewayHa

Last Updated:Mar 03, 2024

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
SmartAGIdstringYes

The ID of the SAG instance.

sag-pno62188piyc6txxxxx
RegionIdstringYes

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

cn-shanghai

Response parameters

ParameterTypeDescriptionExample
object
DeviceLevelBackupStatestring

Indicates whether device-based HA is enabled. Valid values:

  • ON: enabled
  • OFF: disabled
OFF
RequestIdstring

The ID of the request.

582FE511-FEFE-42BC-BBF4-4F8ECF92Exxx
BackupDeviceIdstring

The serial number of the standby SAG device.

sag11axxxx
LinkBackupInfoListobject []

The information about standby connections.

MainLinkIdstring

The ID of the active connection.

lte
BackupLinkStatestring

The status of the standby connection. Valid values:

  • up: available
  • down: unavailable
down
LinkLevelBackupStatestring

Indicates whether HA is enabled to provide standby connections. Valid values:

  • ON: enabled
  • OFF: disabled
ON
BackupLinkIdstring

The ID of the standby connection.

wan1
MainLinkStatestring

The status of the active connection. Valid values:

  • up: available
  • down: unavailable
up
LinkLevelBackupTypestring

The HA mode. Valid values:

  • DedicatedLineBackupMode: Express Connect circuit and SAG.
  • StandbyMode: active and standby WAN ports.
  • Off: HA is disabled.
StandbyMode
SmartAGIdstring

The ID of the SAG instance.

sag-i8mogwi9kisigc3xxxx
DeviceLevelBackupTypestring

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
MainDeviceIdstring

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.