华为云用户手册

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 NAT Server策略信息。 - 表2 NatServerInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 natServerInfos 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表3。 NAT Server的详细信息。 - 表3 NatServerInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 string 0~36个字符。 - VPN业务ID，创建时必填。 Overlay，填写WAN虚拟网络ID； Underlay，填写“UnderlayId”。 "00000000-0000-0000-0000-000000000000" siteId 否 string 0~64个字符。 - 站点ID，创建时必填。 "00000000-0000-0000-0000-000000000000" deviceId 否 string 0~64个字符。 - 设备ID，创建时必填。 "00000000-0000-0000-0000-000000000000" policyId 否 string 0~64个字符。 - 策略ID，创建时不需要填写，修改时必填。 "00000000-0000-0000-0000-000000000000" policyName 否 string 0~64个字符。 - 策略名称，创建时必填。 "test name" globalStartAddress 否 string 0~20个字符。 - 服务器映射的公网起始地址，修改场景需要指定。 "192.168.1.1" globalEndAddress 否 string 0~20个字符。 - 服务器映射的公网结束地址，修改场景需要指定。 "192.168.1.2" insideStartAddress 否 string 0~20个字符。 - 服务器映射的私网起始地址，修改场景需要指定。 "192.168.1.1" insideEndAddress 否 string 0~20个字符。 - 服务器映射的私网结束地址，修改场景需要指定。 "192.168.1.2" globalSourcePort 否 int32 [0-65535] - 公网起始端口，修改场景需要指定。 "1" globalEndPort 否 int32 [0-65535] - 公网结束端口，修改场景需要指定。 "2" insideSourcePort 否 int32 [0-65535] - 私网起始端口，修改场景需要指定。 "1" insideEndPort 否 int32 [0-65535] - 私网结束端口，修改场景需要指定。 "2" protocol 否 string 满足正则表达1|6|17|41|47|50|51|132。 - 报文协议类型，包括1(ICMP)、6(TCP)、17(UDP)、41(IPv6)、47(GRE)、50(ESP)、51(AH)、132(SCTP)。 "6" reverse 否 boolean true false true 创建反向server-map。默认值为true。 true interfaceId 否 string 0~64个字符。 - 接口id,Overlay 目的NAT SASE场景不支持配置接口ID。 "00000000-0000-0000-0000-000000000000" interfaceName 否 string 0~64个字符。 - 接口名称，Overlay 目的NAT SASE场景不支持配置接口名称。 "GE0/0/0"

响应示例 返回状态码为200：接口执行成功 HTTP/1.1 200 OK { "errorCode": 0, "errorMsg": null, "topoNodes": [ { "nodeId": "eb2d57d5-e56a-4867-b9a5-1e5915ba5e85", "tenantId": null, "siteId": null, "resType": "preDeployAp", "name": "AP-536", "remark": null, "parentNodeId": "d681914f-af8a-4e67-9e0d-199cc2fcf745", "posX": 42.0, "posY": 723.0, "longitude": null, "latitude": null }, { "nodeId": "1be6d950-df08-4893-a515-f9eee403bfd5", "tenantId": null, "siteId": null, "resType": "preDeployAp", "name": "AP-535", "remark": null, "parentNodeId": "d681914f-af8a-4e67-9e0d-199cc2fcf745", "posX": 42.0, "posY": 677.0, "longitude": null, "latitude": null } ], "totalSize": 2 } 返回状态码为400：参数错误 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403：URL鉴权 HTTP/1.1 403 Forbidden Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404：rest接口没找到 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为406：流控限流 HTTP/1.1 406 Not Acceptable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：默认ServiceException异常码，应用内部错误 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为502：网关错误 HTTP/1.1 502 Bad Gateway Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为503：服务不可用 HTTP/1.1 503 Service Unavailable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为504：表示时间超时，总线超时时间300s HTTP/1.1 504 Gateway Timeout Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /rest/openapi/network/wlan/region-topo/node-list 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 params 是 string 0~8192个字符。 - 查询拓扑节点的过滤条件(参数项含义可参考OpenApiTopoNodeQueryModel模型)。 必填参数项：page、limit、siteId(站点Id，已规划站点时必填，其他场景不填该参数)。 可选参数项：sortColumn、sortMode、parentNodeId、resTypes、name、remark、posX、poxY、longitude、latitude。 {"page" : 1, "limit" : 20, "sortColumn" : "name", "sortMode" : "asc", "parentNodeId" : "3", "resTypes" : [ "Region" ], "name" : "test", "remark" : "", "posX" : 954, "poxY" : 305, "longitude" : 0.0, "latitude" : 0.0}

