Use DescribeNetworks to query the network list - ENS - Alibaba Cloud - ENS

Call DescribeNetworks to retrieve a list of networks.

Operation description

API call frequency: 100 calls per second.
Per-user call frequency: 10 calls per second.

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

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
NetworkId	string	No	Network ID.	n-5***
EnsRegionId	string	No	ENS node ID.	cn-beijing-telecom
NetworkName	string	No	Network name.	example
PageNumber	integer	No	Page number. Default value: 1.	1
PageSize	integer	No	Number of entries per page in a paged query. Maximum value: 50. Default value: 10.	10
EnsRegionIds	array	No	Array of ENS edge zone IDs. Array length: 1–100.
	string	No	ENS node ID.	cn-chengdu-telecom-4
NetworkIds	array	No	Array of network IDs. Array length: 1–100.
	string	No	Network ID.	n-5***9iu

Response elements

Element	Type	Description	Example
	object	Schema of response
RequestId	string	Request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	Total number of entries.	3
PageSize	integer	Number of entries per page in the current query.	2
PageNumber	integer	Current page number.	1
Networks	object
Network	array<object>	List of networks.
	array<object>	List of networks.
EnsRegionId	string	ENS edge zone ID.	cn-beijing
NetworkId	string	Network ID.	n-5***
NetworkName	string	Network name.	example
CidrBlock	string	IPv4 CIDR block of the network.	10.0.xx.xx/24
Status	string	Network status. Valid values: Pending: being configured. Available: active.	Available
Description	string	Description of the network.	exampleDescription
CreatedTime	string	Creation time as a UNIX timestamp in milliseconds.	1653620630000
VSwitchIds	object
VSwitchId	array	List of vSwitches in the network.
	string	List of vSwitches in the network.	vsw-bp1nhbnpv2blyz8dl****
RouterTableId	string	Route table ID.	rtb-5**
NetworkAclId	string	Network ACL ID.	nacl-a2do9e413e0spxscd****
RouteTableIds	object
RouteTableId	array	List of route table IDs.
	string	Route table ID.	rt-5*****pks
RouteTableId	string	Route table ID.	rt-5*****pks
GatewayRouteTableId	string	Gateway route table ID.	rt-5*****tbs
Tags	object
Tag	array<object>	Collection of tags.
	object	Collection of tags.
Value	string	Tag value.	TestValue
Key	string	Tag key.	TestKey
TagValue `deprecated`	string	Tag value.	TestValue
TagKey `deprecated`	string	Tag key.	TestKey
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	Information about secondary CIDR blocks.
	string	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",
  "TotalCount": 3,
  "PageSize": 2,
  "PageNumber": 1,
  "Networks": {
    "Network": [
      {
        "EnsRegionId": "cn-beijing",
        "NetworkId": "n-5***",
        "NetworkName": "example",
        "CidrBlock": "10.0.xx.xx/24",
        "Status": "Available",
        "Description": "exampleDescription",
        "CreatedTime": "1653620630000",
        "VSwitchIds": {
          "VSwitchId": [
            "vsw-bp1nhbnpv2blyz8dl****"
          ]
        },
        "RouterTableId": "rtb-5**",
        "NetworkAclId": "nacl-a2do9e413e0spxscd****",
        "RouteTableIds": {
          "RouteTableId": [
            "rt-5*****pks"
          ]
        },
        "RouteTableId": "rt-5*****pks",
        "GatewayRouteTableId": "rt-5*****tbs",
        "Tags": {
          "Tag": [
            {
              "Value": "TestValue",
              "Key": "TestKey",
              "TagValue": "TestValue",
              "TagKey": "TestKey"
            }
          ]
        },
        "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	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.