调用DescribeNetworks查询network列表。
使用说明
- API调用频率:100次/秒。
- 单用户调用频率:10次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeNetworks |
系统规定参数。取值:DescribeNetworks。 |
NetworkId | String | 否 | n-5*** |
网络ID。 |
EnsRegionId | String | 否 | cn-beijing-telecom |
ENS节点ID。 |
NetworkName | String | 否 | example |
网络名称。 |
PageNumber | Integer | 否 | 1 |
列表的页码,默认值为1。 |
PageSize | Integer | 否 | 10 |
分页查询时每页的行数,最大值为50,默认值为10。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
TotalCount | Integer | 3 |
列表数据总数。 |
PageSize | Integer | 2 |
当前查询每页的行数。 |
PageNumber | Integer | 1 |
当前查询页码。 |
Networks | Array of Network |
network列表。 |
|
Network | |||
EnsRegionId | String | cn-beijing |
ENS节点ID。 |
NetworkId | String | n-5*** |
网路ID。 |
NetworkName | String | example |
网络名称。 |
CidrBlock | String | 10.0.xx.xx/24 |
网络的IPv4网段。 |
Status | String | Available |
网络的状态,取值:
|
Description | String | exampleDescription |
网络的描述信息。 |
CreatedTime | String | 2020-06-16T06:33:15Z |
创建时间,使用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ssZ。 |
VSwitchIds | Array of String | vsw-bp1nhbnpv2blyz8dl**** |
网络中交换机的列表。 |
RouterTableId | String | rtb-5** |
路由表id。 |
示例
请求示例
http(s)://ens.aliyuncs.com/?Action=DescribeNetworks
&NetworkId=n-5***
&EnsRegionId=cn-beijing-telecom
&NetworkName=example
&PageNumber=1
&PageSize=10
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeNetworksResponse>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<TotalCount>3</TotalCount>
<PageSize>2</PageSize>
<PageNumber>1</PageNumber>
<Networks>
<EnsRegionId>cn-beijing</EnsRegionId>
<NetworkId>n-5***</NetworkId>
<NetworkName>example</NetworkName>
<CidrBlock>10.0.xx.xx/24</CidrBlock>
<Status>Available</Status>
<Description>exampleDescription</Description>
<CreatedTime>2020-06-16T06:33:15Z</CreatedTime>
<VSwitchIds>vsw-bp1nhbnpv2blyz8dl****</VSwitchIds>
<RouterTableId>rtb-5**</RouterTableId>
</Networks>
</DescribeNetworksResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"TotalCount" : 3,
"PageSize" : 2,
"PageNumber" : 1,
"Networks" : [ {
"EnsRegionId" : "cn-beijing",
"NetworkId" : "n-5***",
"NetworkName" : "example",
"CidrBlock" : "10.0.xx.xx/24",
"Status" : "Available",
"Description" : "exampleDescription",
"CreatedTime" : "2020-06-16T06:33:15Z",
"VSwitchIds" : [ "vsw-bp1nhbnpv2blyz8dl****" ],
"RouterTableId" : "rtb-5**"
} ]
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NoPermission | Permission denied. | 没有足够的权限,请联系云账号管理员授予您相应权限。 |
访问错误中心查看更多错误码。