本文导读

典型场景
接口功能
接口约束
调用方法
URI
请求参数
请求示例
响应参数
响应示例

展开导读

文档首页/ 华为乾坤/ 云管理网络/ API参考/ 接口参考/ 开放可编程接口/ 设备配置/ 业务配置/ 接口配置/ 批量查询接口

批量查询接口

更新时间：2025-02-17 GMT+08:00

查看PDF

典型场景

批量查询接口。

接口功能

批量查询接口。

接口约束

该接口支持msp视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V和AR6700V子设备；

或者支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V-L款型和V600系列设备。

调用方法

GET

URI

/restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ifm:interface

表1 path参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
id	是	string	36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。	-	设备ID。	"00000000-0000-0000-0000-000000000000"

请求参数

表2 header参数列表
参数名称	必选	类型	参数值域	默认值	参数说明	参数示例
restconf-transaction-id	否	string	-	-	事务ID。	"00000000-0000-0000-0000-000000000000"

请求示例

HTTP的示例

GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ifm:interface HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-ACCESS-TOKEN: x-yyyyyy
restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

响应参数

返回状态码为200：操作成功。

表3 interface-list对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
huawei-nce-e-ifm:interface	ARRAY_REFERENCE	详细请参见表4。		接口配置参数。	-

表4 nes-ne-interface对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
config-status	string	reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed	reserved	配置状态，对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态；不支持编辑，仅查询返回。	"configured-database-success"
last-committed-time	string	0~255个字符。	-	最后提交时间，该特性最后提交时间；不支持编辑，仅查询返回。	"2022-01-01 00:00:00"
related-pkg-version	string	0~255个字符。	-	包版本，插件包版本；不支持编辑，仅查询返回。	"1.0.1"
edit-state	string	RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED	-	编辑状态，对应运行状态、候选状态、取消部署状态、未部署状态；不支持编辑，仅查询返回。	"RUNNING"
name	string	1~63个字符。	-	接口名称。名称规则：接口类别为主接口时，由物理类型、接口号拼接而成，如GE0/0/0、LoopBack1，接口类别为子接口时，由父接口名称、英文点、接口号拼接而成，如GE0/0/0.1、LoopBack1.1，单一主键字段。	"10GE0/0/0"
ifm-class	string	main-interface sub-interface	-	接口类别，主接口或子接口。	"main-interface"
type	string	GigabitEthernet GEBrief 10GE LoopBack Eth-Trunk Tunnel Vlanif 25GE 40GE 100GE 400GE Vbdif Nve	-	物理类型，AR6700V支持范围：GE、Nve、Vbdif、LoopBack。	"10GE"
parent-if-name	string	1~63个字符。	-	父接口名称，当接口类别为子接口时配置。	"10GE0/0/0"
number	string	1~63个字符。	-	接口号。物理类型为GE时，格式为A/B/C，其他物理类型时格式为数字。	"0/0/0"
level	string	L3 L2	-	接口类型，L2或L3，AR6700V仅支持L3。	"L3"
vpn-instance	string	1~31个字符。	_public_	接口所属的VPN，当接口类型为L3时配置。GE口、Vbdif绑定的VPN互斥，Nve口仅能绑定GE口已经绑定的VPN。	"vpn1"
admin-status	string	down up	-	接口的管理状态。该节点支持的能力因接口类型而异。	"down"
description	string	1~242个字符。	-	接口描述。	"the interface for underlay"
bandwidth	REFERENCE	详细请参见表5。		带宽配置。	-
trunk	REFERENCE	详细请参见表6。		Eth-Trunk成员，AR6700V不支持。	-
ethernet	REFERENCE	详细请参见表8。		接口物理属性，AR6700V不支持。	-

表5 bandwidth对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
bandwidth	int64	[1-1000000]	-	带宽Mbps。	20
bandwidth-kbps	int64	[1-1000000]	-	带宽Kbps。AR6700V-L款型不支持。	20

表6 trunk对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
members	ARRAY_REFERENCE	详细请参见表7。		Eth-Trunk成员。	-

表7 trunk-members对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
interface-name	string	1~63个字符。	-	接口名称，单一主键字段。	"10GE0/0/0"

表8 ethernet对象的参数列表
参数名称	类型	参数值域	默认值	参数说明	参数示例
negotiation-mode	string	enabled disabled	-	协商模式。	"enabled"
combo-mode	string	copper fiber	-	接口工作模式。	"copper"
duplex	string	full half	-	双工模式。	"full"
speed	string	10M 100M 1000M 10G 25G 40G 100G 400G	-	速率。	"1000M"

返回状态码为400：请求参数错误。

详细信息请参见实际响应消息体。

返回状态码为500：内部错误。

详细信息请参见实际响应消息体。

响应示例

返回状态码为200：操作成功。

HTTP/1.1 200 OK
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
	"huawei-nce-e-ifm:interface" : [
		{
			"config-status" : "configured-database-success",
			"last-committed-time" : "2022-01-01 00:00:00",
			"related-pkg-version" : "1.0.1",
			"edit-state" : "RUNNING",
			"name" : "10GE0/0/0",
			"ifm-class" : "main-interface",
			"type" : "10GE",
			"parent-if-name" : "10GE0/0/0",
			"number" : "0/0/0",
			"level" : "L3",
			"vpn-instance" : "vpn1",
			"admin-status" : "down",
			"description" : "the interface for underlay",
			"bandwidth" : {
				"bandwidth" : 20,
				"bandwidth-kbps" : 20
			},
			"trunk" : {
				"members" : [
					{
						"interface-name" : "10GE0/0/0"
					}
				]
			},
			"ethernet" : {
				"negotiation-mode" : "enabled",
				"combo-mode" : "copper",
				"duplex" : "full",
				"speed" : "1000M"
			}
		}
	]
}

返回状态码为400：请求参数错误。

HTTP/1.1 400 Bad Request
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

返回状态码为500：内部错误。

HTTP/1.1 500 Internal Server Error
Date: Sun,16 Feb 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive

父主题： 接口配置

上一篇：查询接口指定的接口

下一篇：修改指定的接口

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

批量查询接口

典型场景

接口功能

接口约束

调用方法

URI

请求参数

请求示例

响应参数

响应示例

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线

文档反馈