调用DescribeNetworks接口查询网络列表-边缘节点服务 ENS-阿里云-边缘节点服务 ENS(ENS)-阿里云帮助中心

调用DescribeNetworks查询网络列表。

接口说明

API 调用频率：100 次/秒。
单用户调用频率：10 次/秒。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeNetworks

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
NetworkId	string	否	网络 ID。	n-5***
EnsRegionId	string	否	ENS 节点 ID。	cn-beijing-telecom
NetworkName	string	否	网络名称。	example
PageNumber	integer	否	列表的页码，默认值为 1。	1
PageSize	integer	否	分页查询时每页的行数，最大值为 50，默认值为 10。	10
EnsRegionIds	array	否	ENS 节点 ID 数组。数组长度：1~100。
	string	否	ENS 节点 ID。	cn-chengdu-telecom-4
NetworkIds	array	否	网络 ID 数组。数组长度：1~100。
	string	否	网络 ID。	n-5***9iu

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCount	integer	列表数据总数。	3
PageSize	integer	当前查询每页的行数。	2
PageNumber	integer	当前查询页码。	1
Networks	object
Network	array<object>	网络列表。
	array<object>	网络列表。
EnsRegionId	string	ENS 节点 ID。	cn-beijing
NetworkId	string	网路 ID。	n-5***
NetworkName	string	网络名称。	example
CidrBlock	string	网络的 IPv4 网段。	10.0.xx.xx/24
Status	string	网络的状态，取值： Pending：配置中。 Available：可用。	Available
Description	string	网络的描述信息。	exampleDescription
CreatedTime	string	创建时间，时间戳（毫秒）。	1653620630000
VSwitchIds	object
VSwitchId	array	网络中交换机的列表。
	string	网络中交换机的列表。	vsw-bp1nhbnpv2blyz8dl****
RouterTableId	string	路由表 ID。	rtb-5**
NetworkAclId	string	网络 ACL 的 ID。	nacl-a2do9e413e0spxscd****
RouteTableIds	object
RouteTableId	array	路由表 ID 列表。
	string	路由表 ID。	rt-5*****pks
RouteTableId	string	路由表 ID。	rt-5*****pks
GatewayRouteTableId	string	网关路由表 ID。	rt-5*****tbs
Tags	object
Tag	array<object>	标签集合。
	object	标签集合。
Value	string	标签值。	TestValue
Key	string	标签键。	TestKey
TagValue `deprecated`	string	标签值。	TestValue
TagKey `deprecated`	string	标签键。	TestKey
SecondaryCidrBlocks	object
SecondaryCidrBlock	array	附加网段信息。
	string	附加网段。	172.XX.XX.0/12
Ipv6CidrBlocks	object
Ipv6CidrBlock	array<object>
	object
Ipv6Isp	string		telecom
Ipv6CidrBlock	string		2408:XXXX:0:a600::/110
Type	string		system

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	ens.interface.error	Failed to call API.	接口调用发生异常。
400	NoPermission	Permission denied.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。