-
响应示例 返回状态码为200:接口调用成功,响应体参考QueryExternalPortResponse。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"errcode" : "0",
"errmsg" : "",
"totalRecords" : 200,
"pageSize" : 20,
"pageIndex" : 1,
"data" : [
{
"id" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6",
"name" : "Connect to PE",
"siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6",
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6",
"portId" : "fbb684c8-0d37-496f-bafa-4b06d515a7l6",
"isSubInterface" : true,
"vlanId" : 2,
"isEnableMpls" : true,
"ipConnection" : {
"ipv4" : {
"ipMode" : "Static",
"customerAddress" : "192.168.0.1",
"prefixLength" : 24
}
},
"attributes" : {
"mtu" : 1500,
"TCPmss" : 1200
},
"description" : ""
}
]
} 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 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,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/external-ports?pageIndex=1&pageSize=20&sort=name&siteId=a99f794e-b510-438c-a75d-de59f02347eb&id=a99f794e-b510-438c-a75d-de59f02347eb HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
Accept-Language: en-US
X-AC
CES S-TOKEN: x-yyyyyy
-
响应参数 返回状态码为200:接口调用成功,响应体参考QueryExternalPortResponse。 表2 QueryExternalPortResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 每页显示数量。 20 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表8。 外部接口信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
-
URI /controller/campus/v1/sdwan/overlay-network/external-ports 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-65535] 1 当前页数,默认是1。 1 pageSize 否 int32 [0-65535] 20 每页显示数量,默认是20,当为空或者为0时,表示不使用。 20 sort 否 string 0~255个字符。 - 排序字段,默认情况下不排序,未使用。 "name" siteId 否 uuid - - 站点ID,不指定外部接口ID时,必须指定。格式是uuid。 "a99f794e-b510-438c-a75d-de59f02347eb" id 否 uuid - - 外部接口ID。格式是uuid。 "a99f794e-b510-438c-a75d-de59f02347eb"
-
URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:dhcpv4-if 表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"
-
请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-if 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:操作成功。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 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,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ifm:interface 是 REFERENCE 详细请参见表4。 接口配置参数。 -
-
响应示例 返回状态码为200:操作成功。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 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,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ifm:interface/10GE0%2F0%2F0 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"
{
"huawei-nce-e-ifm:interface" : {
"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"
}
}
}
-
URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ifm:interface/{name} 表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" name 是 string 1~63个字符。 - 接口名称。名称规则:接口类别为主接口时,由物理类型、接口号拼接而成,如GE0/0/0、LoopBack1,接口类别为子接口时,由父接口名称、英文点、接口号拼接而成,如GE0/0/0.1、LoopBack1.1,单一主键字段。 "10GE0/0/0"
-
请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-l3-sub-interface:l3-sub-interface 是 REFERENCE 详细请参见表4。 l3 sub interface parameters - 表4 nes-ne-l3-sub-interface-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-l3-sub-interface:l3-sub-interface 否 REFERENCE 详细请参见表5。 l3 sub interface parameters - 表5 l3-sub-interface-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 if-name 否 string 1~63个字符。 - Interface name "Vbdif20.20" dot1q-vlans 否 REFERENCE 详细请参见表6。 Configure dot1q termination. - vlan-type-dot1q 否 REFERENCE 详细请参见表7。 Configure VLAN-type dot1q. - 表6 dot1q-vlans-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vlan-list 否 string 满足正则表达((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])?(-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))?(,((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])(-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))?))*)|((([\\+|\\-](409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))|([\\+|\\-]\\((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\\)))?(,(([\\+|\\-](409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))|([\\+|\\-]\\((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\\))))*)。 - Dot1q termination VLAN ID list. The VLAN in VLAN-list can not exist in the VLAN-list of dot1q-VLANs-group. "20" 表7 vlan-type-dot1q-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vlan-type-vid 否 int32 [1-4094] - VLAN ID of the VLAN sub-interface; 20
-
请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-l3-sub-interface:l3-sub-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"
{
"huawei-nce-e-l3-sub-interface:l3-sub-interface" : {
"if-name" : "Vbdif20.20",
"dot1q-vlans" : {
"vlan-list" : "20"
},
"vlan-type-dot1q" : {
"vlan-type-vid" : 20
}
}
}
-
响应示例 返回状态码为200:操作成功。 HTTP/1.1 200 OK
Date: Sun,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request
Date: Sun,11 May 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,11 May 2025 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
-
URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-l3-sub-interface:l3-sub-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"