DescribeSagHa-阿里云帮助中心

Queries the high-availability configuration of a Smart Access Gateway instance by calling DescribeSagHa.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

smartag:DescribeSagHa

get

*SmartAccessGateway

acs:smartag:{#regionId}:{#accountId}:smartag/{#SmartAGId}

None

Request parameters

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

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	273D62FD-E346-4959-AA18-D79B9276FEFB
Mode	string	The high-availability (HA) pattern. Valid values: NONE: The HA feature is not enabled. STATIC: static pattern. DYNAMIC: dynamic schema.	NONE
Ports	array<object>	The list of port information.
	object
PortName	string	The port name.	5
VirtualIp	string	The virtual IP address of the Smart Access Gateway.	192.XX.XX.1
TaskStates	array<object>	The list of query task information.
	object
ErrorMessage	string	The error message. "Successful" indicates that the query task succeeded.	Successful
State	string	The status of the asynchronous task. Valid values: Initialized: The query task is initialized. Offline: The Smart Access Gateway device is offline and the query task is not delivered. The task will be delivered after the device comes online. Succeed: The query task is delivered. Processing: The query task is being delivered. VersionNotSupport: The current version of the Smart Access Gateway device does not support this operation. BuildRequestError: The China Cloud Management Platform does not support this operation. HardwareError: The query task failed to be delivered due to a device error. TaskNotExist: The query task does not exist. OfflineNotConfiged: The Smart Access Gateway device is offline and the query task is not delivered. The task will not be delivered even after the device comes online.	Succeed
ErrorCode	string	The error code. 200 indicates that the query task succeeded.	200
CreateTime	string	The time when the query task was created.	1586836343000

Examples

Success response

JSON format

{
  "RequestId": "273D62FD-E346-4959-AA18-D79B9276FEFB",
  "Mode": "NONE",
  "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.
500	SmartAccessGatewayInArrears	The specified Smart Access Gateway has expired.
500	SmartAccessGatewayNotActivated	The specified Smart Access Gateway has not been activated.
500	SmartAccessGatewayOffline	The request cannot be completed. The Smart Access Gateway is offline.
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.