华为乾坤-条件查询接口资源(推荐使用):响应参数

时间:2025-02-17 11:38:46

响应参数

返回状态码为200:成功返回接口信息

表6 ApiIfResponseV2对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

error_code

int32

-

0

错误码。

-

error_msg

string

-

Successful.

错误消息。

-

totalCount

int32

-

-

满足条件的总数

-

totalPage

int32

-

-

满足条件的总页数

-

currentPage

int32

-

-

当前页数

-

ifDataList

ARRAY_REFERENCE

详细请参见表7

接口列表

-

表7 ApiIfDataV2对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

nedn

string

1~255个字符。

-

设备DN

-

interfaceId

string

0~255个字符。

-

接口DN,一旦创建无法修改,必填

-

ifIndex

integer

-

-

接口索引,从设备上获取,无法修改

-

ifDesc

string

1~255个字符。

-

接口名称,从设备上获取,无法修改

-

ifAlias

string

0~255个字符。

-

接口别名,从设备上获取,可修改

-

ipAddress

string

0~255个字符。

-

ip地址

-

ifOperStatus

string

  • UP

  • DOWN

  • TESTING

  • UNKNOWN

  • DORMANT

  • NOTPRESENT

  • LOWLAYERDOWN

-

接口运行态

-

ifAdminStatus

string

  • UP

  • DOWN

  • PLANNING

-

接口管理态, 可修改

-

ifSpeed

string

0~255个字符。

-

接口速率

-

ifRemark

string

0~255个字符。

-

备注,可修改

-

ifMtu

string

0~255个字符。

-

MTU

-

ifDuplexMode

string

  • FULL

  • HALF

  • AUTO

  • AUTOFULL

  • AUTOHALF

-

双工模式

-

ifType

string

  • OTHER

  • ETHERNET

  • ETH-TRUNK

  • VIRTUAL_ETHERNET

  • ATM

  • POS

  • SERIAL

  • VLANIF

  • E1

  • T1

  • CPOS

  • TUNNEL

  • LOOPBACK

  • IP-TRUNK

  • VIRTUAL-TEMPLATE

  • RING-IF

  • MFR

  • MP-GROUP

  • AUX

  • E3

  • T3

  • METH

  • null

  • RPR

  • EPON

  • WLAN-ESS

  • GPON

  • WLAN-DBSS

  • WLAN-MESH

  • VBDIF

  • NVE

  • CELLULAR

-

接口类型

-

serviceType

int32

-

-

接口成员口类型

-

providerNetwork

string

0~255个字符。

-

供应商

-

ifGroup

string

0~255个字符。

-

所属分组

-

ifMAC

string

0~48个字符。

-

MAC地址

-

trunkname

string

0~48个字符。

-

所属的trunk的trunkname

-

support.huaweicloud.com/qiankuncmn-qiankuncs/toctopics/zh-cn_topic_0000001244816271.html