-
响应示例 返回状态码为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-bgp:bgp 表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"
-
接口约束 该接口支持msp视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V和AR6700V子设备; 或者支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V-L款型。 该API可能会直接或间接影响现网业务运行,导致业务中断、关键数据丢失等,请谨慎操作!
-
请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bgp:bgp 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
restconf-transaction-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-bgp:vpn-bgp/_public_ 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
{
"huawei-nce-e-bgp:vpn-bgp" : [
{
"config-status" : "configured-database-success",
"last-committed-time" : "2022-01-01 00:00:00",
"related-pkg-version" : "1.0.1",
"edit-state" : "RUNNING",
"vpn-instance" : "_public_",
"router-id" : "10.1.0.0",
"ipv4-unicast" : {
"enable" : true,
"default-route-import" : true,
"route-select-delay" : 10,
"reflector-cluster-id" : 10,
"reflect-change-path" : true,
"auto-frr" : true,
"mode" : "be",
"down-switch" : true,
"route-relay-tunnel-v6-selector" : "policy1",
"preference" : {
"external" : 10,
"internal" : 10,
"local" : 10
},
"aggregate-route" : [
{
"address" : "192.168.1.1",
"mask" : 24
}
],
"network-route" : [
{
"address" : "192.168.1.2",
"mask" : 24,
"route-policy" : "policy1"
}
],
"import-routing" : [
{
"protocol" : "static",
"thead-id" : 10,
"cost" : 10,
"route-policy" : "policy1"
}
],
"evpn" : {
"srv6" : {
"mode" : "be",
"down-switch" : true
},
"locator" : [
{
"name" : "name"
}
]
},
"advertise-l2-evpn" : {
"advertise-route-to-evpn" : [
{
"protocol" : "all",
"advertise-route-mode" : "all"
}
]
},
"locator" : [
{
"name" : "name"
}
]
},
"ipv6-unicast" : {
"enable" : true,
"default-route-import" : true,
"route-select-delay" : 10,
"reflector-cluster-id" : 10,
"reflect-change-path" : true,
"auto-frr" : true,
"mode" : "be",
"down-switch" : true,
"route-relay-tunnel-v6-selector" : "policy1",
"preference" : {
"external" : 10,
"internal" : 10,
"local" : 10
},
"aggregate-route" : [
{
"address" : "fc00::7",
"mask" : 96
}
],
"network-route" : [
{
"address" : "fc00::7",
"mask" : 96
}
],
"import-routing" : [
{
"protocol" : "static",
"thead-id" : 10,
"cost" : 10,
"route-policy" : "policy1"
}
],
"evpn" : {
"srv6" : {
"mode" : "be",
"down-switch" : true
},
"locator" : [
{
"name" : "name"
}
]
},
"advertise-l2-evpn" : {
"advertise-route-to-evpn" : [
{
"protocol" : "all",
"advertise-route-mode" : "all"
}
]
},
"locator" : [
{
"name" : "name"
}
],
"locator-routes" : [
{
"locator-name" : "name"
}
]
},
"ipv4-vpn" : {
"enable" : true,
"policy-vpntarget" : true
},
"l2vpn-evpn" : {
"enable" : true,
"policy-vpn-target" : true,
"reflect-change-path" : true
},
"link-state-unicast" : {
"enable" : "True",
"domain-identifier" : "192.168.1.1",
"reflector-cluster-id" : 10
},
"ipv6-srpolicy" : {
"enable" : "True",
"nexthop-select-depend-type" : "default",
"router-id-filter" : true
},
"bgp-peer" : [
{
"peer-ip" : "192.168.1.1",
"peer-as" : "1",
"local-as-number" : "1",
"local-if-name" : "GE0/0/0",
"local-if-address" : "192.168.1.1",
"ebgp-max-hop" : 10,
"auth-type" : "password",
"password-type" : "cipher",
"password-text" : "Example@123",
"key-chain-name" : "aa",
"timer" : {
"keep-alive-time" : 10,
"host-time" : 10,
"connect-retry-time" : 10
},
"ipv4-unicast" : {
"enable" : true,
"allow-as-loop" : 1,
"advertise-community" : true,
"advertise-ext-community" : true,
"nexthop-config" : "local",
"prefix-sid" : "default",
"reflect-client" : true,
"export-route-policy" : "policy1",
"import-route-policy" : "policy1",
"route-update-interval" : 10
},
"ipv6-unicast" : {
"enable" : true,
"allow-as-loop" : 1,
"advertise-community" : true,
"advertise-ext-community" : true,
"nexthop-config" : "local",
"prefix-sid" : "default",
"reflect-client" : true,
"export-route-policy" : "policy1",
"import-route-policy" : "policy1"
},
"ipv4-vpn" : {
"enable" : true,
"export-route-policy" : "policy1",
"import-route-policy" : "policy1"
},
"l2vpn-evpn" : {
"enable" : true,
"reflect-client" : true,
"export-route-policy" : "policy1",
"import-route-policy" : "policy1"
},
"link-state-unicast" : {
"enable" : "True",
"reflect-client" : true,
"export-route-policy" : "policy1"
},
"ipv6-srpolicy" : {
"enable" : "True",
"reflect-client" : true,
"advertise-ext-community" : true,
"graceful-restart-static-timer" : 3600
},
"bfd" : {
"enable" : true,
"multiplier" : 3,
"min-rx-interval" : 10,
"min-tx-interval" : 10
}
}
]
}
]
} 返回状态码为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-bgp:vpn-bgp/{vpn-instance} 表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" vpn-instance 是 string 1~31个字符。 - VPN,单一主键字段。 "_public_"
-
响应示例 返回状态码为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-bgp:vpn-bgp 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-bgp:vpn-bgp" : {
"vpn-instance" : "_public_",
"router-id" : "10.1.0.0",
"ipv4-unicast" : {
"enable" : true,
"default-route-import" : true,
"route-select-delay" : 10,
"reflector-cluster-id" : 10,
"reflect-change-path" : true,
"auto-frr" : true,
"mode" : "be",
"down-switch" : true,
"route-relay-tunnel-v6-selector" : "policy1",
"preference" : {
"external" : 10,
"internal" : 10,
"local" : 10
},
"aggregate-route" : [
{
"address" : "192.168.1.1",
"mask" : 24
}
],
"network-route" : [
{
"address" : "192.168.1.2",
"mask" : 24,
"route-policy" : "policy1"
}
],
"import-routing" : [
{
"protocol" : "static",
"thead-id" : 10,
"cost" : 10,
"route-policy" : "policy1"
}
],
"evpn" : {
"srv6" : {
"mode" : "be",
"down-switch" : true
},
"locator" : [
{
"name" : "name"
}
]
},
"advertise-l2-evpn" : {
"advertise-route-to-evpn" : [
{
"protocol" : "all",
"advertise-route-mode" : "all"
}
]
},
"locator" : [
{
"name" : "name"
}
]
},
"ipv6-unicast" : {
"enable" : true,
"default-route-import" : true,
"route-select-delay" : 10,
"reflector-cluster-id" : 10,
"reflect-change-path" : true,
"auto-frr" : true,
"mode" : "be",
"down-switch" : true,
"route-relay-tunnel-v6-selector" : "policy1",
"preference" : {
"external" : 10,
"internal" : 10,
"local" : 10
},
"aggregate-route" : [
{
"address" : "fc00::7",
"mask" : 96
}
],
"network-route" : [
{
"address" : "fc00::7",
"mask" : 96
}
],
"import-routing" : [
{
"protocol" : "static",
"thead-id" : 10,
"cost" : 10,
"route-policy" : "policy1"
}
],
"evpn" : {
"srv6" : {
"mode" : "be",
"down-switch" : true
},
"locator" : [
{
"name" : "name"
}
]
},
"advertise-l2-evpn" : {
"advertise-route-to-evpn" : [
{
"protocol" : "all",
"advertise-route-mode" : "all"
}
]
},
"locator" : [
{
"name" : "name"
}
],
"locator-routes" : [
{
"locator-name" : "name"
}
]
},
"ipv4-vpn" : {
"enable" : true,
"policy-vpntarget" : true
},
"l2vpn-evpn" : {
"enable" : true,
"policy-vpn-target" : true,
"reflect-change-path" : true
},
"link-state-unicast" : {
"enable" : "True",
"domain-identifier" : "192.168.1.1",
"reflector-cluster-id" : 10
},
"ipv6-srpolicy" : {
"enable" : "True",
"nexthop-select-depend-type" : "default",
"router-id-filter" : true
},
"bgp-peer" : [
{
"peer-ip" : "192.168.1.1",
"peer-as" : "1",
"local-as-number" : "1",
"local-if-name" : "GE0/0/0",
"local-if-address" : "192.168.1.1",
"ebgp-max-hop" : 10,
"auth-type" : "password",
"password-type" : "cipher",
"password-text" : "Example@123",
"key-chain-name" : "aa",
"timer" : {
"keep-alive-time" : 10,
"host-time" : 10,
"connect-retry-time" : 10
},
"ipv4-unicast" : {
"enable" : true,
"allow-as-loop" : 1,
"advertise-community" : true,
"advertise-ext-community" : true,
"nexthop-config" : "local",
"prefix-sid" : "default",
"reflect-client" : true,
"export-route-policy" : "policy1",
"import-route-policy" : "policy1",
"route-update-interval" : 10
},
"ipv6-unicast" : {
"enable" : true,
"allow-as-loop" : 1,
"advertise-community" : true,
"advertise-ext-community" : true,
"nexthop-config" : "local",
"prefix-sid" : "default",
"reflect-client" : true,
"export-route-policy" : "policy1",
"import-route-policy" : "policy1"
},
"ipv4-vpn" : {
"enable" : true,
"export-route-policy" : "policy1",
"import-route-policy" : "policy1"
},
"l2vpn-evpn" : {
"enable" : true,
"reflect-client" : true,
"export-route-policy" : "policy1",
"import-route-policy" : "policy1"
},
"link-state-unicast" : {
"enable" : "True",
"reflect-client" : true,
"export-route-policy" : "policy1"
},
"ipv6-srpolicy" : {
"enable" : "True",
"reflect-client" : true,
"advertise-ext-community" : true,
"graceful-restart-static-timer" : 3600
},
"bfd" : {
"enable" : true,
"multiplier" : 3,
"min-rx-interval" : 10,
"min-tx-interval" : 10
}
}
]
}
}
-
请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:vpn-bgp 是 REFERENCE 详细请参见表4。 VPN BGP配置。 - 表4 nes-ne-vpn-bgp-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:vpn-bgp 否 REFERENCE 详细请参见表5。 VPN BGP配置。 - 表5 vpn-bgp-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpn-instance 否 string 1~31个字符。 - VPN,单一主键字段。 "_public_" router-id 否 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - Router ID。 "10.1.0.0" ipv4-unicast 否 REFERENCE 详细请参见表6。 IPv4地址族。 - ipv6-unicast 否 REFERENCE 详细请参见表17。 IPv6地址族,6700V子设备不支持。 - ipv4-vpn 否 REFERENCE 详细请参见表28。 VPNv4地址族,AR6700V主设备不支持。 - l2vpn-evpn 否 REFERENCE 详细请参见表29。 L2 EVPN,AR6700V主设备不支持。 - link-state-unicast 否 REFERENCE 详细请参见表30。 BGP-LS,AR6700V主设备和AR6700V子设备不支持。 - ipv6-srpolicy 否 REFERENCE 详细请参见表31。 IPv6 SR-Policy,AR6700V主设备和AR6700V子设备不支持。 - bgp-peer 否 ARRAY_REFERENCE 详细请参见表32。 BGP对等体。 - 表6 nes-ne-vpn-bgp-ipv4-unicast-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能IPv4地址族,AR6700V主设备不支持。 true default-route-import 否 boolean true false - 引入默认路由,AR6700V主设备不支持。 true route-select-delay 否 int32 [0-3600] - 延迟路由回切(秒),AR6700V主设备不支持。 10 reflector-cluster-id 否 int64 [1-4294967295] - 反射器集群ID,AR6700V主设备不支持。 10 reflect-change-path 否 boolean true false - 反射器改变路径,AR6700V主设备不支持。 true auto-frr 否 boolean true false - Auto frr,AR6700V主设备不支持。 true mode 否 string be te - SRv6 模式,AR6700V主设备和AR6700V子设备不支持。 "be" down-switch 否 boolean true false - TE隧道发生故障切换TE到BE,AR6700V主设备和AR6700V子设备不支持。 true route-relay-tunnel-v6-selector 否 string 1~40个字符。 - 隧道选择器,AR6700V主设备不支持。 "policy1" preference 否 REFERENCE 详细请参见表7。 优先级,AR6700V主设备不支持。 - aggregate-route 否 ARRAY_REFERENCE 详细请参见表8。 聚合路由,AR6700V主设备不支持。 - network-route 否 ARRAY_REFERENCE 详细请参见表9。 网段路由。 - import-routing 否 ARRAY_REFERENCE 详细请参见表10。 引入路由。 - evpn 否 REFERENCE 详细请参见表11。 EVPN,AR6700V主设备和AR6700V子设备不支持。 - advertise-l2-evpn 否 REFERENCE 详细请参见表14。 通告 L2 EVPN,AR6700V主设备不支持。 - locator 否 ARRAY_REFERENCE 0-1个列表项,详细请参见表16。 Locator,AR6700V主设备和AR6700V子设备不支持。 - 表7 ipv4-unicast-preference-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 external 否 int32 [1-255] - 外部优先级。 10 internal 否 int32 [1-255] - 内部优先级。 10 local 否 int32 [1-255] - 本地优先级。 10 表8 ipv4-unicast-aggregate-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 聚合路由地址,联合主键字段。 "192.168.1.1" mask 否 int32 [0-32] - 聚合路由掩码,联合主键字段。 24 表9 ipv4-unicast-network-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 网段路由地址,联合主键字段。 "192.168.1.2" mask 否 int32 [0-32] - 网段路由掩码,联合主键字段。 24 route-policy 否 string 1~200个字符。 - 路由策略。 "policy1" 表10 ipv4-unicast-import-routing-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 protocol 否 string direct ospf isis static rip unr op-route - 引入路由协议,联合主键字段。 "static" thead-id 否 int64 [0-4294967295] - 进程 ID,联合主键字段。 10 cost 否 int64 [0-4294967295] - 花销。 10 route-policy 否 string 1~200个字符。 - 路由策略。 "policy1" 表11 ipv4-unicast-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 srv6 否 REFERENCE 详细请参见表12。 SRv6 模式。 - locator 否 ARRAY_REFERENCE 0-1个列表项,详细请参见表13。 Locator。AR6700V-L款型不支持。 - 表12 evpn-srv6-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 否 string be te - SRv6 模式。 "be" down-switch 否 boolean true false - TE隧道发生故障切换TE到BE。 true 表13 evpn-locator-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表14 ipv4-unicast-advertise-l2-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 advertise-route-to-evpn 否 ARRAY_REFERENCE 详细请参见表15。 通告 L2 EVPN。 - 表15 advertise-route-to-evpn-type-advertise-route-to-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 protocol 否 string all - 路由协议,单一主键字段。 "all" advertise-route-mode 否 string all best valid - VPN向evrf发布路由模式,AR6700V子设备不支持。 "all" 表16 ipv4-unicast-locator-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表17 nes-ne-vpn-bgp-ipv6-unicast-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能IPv6地址族,AR6700V主设备不支持。 true default-route-import 否 boolean true false - 引入默认路由,AR6700V主设备不支持。 true route-select-delay 否 int32 [0-3600] - 延迟路由回切(秒),AR6700V主设备不支持。 10 reflector-cluster-id 否 int64 [1-4294967295] - 反射器集群ID,AR6700V主设备不支持。 10 reflect-change-path 否 boolean true false - 反射器改变路径,AR6700V主设备不支持。 true auto-frr 否 boolean true false - Auto frr,AR6700V主设备不支持。 true mode 否 string be te - SRv6 模式,AR6700V主设备不支持。 "be" down-switch 否 boolean true false - TE隧道发生故障切换TE到BE,AR6700V主设备不支持。 true route-relay-tunnel-v6-selector 否 string 1~40个字符。 - 隧道选择器,AR6700V主设备不支持。 "policy1" preference 否 REFERENCE 详细请参见表18。 优先级,AR6700V主设备不支持。 - aggregate-route 否 ARRAY_REFERENCE 详细请参见表19。 聚合路由,AR6700V主设备不支持。 - network-route 否 ARRAY_REFERENCE 详细请参见表20。 网段路由 - import-routing 否 ARRAY_REFERENCE 详细请参见表21。 引入路由。 - evpn 否 REFERENCE 详细请参见表22。 EVPN,AR6700V主设备不支持。 - advertise-l2-evpn 否 REFERENCE 详细请参见表25。 通告 L2 EVPN,AR6700V主设备不支持。 - locator 否 ARRAY_REFERENCE 详细请参见表26。 配置SRv6 locator,AR6700V主设备不支持。 - locator-routes 否 ARRAY_REFERENCE 详细请参见表27。 Locator 路由,AR6700V主设备不支持。 - 表18 ipv6-unicast-preference-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 external 否 int32 [1-255] - 外部优先级。 10 internal 否 int32 [1-255] - 内部优先级。 10 local 否 int32 [1-255] - 本地优先级。 10 表19 ipv6-unicast-aggregate-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 聚合路由地址,联合主键字段。 "fc00::7" mask 否 int32 [0-128] - 聚合路由掩码,联合主键字段。 96 表20 ipv6-unicast-network-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address 否 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 网段路由地址,联合主键字段。 "fc00::7" mask 否 int32 [0-128] - 网段路由掩码,联合主键字段。 96 表21 ipv6-unicast-import-routing-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 protocol 否 string direct isis static ospfv3 ripng unr - 引入路由协议,联合主键字段。 "static" thead-id 否 int64 [0-4294967295] - 进程 ID,联合主键字段。 10 cost 否 int64 [0-4294967295] - 花销。 10 route-policy 否 string 1~200个字符。 - 路由策略。 "policy1" 表22 ipv6-unicast-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 srv6 否 REFERENCE 详细请参见表23。 SRv6。 - locator 否 ARRAY_REFERENCE 0-1个列表项,详细请参见表24。 Locator。AR6700V-L款型不支持。 - 表23 srv6对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 否 string be te - SRv6 模式。 "be" down-switch 否 boolean true false - TE隧道发生故障切换TE到BE。 true 表24 unicast-evpn-locator-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表25 ipv6-unicast-advertise-l2-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 advertise-route-to-evpn 否 ARRAY_REFERENCE 详细请参见表15。 通告 L2 EVPN。 - 表26 ipv6-unicast-locator-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表27 ipv6-unicast-locator-routes-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 locator-name 否 string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表28 nes-ne-vpn-bgp-ipv4-vpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能VPNv4地址族。 true policy-vpntarget 否 boolean true false - 对接收到的VPN路由启用/禁用基于VPN目标的过滤。只有导出RT属性与本地导入RT属性匹配的VPN路由才能添加到路由表中。该选项可用于Kompella方式的跨域VPN Option B解决方案和ASBR MP-EBGP跨域L2VPN解决方案。 true 表29 nes-ne-vpn-bgp-l2vpn-evpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能L2 EVPN。 true policy-vpn-target 否 boolean true false - 配置VPN Target。 true reflect-change-path 否 boolean true false - 反射器改变路径,AR6700V子设备不支持。 true 表30 nes-ne-vpn-bgp-link-state-unicast-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 string - - 使能BGP-LS。 "True" domain-identifier 否 string - - 区域标识符,IPv4地址格式。 "192.168.1.1" reflector-cluster-id 否 int64 [1-4294967295] - 反射器集群ID。 10 表31 nes-ne-vpn-bgp-ipv6-srpolicy-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 string - - 使能IPv6 SR-Policy。 "True" nexthop-select-depend-type 否 string default depend-ip - 下一跳迭代到IP地址时路由参与选路。 "default" router-id-filter 否 boolean true false - Router ID过滤。 true 表32 nes-ne-vpn-bgp-bgp-peer-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 peer-ip 否 string - - 对端IPv4或IPv6地址,单一主键字段。 "192.168.1.1" peer-as 否 string 1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。 - 对端AS。 "1" local-as-number 否 string 1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。 - 本端伪AS号。 "1" local-if-name 否 string 1~63个字符。 - 接口名称。 "GE0/0/0" local-if-address 否 string - - 接口地址。 "192.168.1.1" ebgp-max-hop 否 int64 [1-255] - EBGP允许最大跳数。 10 auth-type 否 string null password keychain - 认证方式。 "password" password-type 否 string cipher simple - 密码类型。 "cipher" password-text 否 string 1~432个字符。 - 密码。 "Example@123" key-chain-name 否 string 1~47个字符。满足正则表达[^A-Z]+。 - key-chain。 "aa" timer 否 REFERENCE 详细请参见表39。 保活时间。 - ipv4-unicast 否 REFERENCE 详细请参见表33。 IPv4地址族。 - ipv6-unicast 否 REFERENCE 详细请参见表34。 IPv6地址族,AR6700V主设备和AR6700V子设备不支持。 - ipv4-vpn 否 REFERENCE 详细请参见表35。 VPNv4地址族,AR6700V主设备不支持。 - l2vpn-evpn 否 REFERENCE 详细请参见表36。 L2 EVPN,AR6700V主设备不支持。 - link-state-unicast 否 REFERENCE 详细请参见表37。 BGP-LS,AR6700V主设备和AR6700V子设备不支持。 - ipv6-srpolicy 否 REFERENCE 详细请参见表38。 IPv6 SR-Policy,AR6700V主设备和AR6700V子设备不支持。 - bfd 否 REFERENCE 详细请参见表40。 BFD。 - 表33 ipv4-unicast对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能IPv4地址族。 true allow-as-loop 否 int32 [1-10] - AS号的重复次数。 1 advertise-community 否 boolean true false - 发布团体属性。 true advertise-ext-community 否 boolean true false - 发布扩展团体属性。 true nexthop-config 否 string local invariable - 下一跳配置。 "local" prefix-sid 否 string default enable disable - 使能/去使能设备与指定的IPv6对等体交换IPv4前缀SID。 "default" reflect-client 否 boolean true false - 使能/去使能本端设备作为路由反射器(RR),将对等体或对等体组作为其客户端。此配置仅适用于IBGP对等体之间。地址族中的RR及其客户端的配置仅在该地址族中有效。因此,建议将RR及其客户端配置在所需的指定地址族中。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" import-route-policy 否 string 1~200个字符。 - 引入路由策略,路由策略名称。 "policy1" route-update-interval 否 int32 [0-600] - 路由更新间隔(秒)。 10 表34 ipv6-unicast对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能IPv6地址族。 true allow-as-loop 否 int32 [1-10] - AS号的重复次数。 1 advertise-community 否 boolean true false - 发布团体属性。 true advertise-ext-community 否 boolean true false - 发布扩展团体属性。 true nexthop-config 否 string local invariable - 下一跳配置。 "local" prefix-sid 否 string default enable disable - 使能/去使能设备与指定的IPv6对等体交换IPv4前缀SID。 "default" reflect-client 否 boolean true false - 使能/去使能本端设备作为路由反射器(RR),将对等体或对等体组作为其客户端。此配置仅适用于IBGP对等体之间。地址族中的RR及其客户端的配置仅在该地址族中有效。因此,建议将RR及其客户端配置在所需的指定地址族中。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" import-route-policy 否 string 1~200个字符。 - 引入路由策略,路由策略名称。 "policy1" 表35 ipv4-vpn对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能VPNv4地址族。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" import-route-policy 否 string 1~200个字符。 - 引入路由策略,路由策略名称。 "policy1" 表36 l2vpn-evpn对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能L2 EVPN。 true reflect-client 否 boolean true false - RR反射,AR6700V子设备不支持。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" import-route-policy 否 string 1~200个字符。 - 引入路由策略,路由策略名称。AR6700V子设备不支持。 "policy1" 表37 link-state-unicast对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 string - - 使能BGP-LS。 "True" reflect-client 否 boolean true false - RR反射。 true export-route-policy 否 string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" 表38 ipv6-srpolicy对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 string - - 使能IPv6 SR-Policy。 "True" reflect-client 否 boolean true false - RR反射。 true advertise-ext-community 否 boolean true false - 发布扩展团体属性。 true graceful-restart-static-timer 否 int64 [3600-2147483647] - 等待对端GR恢复的最大时间。 3600 表39 timer-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 keep-alive-time 否 int32 [0-21845] - 存活时间(秒)。 10 host-time 否 int32 [0-65535] - 存持时间(秒)。 10 connect-retry-time 否 int32 [1-65535] - 连接重传时间(秒)。 10 表40 bfd-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能BFD。 true multiplier 否 int64 [3-50] - 本地检测倍数。 3 min-rx-interval 否 int64 [3-20000] - 最小接收间隔(毫秒)。 10 min-tx-interval 否 int64 [3-20000] - 最小发送间隔(毫秒)。 10
-
URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bgp:vpn-bgp 表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"
-
响应示例 返回状态码为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的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bgp:bgp 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-bgp:bgp" : {
"config-status" : "configured-database-success",
"last-committed-time" : "2022-01-01 00:00:00",
"related-pkg-version" : "1.0.1",
"edit-state" : "RUNNING",
"local-as" : "65001",
"graceful-restart-enable" : true
}
}
-
请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:bgp 是 REFERENCE 详细请参见表4。 BGP配置。 - 表4 bgp-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:bgp 否 REFERENCE 详细请参见表5。 BGP配置。 - 表5 bgp对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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" local-as 否 string 1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。 - 本地AS,6700V子设备不支持。 "65001" graceful-restart-enable 否 boolean true false false GR 使能,AR6700V主设备和AR6700V子设备不支持。 true
-
URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bgp:bgp 表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"