响应参数 返回状态码为200：接口执行成功 表2 OpenApiTopoNodeListResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 状态码 - errorMsg string - - 新增、修改、删除异常时的错误信息 - totalSize int32 - - 拓扑节点总数 - topoNodes ARRAY_REFERENCE 详细请参见表3。 拓扑节点列表 - 表3 OpenApiTopoNodeBaseModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nodeId string - - 对象ID - tenantId string - - 租户ID - siteId string - - 站点ID - resType string - - 资源类型 - name string - - 对象名称 - remark string - - 描述信息 - parentNodeId string - - 父节点ID - posX double - - 节点的X坐标 - posY double - - 节点的Y坐标 - longitude double - - 经度 - latitude double - - 纬度 - 返回状态码为400：参数错误 详细信息请参见实际响应消息体。 返回状态码为403：URL鉴权 详细信息请参见实际响应消息体。 返回状态码为404：rest接口没找到 详细信息请参见实际响应消息体。 返回状态码为406：流控限流 详细信息请参见实际响应消息体。 返回状态码为500：默认ServiceException异常码，应用内部错误 详细信息请参见实际响应消息体。 返回状态码为502：网关错误 详细信息请参见实际响应消息体。 返回状态码为503：服务不可用 详细信息请参见实际响应消息体。 返回状态码为504：表示时间超时，总线超时时间300s 详细信息请参见实际响应消息体。

请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-AC CES S-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/network/wlan/region-topo/node-list?params={page : 1, limit : 20, sortColumn : name, sortMode : asc, parentNodeId : 3, resTypes : [ Region ], name : test, remark : , posX : 954, poxY : 305, longitude : 0.0, latitude : 0.0}' HTTP的示例 GET /rest/openapi/network/wlan/region-topo/node-list?params={page : 1, limit : 20, sortColumn : name, sortMode : asc, parentNodeId : 3, resTypes : [ Region ], name : test, remark : , posX : 954, poxY : 305, longitude : 0.0, latitude : 0.0} 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

