Use DescribeNetworkAttribute to query the configuration of a network - ENS - Alibaba Cloud - ENS

Use DescribeNetworkAttribute to query the configuration of a specific network.

Operation description

API rate limit: 100 calls/sec.
Per-user rate limit: 10 calls/sec.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NetworkId	string	Yes	The ID of the network.	n-****

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
EnsRegionId	string	The ID of the ENS node.	cn-beijing
NetworkId	string	The network ID.	n-5***
NetworkName	string	The network name.	abc
CidrBlock	string	The IPv4 CIDR block of the network.	10.0.0.0/24
Status	string	The status of the network. Valid values: Pending: The network is being configured. Available: The network is ready for use.	Available
Description	string	The description of the network.	abc
CreatedTime	string	The time at which the network was created. The time is in UTC and is formatted as yyyy-MM-ddTHH:mm:ssZ.	2019-06-01T00:00:00Z
VSwitchIds	object
VSwitchId	array	A list of VSwitch IDs associated with the network.
	string	The ID of a VSwitch.	{"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}
CloudResources	object
CloudResourceSetType	array<object>	A list of resources in the network.
	object	A summary for a specific type of resource.
ResourceCount	integer	The number of resources of this type.	3
ResourceType	string	The type of the resource. Example: VSwitch.	VSwitch
RouterTableId	string	The route table ID.	rtb-5***
NetworkAclId	string	The ID of the network ACL.	nacl-a2do9e413e0sp****
InstanceIds	object
InstanceId	array	A list of instance IDs.
	string	The ID of an instance.	i-5****vbfdpyrbi
RouteTableIds	object
RouteTableId	array	A list of route table IDs.
	string	The ID of a route table.	rt-5****8uz
NetworkInterfaceIds	object
NetworkInterfaceId	array	A list of elastic network interface IDs.
	string	The ID of an elastic network interface.	eni-5*****8vyk
LoadBalancerIds	object
LoadBalancerId	array	A list of load balancer instance IDs.
	string	The ID of a load balancer instance.	lb-5****2uk
NatGatewayIds	object
NatGatewayId	array	A list of NAT gateway IDs.
	string	The ID of a NAT gateway.	nat-5****4ik
HaVipIds	object
HaVipId	array	A list of HA VIP instance IDs.
	string	The ID of an HA VIP instance.	havip-5****4aof
RouteTableId	string	The route table ID.	rt-539***fpu
GatewayRouteTableId	string	The gateway route table ID.	rt-539***tbs
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	A list of secondary CIDR blocks.
	string	A secondary CIDR block.	172.XX.XX.0/12
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>
	object
Ipv6Isp	string		telecom
Ipv6CidrBlock	string		2408:XXXX:0:a600::/110
Type	string		system

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "EnsRegionId": "cn-beijing",
  "NetworkId": "n-5***",
  "NetworkName": "abc",
  "CidrBlock": "10.0.0.0/24",
  "Status": "Available",
  "Description": "abc",
  "CreatedTime": "2019-06-01T00:00:00Z",
  "VSwitchIds": {
    "VSwitchId": [
      "{\"VSwitchId\": [ \"vsw-bp14cagpfysr29feg****\" ]}"
    ]
  },
  "CloudResources": {
    "CloudResourceSetType": [
      {
        "ResourceCount": 3,
        "ResourceType": "VSwitch"
      }
    ]
  },
  "RouterTableId": "rtb-5***",
  "NetworkAclId": "nacl-a2do9e413e0sp****",
  "InstanceIds": {
    "InstanceId": [
      "i-5****vbfdpyrbi"
    ]
  },
  "RouteTableIds": {
    "RouteTableId": [
      "rt-5****8uz"
    ]
  },
  "NetworkInterfaceIds": {
    "NetworkInterfaceId": [
      "eni-5*****8vyk"
    ]
  },
  "LoadBalancerIds": {
    "LoadBalancerId": [
      "lb-5****2uk"
    ]
  },
  "NatGatewayIds": {
    "NatGatewayId": [
      "nat-5****4ik"
    ]
  },
  "HaVipIds": {
    "HaVipId": [
      "havip-5****4aof"
    ]
  },
  "RouteTableId": "rt-539***fpu",
  "GatewayRouteTableId": "rt-539***tbs",
  "SecondaryCidrBlocks": {
    "SecondaryCidrBlock": [
      "172.XX.XX.0/12"
    ]
  },
  "Ipv6CidrBlocks": {
    "Ipv6CidrBlock": [
      {
        "Ipv6Isp": "telecom",
        "Ipv6CidrBlock": "2408:XXXX:0:a600::/110",
        "Type": "system"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NetworkNotFound	The specified network is not found.	Network not found, please check network id.
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.