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

时间:2025-02-17 11:37:57

响应参数

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

表2 ApiIfQueryResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

error_code

int32

-

0

错误码。

"0"

error_msg

string

0-255个字符

Successful.

错误消息。

"Successful"

totalCount

int32

-

-

符合当前条件的总个数

1

nextmarker

string

0-255个字符

-

下一片反馈信息

""

ApiIfDataList

ARRAY_REFERENCE

详细请参见表3

接口列表

-

表3 ApiIfData对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

nedn

string

1~255个字符。

-

设备DN

"e46412b1-003a-385c-bd10-6c218ce09ef4"

interfaceId

string

0~255个字符。

-

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

"4451b04d-64b7-4d5a-aadc-637387068d57"

ifIndex

integer

-

-

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

"668"

ifDesc

string

1~255个字符。

-

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

"XGigabitEthernet1/8/0/0"

ifAlias

string

0~255个字符。

-

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

"Link to remote"

ipAddress

string

0~255个字符。

-

ip地址

"10.136.10.66/24"

ifOperStatus

string

  • UP

  • DOWN

  • TESTING

  • UNKNOWN

  • DORMANT

  • NOTPRESENT

  • LOWLAYERDOWN

-

接口运行态

"UP"

ifAdminStatus

string

  • UP

  • DOWN

  • PLANNING

-

接口管理态, 可修改

"DOWN"

ifSpeed

string

0~255个字符。

-

接口速率

"20G"

ifRemark

string

0~255个字符。

-

备注,可修改

"接口备注"

ifMtu

string

0~255个字符。

-

MTU

"1500"

ifDuplexMode

string

  • FULL

  • HALF

  • AUTO

  • AUTOFULL

  • AUTOHALF

-

双工模式

"FULL"

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

-

接口类型

"ETHERNET"

serviceType

int32

-

-

接口成员口类型

0

providerNetwork

string

0~255个字符。

-

供应商

Huawei

ifGroup

string

0~255个字符。

-

所属分组

1

ifMAC

string

0~48个字符。

-

MAC地址

"**-**-**-**-7E-9F"

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