調用DescribeNetworks查詢網路列表-邊緣節點服務 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	否	網路識別碼。	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	否	網路識別碼數組。數組長度：1~100。
	string	否	網路識別碼。	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.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。