PBR缺省模板介绍（仅V300版本AR设备支持） 表1 CreateAdvanceACL模板参数解释 参数名称 类型 取值范围 参数解释 acl_operator String merge、remove 创建或删除一条ACL策略。 merge：创建。 remove：删除。 acl_name String 1～64 ACL策略名称，不支持空格，区分大小写，记录的名称不能含有“@”、“%”、“*”等特殊字符。 permit_rule_operator String merge、replace、remove 创建、修改或删除当前ACL的permit规则。 如果source_IP和destination_IP不填，也可以不填。 merge：创建。 replace：修改。 remove：删除。 permit_rule_name Int 0～4294967294 permit规则名称。 permit_source_ip String IPv4地址 ACL permit规则匹配报文的源地址。 permit_destination_ip String IPv4地址 ACL permit规则匹配报文的目的地址。 deny_rule_operator String merge、replace、remove 创建、修改或删除当前ACL的deny规则。 merge：创建。 replace：修改。 remove：删除。 deny_rule_name Int 0～4294967294 deny规则名称。 deny_source_ip String IPv4地址 ACL deny规则匹配报文的源地址。 deny_destination_ip String IPv4地址 ACL deny规则匹配报文的目的地址。 下发到设备的命令行： acl rule name acl_name rule permit_rule_name permit ip source permit_source_ip destination permit_destination_ip rule deny_rule_name deny ip source deny_source_ip destination deny_destination_ip 表2 CreateStaticRouting模板参数解释： 参数名称 类型 取值范围 参数解释 route_operator String merge、remove 创建或删除静态路由。 merge：创建。 remove：删除。 source_vpn_instance String 1～31 源VPN实例名称，必须是设备上已经创建的VPN实例。 dest_ip_address String IPv4地址 目的IP地址及掩码长度。 dest_vpn_instance String 1～31 目的VPN实例名称，必须是设备上已经创建的VPN实例。 只有V300R19C13SPC200之后版本的设备支持通过CreateStaticRouting模板下发配置。 下发到设备的命令行： ip route-static vpn-instance source_vpn_instance dest_ip_address vpn-instance dest_vpn_instance 表3 CreateTrafficClassifierAndBehavior模板参数解释 参数名称 类型 取值范围 参数解释 cls_operator String merge、remove 创建或删除流分类。 merge：创建。 remove：删除。 cls_name String 1～31 流分类名。 不支持空格，区分大小写，记录的名称不能含有“@”、“%”、“*”等特殊字符。 match_acl_operator String merge、remove 创建或删除流分类的匹配规则。 merge：创建。 remove：删除。 acl_name String - 流分类匹配的ACL名称或编号，设备上已存在的ACL名称。 beh_operator String merge、remove 创建流行为或删除流行为。 merge：创建。 remove：删除。 beh_name String 1～31 流行为名称。 filter_action String permit、deny 流行为的报文过滤规则，如果不配置，默认为permit规则。 redirect_operator String merge、replace、remove 配置、修改或删除流行为重定向功能。 merge：创建。 replace：修改。 remove：删除。 redirect_vpn String 1～31 重定向的VPN实例名称，必须是设备上已经创建的VPN实例。 下发到设备的命令行： traffic classfier cls_name operator or if-match acl acl_name traffic behavior beh_name deny traffic behavior beh_name redirect vpn-instance redirect_vpn 表4 CreateTrafficPolicy模板参数解释 参数名称 类型 取值范围 参数解释 policy_name String 1～31 流策略名称，不支持空格，区分大小写，记录的名称不能含有“@”、“%”、“*”等特殊字符。 policy_operator String merge、remove 创建或删除流策略。 merge：创建。 remove：删除。 rule_operator String merge、replace、remove 对流策略绑定的流分类和流行为做配置、修改还是删除。 merge：创建。 replace：修改。 remove：删除。 cls_name String 1～31 流策略绑定的流分类名称，设备上已经存在的流分类。 beh_name String 1～31 流策略绑定的流行为名称，设备上已经存在的流行为。 rule_precedence String 0～100 流策略的优先级。 下发到设备的命令行： traffic policy policy_name match-extended classifier cls_name behavior beh_name 表5 InterfaceStatisticEnable模板参数解释 参数名称 类型 取值范围 参数解释 statistic_direction String both、inbound、outbound 流量统计功能应用在接口的方向。 both：将流量统计功能同时应用在接口的出方向和入方向。 inbound：将流量统计功能同时应用在接口的入方向。 outbound：将流量统计功能同时应用在接口的出方向。 operation String merge、remove 在接口下使能/去使能应用流量统计。 interface_name1 String - 应用流量统计功能的接口，必须是设备上存在的接口。 下发到设备的命令行： interface interface_name1 statistic enable inbound statistic enable outbound 表6 TrafficPolicyBindInterface模板参数解释 参数名称 类型 取值范围 参数解释 traffic_policy String 1～31 应用的流策略名称，必须是备上存在的流策略名称。 operation String remove、merge 在接口上绑定或解除绑定流策略。 merge：在接口上绑定流策略。 remove：在接口上解除绑定流策略。 interface_name1 String - 绑定流策略的接口，必须是设备上存在的接口名称。 下发到设备的命令行： interface interface_name1 traffic-policy traffic_policy inbound 父主题： iMaster NCE-Campus内置缺省模板参数介绍

响应参数 返回状态码为200：站点内HACA模板绑定信息，响应体参考HacaBindInfoResponse。 表2 HacaBindInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" total int32 [0-100000] - 总数。 35 data ARRAY_REFERENCE 0-64个列表项，详细请参见表3。 返回消息体的具体信息 - 表3 DeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 32~36个字符。 - 设备id。 "55fc4f3b-4f20-48c9-ab4c-28a281384ce1" deviceName string 0~128个字符。 - 设备名称。 "device11" deviceEsn string 0~64个字符。 - 设备ESN。 "0002353AJS0000000000" deviceModel string 0~512个字符。 - 设备型号。 "S6730-H24X6C" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：站点内HACA模板绑定信息，响应体参考HacaBindInfoResponse。 HTTPS 200 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "total":1, "data": [ { "id": "55fc4f3b-4f20-48c9-ab4c-28a281384ce1", "deviceName": "设备1", "deviceEsn": "0002353AJS0000000000", "deviceModel": "S6730-H24X6C" } ] } 返回状态码为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的示例 GET /controller/campus/api/campusaccesscfgservice/v1/lswauth/haca/bind?templateId=ca3c4f3b-4f20-48c9-ab4c-28a281384795&pageIndex=1&pageSize=10&sort=-deviceName&keyword=test 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

