ListNetworkAccessEndpoints - Identity as a Service

Lists the network endpoints for an IDaaS EIAM instance.

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

eiam:ListNetworkAccessEndpoints

get

*NetworkAccessEndpoint

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NextToken	string	No	The token used for the next query. Set this parameter to the NextToken value returned from the previous API call. Leave this parameter empty for the first query.	NTxxxxxexample
MaxResults	integer	No	The number of entries to return on each page. The maximum value is 100.	20
NetworkAccessEndpointType	string	No	The type of the network endpoint. Valid values: shared: a shared network endpoint. private: a private network endpoint. The default value is private.	private
VpcId	string	No	The ID of the VPC to which the private network endpoint is connected. This parameter does not take effect when NetworkAccessEndpointType is set to shared.	vpc-examplexxx
VpcRegionId	string	No	The region ID of the VPC to which the private network endpoint is connected. The value of this parameter must be a region returned by the ListNetworkAccessEndpointAvailableRegions operation. This parameter does not take effect when NetworkAccessEndpointType is set to shared.	cn-hangzhou
NetworkAccessEndpointStatus	string	No	The status of the network endpoint. Valid values: pending: The endpoint is pending initialization. creating: The endpoint is being created. running: The endpoint is running. deleting: The endpoint is being deleted. This parameter does not take effect when NetworkAccessEndpointType is set to shared.	running

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	The total number of entries.	100
NextToken	string	The token returned for the next query.	NTxxxexample
NetworkAccessEndpoints	array<object>	A collection of network endpoints.
	object	The network endpoint information.
InstanceId	string	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NetworkAccessEndpointId	string	The network endpoint ID.	nae_examplexxx
NetworkAccessEndpointName	string	The name of the network endpoint.	VPC access endpoint for xx service
VpcId	string	The ID of the VPC to which the private network endpoint is connected.	vpc-examplexxx
VpcRegionId	string	The region ID of the VPC to which the private network endpoint is connected.	cn-hangzhou
VSwitchIds	array	A list of vSwitches to which the private network endpoint is connected.	vsw-examplexxx
	string	The vSwitch ID.	vsw-2vc8z0f90z4k6xxxxx
SecurityGroupId	string	The ID of the security group used by the private network endpoint.	sg-examplexxx
Status	string	The status of the network endpoint. Valid values: pending: The endpoint is pending initialization. creating: The endpoint is being created. running: The endpoint is running. deleting: The endpoint is being deleted.	running
NetworkAccessEndpointType	string	The type of the network endpoint. Valid values: shared: a shared network endpoint. private: a private network endpoint.	private
CreateTime	integer	The time when the network endpoint was created. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000
UpdateTime	integer	The time when the network endpoint was last updated. This value is a UNIX timestamp. Unit: milliseconds.	1649830226000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "NextToken": "NTxxxexample",
  "NetworkAccessEndpoints": [
    {
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "NetworkAccessEndpointId": "nae_examplexxx",
      "NetworkAccessEndpointName": "VPC access endpoint for xx service",
      "VpcId": "vpc-examplexxx",
      "VpcRegionId": "cn-hangzhou",
      "VSwitchIds": [
        "vsw-2vc8z0f90z4k6xxxxx"
      ],
      "SecurityGroupId": "sg-examplexxx",
      "Status": "running",
      "NetworkAccessEndpointType": "private",
      "CreateTime": 1649830226000,
      "UpdateTime": 1649830226000
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.