GetNetworkAccessEndpoint - Identity as a Service - Alibaba Cloud Documentation Center

Get Network Endpoint Information

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
eiam:GetNetworkAccessEndpoint	get	*NetworkAccessEndpoint `acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/networkaccessendpoint/{#NetworkAccessEndpointId}`	none	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 parameters

Parameter	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.	xx business VPC access endpoint
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.
VSwitchId	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.
EgressPublicIpAddress	string	Public egress ip address.	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.
EgressPrivateIpAddress	string	Private egress ip address.	192.168.1.1
CreateTime	long	The time when the baseline was created.	1649830226000
UpdateTime	long	The time when the endpoint was updated.	1649830226000

Examples

Sample success responses

JSONformat

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "NetworkAccessEndpoint": {
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "NetworkAccessEndpointId": "nae_examplexxx",
    "NetworkAccessEndpointName": "xx business VPC access endpoint",
    "VpcId": "vpc-examplexxx",
    "VpcRegionId": "cn-hangzhou",
    "VSwitchIds": [
      "vsw-2vc8z0f90z4k6xxxxx\n"
    ],
    "SecurityGroupId": "sg-examplexxx",
    "Status": "running",
    "NetworkAccessEndpointType": "private",
    "EgressPublicIpAddresses": [
      "203.0.XX.XX/27"
    ],
    "EgressPrivateIpAddresses": [
      "192.168.1.1"
    ],
    "CreateTime": 1649830226000,
    "UpdateTime": 1649830226000
  }
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history