ListAvailableServiceAddress - Smart Access Gateway - Alibaba Cloud Documentation Center

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:ListAvailableServiceAddress

list

*SmartAccessGateway

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the Smart Access Gateway instance is deployed. Call the DescribeRegions operation to obtain the region ID.	cn-shanghai
AddressType	string	No	The type of the service address for the Smart Access Gateway instance. Valid values: ProbeTask: the source IP address for network probes. RemoteWeb: the IP address for remote logon. Note If you do not specify this parameter, all types of service addresses are queried.	ProbeTask
SagId	string	Yes	The ID of the Smart Access Gateway instance.	sag-****
Sn	string	Yes	The serial number of the Smart Access Gateway device.	sag****

Response elements

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

Examples

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.