文档

DescribeNetworks - 查询网络列表

更新时间:

调用DescribeNetworks查询网络列表。

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DescribeNetworksRead
  • acs:ens::{#accountId}:*

请求参数

名称类型必填描述示例值
NetworkIdstring

网络 ID。

n-5***
EnsRegionIdstring

ENS 节点 ID。

cn-beijing-telecom
NetworkNamestring

网络名称。

example
PageNumberinteger

列表的页码,默认值为 1

1
PageSizeinteger

分页查询时每页的行数,最大值为 50,默认值为 10

10

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
TotalCountinteger

列表数据总数。

3
PageSizeinteger

当前查询每页的行数。

2
PageNumberinteger

当前查询页码。

1
Networksobject []

网络列表。

EnsRegionIdstring

ENS 节点 ID。

cn-beijing
NetworkIdstring

网路 ID。

n-5***
NetworkNamestring

网络名称。

example
CidrBlockstring

网络的 IPv4 网段。

10.0.xx.xx/24
Statusstring

网络的状态,取值:

  • Pending:配置中。
  • Available:可用。
Available
Descriptionstring

网络的描述信息。

exampleDescription
CreatedTimestring

创建时间,时间戳(毫秒)。

1653620630000
VSwitchIdsarray

网络中交换机的列表。

string

网络中交换机的列表。

vsw-bp1nhbnpv2blyz8dl****
RouterTableIdstring

路由表 ID。

rtb-5**
NetworkAclIdstring

网络 ACL 的 ID。

nacl-a2do9e413e0spxscd****

示例

正常返回示例

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

错误码

HTTP status code错误码错误信息描述
400ens.interface.errorAn error occurred while calling the API.-
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