URI /controller/campus/api/campusaccesscfgservice/v1/lswauth/haca/bind 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 templateId 否 string 32~36个字符。 - 模板id。 "ca3c4f3b-4f20-48c9-ab4c-28a281384795" pageIndex 否 int32 [1-100000] - 当前页码。 1 pageSize 否 int32 [5-200] - 分页大小。 10 sort 否 string 0~128个字符。 - 排序。deviceName/-deviceName "-deviceName" keyword 否 string 0~32个字符。 - 关键字，支持按设备名称过滤 "test"

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-if:nat-if/GE0%2F0%2F3 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 { "huawei-nce-e-nat-if:nat-if" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "if-name" : "GE0/0/3", "nat-enable" : true } ] } 返回状态码为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-nat-if:nat-if/{if-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" if-name 是 string 1~63个字符。 - Interface name. "GE0/0/3"

请求示例 HTTP的示例 POST /v1/perfservice/alarms/shield-alarms/white-list 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 { "alarmIds" : [ "" ] }

响应参数 返回状态码为200：创建告警屏蔽规则成功后的状态返回码。 表3 CommonOut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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：查询成功，响应体参考QueryQosDeviceResponse。 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" : "", "totalRecords" : 10, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "deviceId" : "00000000-0000-0000-0000-00000000000", "qosOverHead" : "link" } ] } 返回状态码为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：查询成功，响应体参考QueryQosDeviceResponse。 表2 QueryQosDeviceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 10 pageSize int32 - - 分页大小。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 设备QoS带宽统计开销设置信息。 - 表3 QosDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId uuid - - 设备ID，UUID格式。 "00000000-0000-0000-0000-00000000000" qosOverHead string 4~7个字符。 - 设备QoS带宽统计开销设置类型，该字段可以设置为以下几种： a) link：仅包括报文的链路层 b) physics：包括报文的物理层和链路层 "link" 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/device/qos?deviceId=00000000-0000-0000-0000-00000000000 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：接口调用成功，响应体参考ManufactureVlanConfigResponse，返回的默认管理口VLAN1配置。 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" : ["00000000-0000-0000-0000-000000000000"], "fail" : ["00000000-0000-0000-0000-000000000000"] } 返回状态码为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的示例 PUT /controller/campus/v1/sdwan/overlay-network/bridge-domains/action/clear-manufacture-vlan 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 { "siteIds" : ["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: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"

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,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/query-list 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 { "pageIndex" : 1, "pageSize" : 20, "sort" : "-policyName", "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "policyId" : "00000000-0000-0000-0000-00000000000", "policyName" : "natPolicy", "deviceName" : "deviceName", "interfaceName" : "GE0/0/1" }

响应示例 返回状态码为200：查询成功，响应体参考QueryStaticNatResponse。 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" : { "totalRecords" : 1, "data" : [ { "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：查询成功，响应体参考QueryStaticNatResponse。 表3 QueryStaticNatResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码，0表示成功，非0表示失败。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表4。 静态NAT集合结构体。 - 表4 QueryStaticNatResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 totalRecords int32 [0-10000] - 返回记录条数。 1 data ARRAY_REFERENCE 0-10000个列表项，详细请参见表8。 静态NAT集合结构体。 -

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表2。 查询条件 - 表2 QueryStaticNatCondition对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-65535] - 当前页数，默认是1。 1 pageSize 否 int32 [1-100] - 每页查询数量，默认是20。 20 sort 否 string 0~25个字符。 - 排序字段，可以使用policyName对StaticNatDetailModel进行正反排序，反向排序加减号前缀。 "-policyName" 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" policyId 否 string 0~64个字符。 - 策略ID。 "00000000-0000-0000-0000-00000000000" policyName 否 string 0~64个字符。 - 策略名称，支持模糊匹配。 "natPolicy" deviceName 否 string 0~64个字符。 - 设备名称。 "deviceName" interfaceName 否 string 0~64个字符。 - 接口名称。支持填写LAN接口名称或Overlay tunnel口。 "GE0/0/1"

响应参数 返回状态码为200：接口调用成功，响应体参考QueryBgpRouteResponse。 表2 QueryBgpRouteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-2个列表项，详细请参见表26。 BGP路由信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。