DescribeSagPortList - Smart Access Gateway - Alibaba Cloud Documentation Center

You can call this operation to query the information of a physical port.

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:DescribeSagPortList	List	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 associated with the SAG instance.	sag32a30****

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	CE6642D4-21EB-4168-9BF9-F217953F9892
Ports	object []	The list of the port information.
Status	string	Port states: Up: The port is enabled. Down: The port is disabled. Unavailable: The SAG device is disconnected from Alibaba Cloud.	Down
Role	string	Port role: NONE: No role is assigned to the port. WAN: The port is used as a WAN port. The WAN port supports a Dynamic Host Configuration Protocol (DHCP) client, PPPoE, or a static IP address to access the Internet. LAN: The port is used as a LAN port. The LAN port supports a DHCP server or a static IP address to connect to a local terminal or switch. ECC: The port is used as a leased line port to connect to a leased line. MGT: The port is used as the management port.	NONE
PortName	string	The name of the port.	5
Mac	string	The Mac address of the port.	c4:00:ad:a2:f5:****
TaskStates	object []	The state of the query task.
ErrorMessage	string	The error message. Successful indicates that the query task is successful.	Successful
State	string	Asynchronous task states: Initialized: The query task is initialized. Offline: The SAG device is disconnected from Alibaba Cloud and Alibaba Cloud has not assigned the query task to the SAG device. When the SAG device is connected to Alibaba Cloud, Alibaba Cloud continues to assign the query task to the SAG device. Succeed: Alibaba Cloud has assigned the query task to the SAG device. Processing: Alibaba Cloud is assigning the query task to the SAG device. VersionNotSupport: not supported by the current version of the SAG device. BuildRequestError: not supported by the control and management center in the cloud. HardwareError: Alibaba Cloud failed to assign the query task to the SAG device because the SAG device is faulty. TaskNotExist: The query task does not exist. OfflineNotConfiged: The SAG device is disconnected from Alibaba Cloud and Alibaba Cloud has not assigned the query task to the SAG device. When the SAG device is connected to Alibaba Cloud, Alibaba Cloud does not assign the query task to the SAG device.	Succeed
ErrorCode	string	The error code. 200 indicates that the query task is successful.	200
CreateTime	string	The time when the query task was created.	1586762479000

Examples

Sample success responses

JSONformat

{
  "RequestId": "CE6642D4-21EB-4168-9BF9-F217953F9892",
  "Ports": [
    {
      "Status": "Down",
      "Role": "NONE",
      "PortName": "5",
      "Mac": "c4:00:ad:a2:f5:****"
    }
  ],
  "TaskStates": [
    {
      "ErrorMessage": "Successful",
      "State": "Succeed",
      "ErrorCode": "200",
      "CreateTime": "1586762479000"
    }
  ]
}

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.