Use DescribeNetworks to query the network list - ENS

Invoke DescribeNetworks to query the Network List.

Operation description

API Call frequency: 100 times/second.
Per-user call frequency: 10 times/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	The ID of the network.	n-5***
EnsRegionId	string	No	The ID of the edge node.	cn-beijing-telecom
NetworkName	string	No	The name of the network.	example
PageNumber	integer	No	The page number of the returned page. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 1 to 50. Default value: 10.	10
EnsRegionIds	array	No	The IDs of edge nodes. You can specify 1 to 100 IDs.
	string	No	The ID of the edge node.	cn-chengdu-telecom-4
NetworkIds	array	No	The IDs of VPCs You can specify 1 to 100 IDs.
	string	No	The ID of the VPC.	n-5***9iu

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	The total number of entries in the list.	3
PageSize	integer	The number of entries returned on each page.	2
PageNumber	integer	The page number of the returned page.	1
Networks	object
Network	array<object>	The VPCs.
	array<object>	The VPC.
EnsRegionId	string	The ID of the edge node.	cn-beijing
NetworkId	string	The ID of the network.	n-5***
NetworkName	string	The name of the network.	example
CidrBlock	string	The IPv4 CIDR block of the network.	10.0.xx.xx/24
Status	string	The status of the network. Valid values: Pending Available	Available
Description	string	The description of the network.	exampleDescription
CreatedTime	string	The timestamp when the instance was created. Unit: milliseconds.	1653620630000
VSwitchIds	object
VSwitchId	array	The list of vSwitches in the network.
	string	The list of vSwitches in the network.	vsw-bp1nhbnpv2blyz8dl****
RouterTableId	string	The route table ID.	rtb-5**
NetworkAclId	string	The ID of the network access control list (ACL).	nacl-a2do9e413e0spxscd****
RouteTableIds	object
RouteTableId	array	The IDs of the route tables.
	string	The ID of the route table.	rt-5*****pks
RouteTableId	string	The ID of the route table.	rt-5*****pks
GatewayRouteTableId	string	The ID of the gateway route table.	rt-5*****tbs
Tags	object
Tag	array<object>	Collection of tags.
	object	Collection of tags.
Value	string	The bandwidth.	TestValue
Key	string	The key of the tag.	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 blocks.	172.XX.XX.0/12

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"
          ]
        }
      }
    ]
  }
}

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.