华为云用户手册

  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-static-routing-ipv4:static-routing-ipv4/{destination-prefix}/{vpn-instance}/{next-hop-type} 表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" destination-prefix 是 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])/(([0-9])|([1-2][0-9])|(3[0-2]))。 - IPv4目的网段/掩码,联合主键字段。 "10.1.1.0/24" vpn-instance 是 string 1~31个字符。 - VPN,联合主键字段。 "vpn1" next-hop-type 是 string Ip Interface IpInterface black_hole - 下一跳类型,联合主键字段。 "Ip"
  • 响应示例 返回状态码为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 返回状态码为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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/nat/staticnat 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 { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "isUserDefined" : true, "externalIp" : "10.2.0.1", "internalIp" : "10.1.0.1", "translationType" : 1, "protocol" : "1", "externalPort" : 90, "internalPort" : 90, "addressMask" : 30, "advanceSetEnable" : false, "direction" : 1, "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] }
  • 响应示例 返回状态码为200:创建成功,响应体参考NatResponse。 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 { "errcode" : "0", "errmsg" : "", "data" : { "dynamicNatInfo" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "natMode" : "EASY_IP", "startAddress" : "192.168.1.1", "endAddress" : "192.168.1.2", "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ], "staticNatInfo" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "isUserDefined" : true, "externalIp" : "10.2.0.1", "internalIp" : "10.1.0.1", "translationType" : 1, "protocol" : "1", "externalPort" : 90, "internalPort" : 90, "addressMask" : 30, "advanceSetEnable" : false, "direction" : 1, "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ] } }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 静态NAT策略信息。 - 表2 StaticNatDetailModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyId 否 string 0~64个字符。 - 策略id。 创建时不需要填写。 "00000000-0000-0000-0000-000000000000" isOverlay 是 boolean true false - 是否Overlay NAT。 true:Overlay NAT; false,Underlay NAT。 true vpnId 是 string 0~64个字符。 - VPN业务ID。 Overlay NAT,填写WAN虚拟网络ID; Underlay NAT,填写“UnderlayId”。 "00000000-0000-0000-0000-000000000000" siteId 是 string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 string 0~64个字符。 - 部署静态NAT策略的CPE设备的ID。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 静态NAT策略的名称,创建时必填。 "policyName" linkId 是 string 0~64个字符。 - 使能NAT策略的接口ID。 Overlay NAT,填写LAN侧接口ip-subnet ID,如果在所有的Tunnel口上做NAT转换,填写"Overlay Tunnel"。 Underlay NAT,填写设备WAN链路的tnpId。 "00000000-0000-0000-0000-000000000000" interfaceName 否 string 0~64个字符。 - 接口名称,创建修改不需要填写,查询返回。 "GE0/0/8" isUserDefined 是 boolean true false - 是否用户自定义外部IP。 true,用户自定义; false,使用当前接口IP。 true externalIp 是 string 0~20个字符。 - 外部IP,NAT转换后的IP,一般是公网IP。 "10.2.0.1" internalIp 是 string 0~20个字符。 - 内部IP,NAT转换前的IP,一般是私网IP。 "10.1.0.1" translationType 是 int32 [0-1] - 转换类型,该字段可以设置为以下几种: a) 0:地址转换 b) 1:协议转换 当isUserDefined为false时,只能填写1。 1 protocol 否 string 0~10个字符。 - 协议,该字段可以设置为以下几种: a) 0:TCP b) 1:UDP c) 2:ICMP "1" externalPort 否 int32 [0-65535] - 外部端口,NAT转换后的端口号。 90 internalPort 否 int32 [0-65535] - 内部端口,NAT转换前的端口号。 90 addressMask 否 int32 [24-32] - addressMask,用户自定义时填写,范围24-32。 30 advanceSetEnable 是 boolean true false - 高级设置开关。 true:开启,方向和匹配规则设置生效; false:关闭。 false direction 否 int32 [0-2] - 方向,该字段可以设置为以下几种: a) 0:双向 b) 1:外部访问内部 c) 2:内部访问外部 1 natRuleInfos 否 ARRAY_REFERENCE 0-100个列表项,详细请参见表3。 规则信息。 -
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/session-whitelist/00000000-0000-0000-0000-000000000000/batch-delete 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 { "policies" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policy" } ] }
  • 响应示例 返回状态码为200:删除成功,响应体参考SessionWhitelistResponse。 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 { "errcode" : "0", "errmsg" : "", "data" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policy1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "ruleCount" : 1, "sessionWhitelistType" : "spr,firewall", "aclRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocolNum" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePortStart" : 1, "sourcePortEnd" : 1, "destinationPortStart" : 1, "destinationPortEnd" : 1 } ] } ] } 返回状态码为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
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sessionWhitelistDeleteInfo 是 REFERENCE 详细请参见表3。 待删除站点的请求数据。 - 表3 SessionWhitelistDeleteInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policies 否 ARRAY_REFERENCE 1-2个列表项,详细请参见表4。 待删除策略信息列表。 - 表4 SessionWhitelistDeleteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyId 是 uuid 1~36个字符。 - 策略id,必填。 "00000000-0000-0000-0000-000000000000" policyName 是 string 1~64个字符。 - 策略名称,必填。 "policy"
  • 配置密码策略缺省模板(仅V600版本AR设备) 表1 ConfigAaaPasswordChangeCheck模板参数解释 参数名称 类型 取值范围 参数解释 change-check Boolean 布尔型,具体取值如下: true。 false。 使能第一次配置的密码修改提醒功能。 true:使能初始密码修改提醒功能。 false:去使能初始密码修改提醒功能。 缺省情况下,密码修改提醒功能处于使能状态。配置为“false”后将会关闭密码修改提醒功能,关闭密码修改提醒功能后将存在安全风险,建议保持缺省状态。 下发到设备的命令: aaa undo password alert original //此命令对应“change-check”取值为“false”,去使能初始密码修改提醒功能。 父主题: iMaster NCE-Campus内置缺省模板参数介绍
  • 响应示例 返回状态码为200:接口调用成功,响应体参考WanLinkQualityResponse。 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 { "errcode" : "0", "errmsg" : "", "pageIndex" : 10, "pageSize" : 10, "total" : 10, "data" : [ { "siteId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "siteName" : "FWSite", "deviceId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "deviceName" : "FWDevice", "wanLink" : [ { "interfaceName" : "WanInterface", "wanLinkQuality" : [ { "timestamp" : 1537408636, "upwardRate" : 1537408636, "downwardRate" : 1537408636, "packetLoss" : 50, "delay" : 1537408636, "jitter" : 1537408636 } ] } ] } ] } 返回状态码为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
  • 响应参数 返回状态码为200:接口调用成功,响应体参考WanLinkQualityResponse。 表3 WanLinkQualityResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" pageIndex int32 [1-10000] - 页数。 10 pageSize int32 [1-50] - 每一页显示的条数。 10 total int32 [0-2208959999] - 总记录数。 10 data ARRAY_REFERENCE 0-50个列表项,详细请参见表4。 数据。 - 表4 FwWanLinkDevice对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 0~64个字符。 - 接入设备所在站点id。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" siteName string 0~256个字符。 - 接入设备所在站点名称。 "FWSite" deviceId string 0~64个字符。 - 接入设备id。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" deviceName string 0~256个字符。 - 接入设备名称。 "FWDevice" wanLink ARRAY_REFERENCE 0-50个列表项,详细请参见表5。 链路质量数据。 - 表5 FwWanLink对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 interfaceName string 0~256个字符。 - WAN口名称。 "WanInterface" wanLinkQuality ARRAY_REFERENCE 0-300个列表项,详细请参见表6。 链路质量数据。 - 表6 FwWanLinkQuality对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 timestamp int64 [0-2208959999] - 数据上报的格林威治时间(时间精度对应到秒)。 1537408636 upwardRate int64 [0-2208959999] - 接口上行速率,单位bps。 1537408636 downwardRate int64 [0-2208959999] - 接口下行速率,单位bps。 1537408636 packetLoss int64 [0-100] - 接口丢包率,百分比。 50 delay int64 [0-2208959999] - 接口时延时间,单位ms。 1537408636 jitter int64 [0-2208959999] - 接口抖动时间,单位ms。 1537408636 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryParam 是 REFERENCE 详细请参见表2。 查询参数。 - 表2 WanLinkQualityRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 否 string - tenant 查询维度,tenant---租户、site---站点、device---设备。 "tenant" id 否 string 0~64个字符。 - mode为device时该ID为设备ID,UUID格式;mode为site时,该ID为站点ID,UUID格式;mode为tenant时,该ID为空。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" pageIndex 否 int32 [1-10000] 1 页数。 10 pageSize 否 int32 [1-50] 10 每一页显示的条数。 10 startTime 否 int64 [0-2208959999] - 起始格林威治时间(时间精度对应到秒)。 startTime 与 endTime 约束规则如下: 租户维度支持查询15分钟内数据、站点维度支持查询1小时内数据、设备维度支持查询1天内数据 1537408636 endTime 否 int64 [0-2208959999] - 起始格林威治时间(时间精度对应到秒)。 startTime 与 endTime 约束规则如下: 租户维度支持查询15分钟内数据、站点维度支持查询1小时内数据、设备维度支持查询1天内数据 1537408636
  • 请求示例 HTTP的示例 POST /controller/campus/api/v1/performance/interface/fw/wanlink/quality 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 { "mode" : "tenant", "id" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "pageIndex" : 10, "pageSize" : 10, "startTime" : 1537408636, "endTime" : 1537408636 }
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bd:bd 是 REFERENCE 详细请参见表4。 Bridge Domain配置参数。 -
  • 请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bd:bd/10 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-bd:bd" : { "bd-id" : 10, "vni" : 10, "vlan-id" : 10, "split-horizon" : "disable" } }
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bd:bd/{bd-id} 表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" bd-id 是 int64 [1-16777215] - Bridge Domain ID,单一主键字段。 "10"
  • 响应示例 返回状态码为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 返回状态码为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
  • 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"
  • 请求示例 HTTP的示例 DELETE /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"
  • 响应示例 返回状态码为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 返回状态码为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
  • 响应参数 返回状态码为200:删除成功,响应体参考DeletePnfUrlFilterPolicyResponse。 表3 DeletePnfUrlFilterPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-1000个列表项,详细请参见表5。 成功的URL过滤策略信息列表。 - fail ARRAY_REFERENCE 0-1000个列表项,详细请参见表4。 失败的URL过滤策略信息列表。 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:删除成功,响应体参考DeletePnfUrlFilterPolicyResponse。 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 { "errcode" : "0", "errmsg" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "UrlFilterPolicy", "defaultAction" : "permit", "blackUrls" : [ "www.example.com" ], "whiteUrls" : [ "www.example.com" ], "level" : "high", "customFilters" : [ { "cid" : 1, "classification" : "P2P", "action" : "permit" } ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "UrlFilterPolicy", "defaultAction" : "permit", "blackUrls" : [ "www.example.com" ], "whiteUrls" : [ "www.example.com" ], "level" : "high", "customFilters" : [ { "cid" : 1, "classification" : "P2P", "action" : "permit" } ] } } ] } 返回状态码为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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/security/url-filter-manager/action/batch-delete 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 { "urlFilterPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "UrlFilterPolicy", "defaultAction" : "permit", "blackUrls" : [ "www.example.com" ], "whiteUrls" : [ "www.example.com" ], "level" : "high", "customFilters" : [ { "cid" : 1, "classification" : "P2P", "action" : "permit" } ] } ] }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 urlFilterPolicyInfos 是 REFERENCE 详细请参见表2。 删除请求体,请求信息中仅包含对应的URL过滤策略ID即可。 - 表2 PnfUrlFilterPolicyInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 urlFilterPolicies 否 ARRAY_REFERENCE 1-100个列表项,详细请参见表2。 URL过滤策略列表 -
  • 请求示例 HTTP的示例 PATCH /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" { "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 } } ] } }
  • 响应示例 返回状态码为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 返回状态码为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
  • 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_"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:vpn-bgp 是 REFERENCE 详细请参见表4。 VPN BGP配置。 -
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/apmesh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/mesh?pageIndex=1&pageSize=20 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
  • 响应示例 返回状态码为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 { "errcode" : "0", "errmsg" : "", "data" : { "pageIndex" : 1, "pageSize" : 20, "totalPage" : 10, "totalRecords" : 10, "ApmeshList" : [ { "meshId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "name" : "apmesh", "radio2point4gEnable" : false, "radio5gEnable" : false, "radio5gSecondEnable" : false, "scene" : "single", "maxLinkNum" : 32, "meshRouteAgingTime" : 5, "whiteListEnable" : false, "whiteList" : [ "XX:XX:XX:XX:XX:XX" ], "vlan" : "1", "memberDeviceInfos" : [ { "deviceName" : "AirEngine6760R-51_FBF792C3", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceEsn" : "AA02353VUTFIOJNKGG13", "deviceStatus" : 3, "deviceMeshRole" : "mpp", "meshConfigRole" : "mpp", "meshRouteAgingTime" : 5 } ] } ] } } 返回状态码为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
共99354条