Queries the high-availability configurations of a Smart Access Gateway (SAG) instance.

Debug

Use OpenAPI Explorer to perform debug operations and generate SDK code examples.

Request parameters

Parameter Type Required? Example value Description 
RegionId String Yes cn-shanghai

The ID of the region to which the SAG instance belongs.
SmartAGId String Yes sag-pno62188piyc6txxxxx

The ID of the SAG instance to query.
Action String No DescribeSmartAccessGatewayHa

The name of this action. Value: DescribeSmartAccessGatewayHa

Response parameters

Parameter Type Example value Description
BackupDeviceId String sag11axxxx

The serial number of the standby device.
DeviceLevelBackupState String OFF

The device-level backup state. Valid values: OFF | ON
DeviceLevelBackupType String ColdStandbyMode

The type of the device-level high availability:

  • ColdStandbyMode: cold standby
  • HotStandbyMode: hot standby
  • NoBackupMode: no backup device
LinkBackupInfoList

The details of the backup link.
BackupLinkId String wan1

The ID of the backup connection.
BackupLinkState String down

The status of the backup connection.
LinkLevelBackupState String ON

The connection-level backup state.
LinkLevelBackupType String StandbyMode

The connection-level backup type.
MainLinkId String lte

The ID of the active connection.
MainLinkState String up

The state of the active connection.
MainDeviceId String sag11axxxx

The serial number of the active device.
RequestId String 582FE511-FEFE-42BC-BBF4-4F8ECF92Exxx

The ID of the request.
SmartAGId String sag-i8mogwi9kisigc3xxxx

The ID of the SAG instance.

Examples

Request example


http(s)://[Endpoint]/? Action=DescribeSmartAccessGatewayHa
&RegionId=cn-hangzhou
&SmartAGId=sag-pno62188piyc6txxxxx
&<CommonParameters>

Response example

XML format 

<DescribeSmartAccessGatewayHaResponse>
	  <SmartAGId>sag-i8mogwi9kisigcxxxx</SmartAGId>
	  <DeviceLevelBackupState>OFF</DeviceLevelBackupState>
	  <LinkBackupInfoList>
		    <LinkBackupInfoList>
			      <LinkLevelBackupType>StandbyMode</LinkLevelBackupType>
			      <MainLinkId>lte</MainLinkId>
			      <BackupLinkState>down</BackupLinkState>
			      <LinkLevelBackupState>ON</LinkLevelBackupState>
			      <BackupLinkId>wan1</BackupLinkId>
			      <MainLinkState>up</MainLinkState>
		    </LinkBackupInfoList>
	  </LinkBackupInfoList>
	  <RequestId>582FE511-FEFE-42BC-BBF4-4F8ECF92E3C6</RequestId>
</DescribeSmartAccessGatewayHaResponse>

JSON format 

{
	"SmartAGId":"sag-i8mogwi9kisigcxxxx",
	"DeviceLevelBackupState":"OFF",
	"LinkBackupInfoList":{
		"LinkBackupInfoList":[
			{
				"LinkLevelBackupType":"StandbyMode",
				"MainLinkId":"lte",
				"LinkLevelBackupState":"ON",
				"BackupLinkState":"down",
				"MainLinkState":"up",
				"BackupLinkId":"wan1"
			}
		]
	},
	"RequestId":"582FE511-FEFE-42BC-BBF4-4F8ECF92E3C6"
}

Errors

For a list of error codes, visit the API Error Center.