DescribeSagHa - Smart Access Gateway - Alibaba Cloud Documentation Center

You can call this operation to query the high availability (HA) configuration 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:DescribeSagHa	Read	SmartAccessGateway acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Smart Access Gateway (SAG) instance is deployed.	cn-shanghai
SmartAGId	string	Yes	The ID of the SAG instance.	sag-whfn****
SmartAGSn	string	Yes	The serial number of the SAG device.	sag32a30****

Response parameters

Parameter	Type	Description	Example
	object
Mode	string	The HA mode. Valid values: NONE: HA is disabled. STATIC: static HA is enabled. DYNAMIC: dynamic HA is enabled.	NONE
RequestId	string	The ID of the request.	273D62FD-E346-4959-AA18-D79B9276FEFB
Ports	object []	The information about the port.
PortName	string	The name of the port.	5
VirtualIp	string	The virtual IP address of the SAG device.	192.XX.XX.1
TaskStates	object []	The information about the query task.
ErrorMessage	string	The error message returned for a query task. The Successful error message indicates that the query task is successful.	Successful
State	string	The status of the query task. Valid values: Initialized: The query task has been initialized. Offline: The query task is not dispatched because the SAG device is disconnected from Alibaba Cloud. The task will be dispatched after the SAG device is connected to Alibaba Cloud. Succeed: The query task has been dispatched. Processing: The query task is being dispatched. VersionNotSupport: The current version of the SAG device does not support query tasks. BuildRequestError: The SAG control system does not support query tasks. HardwareError: The query task failed to be dispatched due to device errors. TaskNotExist: The query task does not exist. OfflineNotConfiged: The query task is not dispatched because the SAG device is disconnected from Alibaba Cloud. The task will not be dispatched after the device is connected to Alibaba Cloud.	Succeed
ErrorCode	string	The error code returned for a query task. The 200 error code indicates that the query task is successful.	200
CreateTime	string	The time when the query task was created.	1586836343000

Examples

Sample success responses

JSONformat

{
  "Mode": "NONE",
  "RequestId": "273D62FD-E346-4959-AA18-D79B9276FEFB",
  "Ports": [
    {
      "PortName": "5",
      "VirtualIp": "192.XX.XX.1"
    }
  ],
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586836343000"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	SAG.InstanceNoFound	The specified SAG instance does not exist.	The specified SAG instance does not exist.
400	SAG.SoftwareNotSupport	The specified SAG software edition instance does not support ACL.	The specified SAG software edition instance does not support ACL.
400	InstanceNotExit	The specified instance does not exist.	The specified instance does not exist.
400	ConfigUnsynchronized	The network configuration is not synchronized.	Network settings are not synchronized.
403	SmartAccessGatewayNotOnline	The specified smart access gateway is not online.	The specified SAG device is disconnected. The operation cannot be processed.
403	FeatureNotSupport	The current edition of the smart access gateway does not support this feature.	The current version of Smart Access Gateway does not support this feature.
403	FeatureNotSupportForActiveSmartAG	The current edition of the active smart access gateway does not support this feature.	The current edition of the active SAG instance does not support this feature.
403	FeatureNotSupportForStandBySmartAG	The current edition of the standby smart access gateway does not support this feature.	The current version of Smart Access Gateway does not support this feature.
500	SmartAccessGatewayInArrears	The specified Smart Access Gateway has expired.	The specified Smart Access Gateway has expired.
500	SmartAccessGatewayNotActivated	The specified Smart Access Gateway has not been activated.	The specified SAG instance is inactive. You must activate the instance first.
500	SmartAccessGatewayOffline	The request cannot be completed. The Smart Access Gateway is offline.	The SAG device is disconnected. The request cannot be processed.

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