All Products
Search
Document Center

Smart Access Gateway:DescribeSagHa

Last Updated:Mar 03, 2024

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.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the SAG instance.

cn-shanghai
SmartAGIdstringYes

The serial number of the SAG device.

sag-whfn****
SmartAGSnstringYes

The HA mode. Valid values:

  • NONE: HA is disabled.
  • STATIC: static HA is enabled.
  • DYNAMIC: dynamic HA is enabled.
sag32a30****

Response parameters

ParameterTypeDescriptionExample
object
Modestring

The ID of the request.

NONE
RequestIdstring

The information about the port.

273D62FD-E346-4959-AA18-D79B9276FEFB
Portsobject []

The name of the port.

PortNamestring

The virtual IP address of the SAG device.

5
VirtualIpstring

The information about the query task.

192.XX.XX.1
TaskStatesobject []

The error message returned for a query task. The Successful error message indicates that the query task is successful.

ErrorMessagestring

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.
Successful
Statestring

The error code returned for a query task. The 200 error code indicates that the query task is successful.

Succeed
ErrorCodestring

The time when the query task was created.

200

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 codeError codeError messageDescription
400SAG.InstanceNoFoundThe specified SAG instance does not exist.The specified SAG instance does not exist.
400SAG.SoftwareNotSupportThe specified SAG software edition instance does not support ACL.The specified SAG software edition instance does not support ACL.
400InstanceNotExitThe specified instance does not exist.The specified instance does not exist.
400ConfigUnsynchronizedThe network configuration is not synchronized.Network settings are not synchronized.
403SmartAccessGatewayNotOnlineThe specified smart access gateway is not online.The specified SAG device is disconnected. The operation cannot be processed.
403FeatureNotSupportThe current edition of the smart access gateway does not support this feature.The current version of Smart Access Gateway does not support this feature.
403FeatureNotSupportForActiveSmartAGThe 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.
403FeatureNotSupportForStandBySmartAGThe 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.
500SmartAccessGatewayInArrearsThe specified Smart Access Gateway has expired.The specified Smart Access Gateway has expired.
500SmartAccessGatewayNotActivatedThe specified Smart Access Gateway has not been activated.The specified SAG instance is inactive. You must activate the instance first.
500SmartAccessGatewayOfflineThe 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.