ListAvailableServiceAddress - Smart Access Gateway - Alibaba Cloud Documentation Center

Queries the service addresses of a Smart Access Gateway (SAG) device.

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:ListAvailableServiceAddress	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 SAG instance is deployed. You can call the DescribeRegions operation to query the most recent region list.	cn-shanghai
AddressType	string	Yes	The type of service address. Valid values: ProbeTask: probes the source IP address. RemoteWeb: probes the IP address for remote logon. Note If you do not specify a value, all service IP addresses are queried.	ProbeTask
SagId	string	Yes	The ID of the SAG instance.	sag-****
Sn	string	Yes	The serial number of the SAG device.	sag****

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	324223F3-93D3-4CE4-B26F-66C0C3809922
Code	string	The response code.	200
Message	string	The response message.	Success
Data	object []
Address	string	The service address.	192.168.1.1
AddressType	string	The type of service address.	ProbeTask

Examples

Sample success responses

JSONformat

{
  "RequestId": "324223F3-93D3-4CE4-B26F-66C0C3809922",
  "Code": "200",
  "Message": "Success",
  "Data": [
    {
      "Address": "192.168.1.1",
      "AddressType": "ProbeTask"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidId.SN	The specified smart access gateway serial number does not exist.	The specified smart access gateway serial number does not exist.
400	InvalidServiceAddressType	The specified service address type is invalid.	The type of the service address is invalid.
403	InvalidId.SMARTAG	The specified smart access gateway instance id is invalid.	The SAG instance ID is invalid.

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