ListNetworkAccessPaths - Identity as a Service - Alibaba Cloud Documentation Center

Lists the access paths for a specified network endpoint.

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 support 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

eiam:ListNetworkAccessPaths

list

*NetworkAccessPath

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}/networkaccesspath/*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NetworkAccessEndpointId	string	Yes	The ID of the dedicated network endpoint.	nae_examplexxxx

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
NetworkAccessPaths	array<object>	The list of network endpoint access paths.
	object	The information about the network endpoint access path.
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NetworkAccessEndpointId	string	The ID of the dedicated network endpoint.	nae_examplexxx
NetworkAccessPathId	string	The ID of the dedicated network endpoint access path.	nap_examplexxx
NetworkInterfaceId	string	The ID of the ENI that is used by the dedicated network endpoint access path.	eni-examplexxx
VSwitchId	string	The ID of the vSwitch to which the ENI of the dedicated network endpoint access path belongs.	vsw-examplexxx
PrivateIpAddress	string	The private IP address of the ENI that is used by the dedicated network endpoint access path.	cn-hangzhou
Status	string	The status of the dedicated network endpoint access path. Valid values: pending: The path is being initialized. creating: The path is being created. running: The path is running. deleting: The path is being deleted.	running
CreateTime	integer	The time when the dedicated network endpoint access path was created. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000
UpdateTime	integer	The time when the dedicated network endpoint access path was last updated. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "NetworkAccessPaths": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "NetworkAccessEndpointId": "nae_examplexxx",
      "NetworkAccessPathId": "nap_examplexxx",
      "NetworkInterfaceId": "eni-examplexxx",
      "VSwitchId": "vsw-examplexxx",
      "PrivateIpAddress": "cn-hangzhou",
      "Status": "running",
      "CreateTime": 1649830226000,
      "UpdateTime": 1649830226000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.