DescribeNetworkAttribute - 查询网络信息 - 边缘节点服务ENS

调用DescribeNetworkAttribute查询指定网络的配置信息。

接口说明

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

调试

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

调试

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ens:DescribeNetworkAttribute	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
NetworkId	string	是	网络 ID。	n-****

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
EnsRegionId	string	ENS 节点 ID。	cn-beijing
NetworkId	string	网络 ID。	n-5***
NetworkName	string	网路名称。	abc
CidrBlock	string	网络的 IPv4 网段。	10.0.0.0/24
Status	string	网络的状态，取值： Pending：配置中。 Available：可用。	Available
Description	string	网络的描述信息。	abc
CreatedTime	string	创建时间，使用 UTC 时间格式，格式为 yyyy-MM-ddTHH:mm:ssZ。	2019-06-01T00:00:00Z
VSwitchIds	array	网络下的交换机列表。
VSwitchId	string	网络下的交换机列表。	{"VSwitchId": [ "vsw-bp14cagpfysr29feg****" ]}
CloudResources	array<object>	网络下的资源列表。
CloudResourceSetType	object	Schema of Response
ResourceCount	integer	网络下的资源数量。	3
ResourceType	string	资源类型。 VSwitch。	VSwitch
RouterTableId	string	路由表 id	rtb-5***
NetworkAclId	string	网络 ACL 的 ID。	nacl-a2do9e413e0sp****
InstanceIds	array	实例 ID 列表。
InstanceId	string	实例 ID。	i-5****vbfdpyrbi
RouteTableIds	array	路由表 ID 列表。
RouteTableId	string	路由表 ID。	rt-5****8uz
NetworkInterfaceIds	array	弹性网卡 ID 列表。
NetworkInterfaceId	string	弹性网卡 ID。	eni-5*****8vyk
LoadBalancerIds	array	负载均衡实例 ID 列表。
LoadBalancerId	string	负载均衡实例 ID。	lb-5****2uk
NatGatewayIds	array	NAT 网关的 ID 列表。
NatGatewayId	string	NAT 网关的 ID。	nat-5****4ik
HaVipIds	array	高可用 VIP 实例 ID 列表。
HaVipId	string	高可用 VIP 实例 ID。	havip-5****4aof

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
400	NetworkNotFound	The specified network is not found.	找不到网络，请检查网络id。
400	ens.interface.error	Failed to call API.	接口调用发生异常。
400	NoPermission	Permission denied.	没有足够的权限，请联系云账号管理员授予您相应权限。
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-

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

变更历史

变更时间	变更内容概要	操作
2024-12-26	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情