Query EPN instance attributes with DescribeEpnInstanceAttribute - ENS

Queries networking information about an EPN instance.

Operation description

In internal networking mode, the value of Instances is empty in the response. In public networking mode, the value of VSwitches is empty in the response.

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

ens:DescribeEpnInstanceAttribute

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
EPNInstanceId	string	Yes	The ID of the EPN instance.	epn-xxxx

Response elements

Element	Type	Description	Example
	object
ConfVersions	array<object>	The information about the EPN configurations.
	object
ConfVersion	string	The version number.	2017-10-11
EnsRegionId	string	The ID of the node.	cn-chengdu-telecom
EPNInstanceId	string	The ID of the EPN instance.	epn-xxxx
EPNInstanceName	string	The name of the EPN instance.	epn-test
Instances	array<object>	The information about the instance.
	object
EnsRegionId	string	The ID of the node.	cn-chengdu-telecom-4
InstanceId	string	The ID of the instance.	epn-xxx
InstanceName	string	The name of the instance.	epn-test
Isp	string	The ISP. Valid values: cmcc: China Mobile unicom: China Unicom telecom: China Telecom	cmcc
PrivateIpAddress	string	The private IP address.	192.168.1.12
PublicIpAddress	string	The public IP address.	20.3.XX.XX
Status	string	The status of the instance. Valid values: Running Stopped Expired	Running
NetworkingModel	string	The networking mode. Valid values: SpeedUp: intelligent acceleration network (Internet) Connection: internal network SpeedUpAndConnection: intelligent acceleration network and internal network	SpeedUp
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
VSwitches	array<object>	Details of the vSwitch.
	object
CidrBlock	string	The CIDR block.	10.0.0.1/24
EnsRegionId	string	The ID of the node.	cn-chengdu-telecom-4
VSwitchId	string	The ID of the vSwitch.	vs-xxxx
VSwitchName	string	The name of the vSwitch.	vs-test

Examples

Success response

JSON format

{
  "ConfVersions": [
    {
      "ConfVersion": "2017-10-11",
      "EnsRegionId": "cn-chengdu-telecom"
    }
  ],
  "EPNInstanceId": "epn-xxxx",
  "EPNInstanceName": "epn-test",
  "Instances": [
    {
      "EnsRegionId": "cn-chengdu-telecom-4",
      "InstanceId": "epn-xxx",
      "InstanceName": "epn-test",
      "Isp": "cmcc",
      "PrivateIpAddress": "192.168.1.12",
      "PublicIpAddress": "20.3.XX.XX",
      "Status": "Running"
    }
  ],
  "NetworkingModel": "SpeedUp",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "VSwitches": [
    {
      "CidrBlock": "10.0.0.1/24",
      "EnsRegionId": "\t cn-chengdu-telecom-4",
      "VSwitchId": "vs-xxxx",
      "VSwitchName": "vs-test"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.
400	InvalidParameter	The errorMessage is %s. Please check it again.
400	ens.interface.error	An error occurred while calling the API.
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.