Call the GetNetworkAccessEndpoint API - Identity as a Service

Get Network Endpoint Information

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

get

*NetworkAccessEndpoint

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

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NetworkAccessEndpointId	string	Yes	The unique identifier of the network access endpoint.	nae-examplexxxx

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	0441BD79-92F3-53AA-8657-F8CE4A2B912A
NetworkAccessEndpoint	object	Network endpoint information.
InstanceId	string	Instance ID.	idaas_ue2jvisn35ea5lmthk267xxxxx
NetworkAccessEndpointId	string	The unique identifier of the network access endpoint.	nae_examplexxx
NetworkAccessEndpointName	string	Private network endpoint name.	VPC access endpoint for xx service
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-examplexxx
VpcRegionId	string	The region ID of the outbound virtual private cloud (VPC).	cn-hangzhou
VSwitchIds	array	List of specified vSwitches associated with the dedicated network endpoint connection.	vsw-examplexxx
	string	List of specified vSwitches associated with the dedicated network endpoint connection.	vsw-2vc8z0f90z4k6xxxxx
SecurityGroupId	string	The ID of the destination security group.	sg-examplexxx
Status	string	Status of the Network Endpoint Possible values: pending: Pending initialization creating: Being created running: Running deleting: Being deleted	running
NetworkAccessEndpointType	string	Type of the Network Endpoint Possible values: shared: Shared network endpoint private: Dedicated network endpoint	private
EgressPublicIpAddresses	array	Public egress ip address range of the shared network endpoint This field is returned only when networkEndpointType is set to shared.	8.xx.xx.xxx/27
	string	Public egress ip address.	Public egress IP address. The actual value is subject to the API response. Example: 203.0.XX.XX/27
EgressPrivateIpAddresses	array	Public egress ip address range of the dedicated network endpoint This field is returned only when NetworkEndpointType is set to private.	172.168.x.x
	string	Private egress ip address.	192.168.1.1
CreateTime	integer	The time when the baseline was created.	1649830226000
UpdateTime	integer	The time when the endpoint was updated.	1649830226000

Examples

Success response

JSON format

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "NetworkAccessEndpoint": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "NetworkAccessEndpointId": "nae_examplexxx",
    "NetworkAccessEndpointName": "VPC access endpoint for xx service",
    "VpcId": "vpc-examplexxx",
    "VpcRegionId": "cn-hangzhou",
    "VSwitchIds": [
      "vsw-2vc8z0f90z4k6xxxxx\n"
    ],
    "SecurityGroupId": "sg-examplexxx",
    "Status": "running",
    "NetworkAccessEndpointType": "private",
    "EgressPublicIpAddresses": [
      "Public egress IP address. The actual value is subject to the API response. Example: 203.0.XX.XX/27"
    ],
    "EgressPrivateIpAddresses": [
      "192.168.1.1"
    ],
    "CreateTime": 1649830226000,
    "UpdateTime": 1649830226000
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.