华为乾坤-获取设备IP资源信息列表:响应参数
下载华为乾坤用户手册完整版
响应参数
返回状态码为200：响应对象，接口返回体参考GetIpListResponseVo。
|
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
|---|---|---|---|---|---|
|
errcode |
string |
0~256个字符。 |
- |
错误码。 |
"0" |
|
errmsg |
string |
0~256个字符。 |
- |
错误信息。 |
"" |
|
pageVo |
REFERENCE |
详细请参见表5。 |
分页的响应数据。 |
- |
|
|
ipItems |
ARRAY_REFERENCE |
0-65535个列表项，详细请参见表6。 |
Ip资源详细信息列表。 |
- |
|
|
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
|---|---|---|---|---|---|
|
pageIndex |
int32 |
[1-1000] |
- |
当前页数。 |
1 |
|
pageSize |
int32 |
[1-1000] |
- |
每页显示数量。 |
20 |
|
totalRecords |
int32 |
[1-65535] |
- |
总的数据条数。 |
1 |
|
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
|---|---|---|---|---|---|
|
siteId |
string |
[1-64] |
- |
站点Id。 |
"d235353a-1284-4aad-9f35-18af543fcf5b" |
|
siteName |
string |
[0-64] |
- |
站点名称。 |
"s74" |
|
deviceName |
string |
0~64个字符。 |
- |
设备名称。 |
"AR8140-74" |
|
deviceId |
string |
1~36个字符。 |
- |
设备Id。 |
"6a650c65-b5d7-482f-811a-18efbbde48b6" |
|
linkName |
string |
0~128个字符。 |
- |
链路名称。 |
"GigabitEthernet0/0/3" |
|
vrf |
string |
0~64个字符。 |
- |
vrf实例名称。 |
"underlay_2" |
|
vpnName |
string |
0~128个字符。 |
- |
VN名称。 |
"vpn1" |
|
ipAddress |
string |
0~128个字符。 |
- |
IP地址。 |
"10.1.1.1" |
|
ipv6Address |
string |
0~128个字符。 |
- |
IPV6地址。 |
"10::1" |
|
usage |
string |
- |
- |
业务类型：| UNDERLAY：UNDERLAY， evpn：EVPN， inter-cpe：内联链路， lan-access：LAN侧接入， inter-loopback：内环隧道， inter-tunnel， system：EVPN管理口， VAS：VAS， iwg：IWG， tunnel-configuration：隧道配置， cloud-security： 云安全 ， management：管理配置， unknown：其他。 |
"UNDERLAY" |
返回状态码为400：校验异常。
详细信息请参见实际响应消息体。
返回状态码为500：内部错误。
详细信息请参见实际响应消息体。
