华为云用户手册

URI /controller/campus/v1/sdwan/performance/site/link/list 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点标识，UUID格式，可由网络侧提供接口获取。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" metric 是 string - - 查询指标，该字段可以设置为以下几种： a) netstream：流量，单位是字节（Byte）。 b) packetloss：丢包，单位是百分比（%）。 c) jitter：抖动，单位是毫秒（ms）。 d) delay：时延，单位是毫秒（ms）。 如果查询多个指标用逗号分隔（如：netstream,delay）。 "packetloss" startTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的开始时间，UTC时间，直接调用URL，特殊符号参数需要手动转义，如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z" endTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的结束时间，UTC时间，直接调用URL，特殊符号参数需要手动转义，如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z"

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/performance/site/link/list?siteId=fbb684c8-0d37-496f-bafa-4b06d515j7l6&metric=packetloss&startTime=1985-04-12T23:20:50.052Z&endTime=1985-04-12T23:20:50.052Z 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

接口约束 1、该接口支持msp视图、租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、删除的站点中存在角色为gateway的站点，并且该gateway之前已经配置 了vpn的路由策略，则detach完成后，该站点的vpn路由策略会自动删除。 3、若Topology中已存在100个站点，删除hub、intermediate、border、serviceHub角色站点处理耗时长，建议先删除spoke角色站点，再删除上述角色的站点。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology/site-detachment 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 { "sites" : [ "00000000-0000-0000-0000-000000000001" ], "areaId" : "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 { "errcode" : "0", "errmsg" : "", "success" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "fail" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"] } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考SiteDetachmentResponse。 HTTP/1.1 202 Accepted 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

响应参数 返回状态码为200：配置成功，响应体参考QosDeviceResponse。 表4 QosDeviceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 成功的设备QoS带宽统计开销设置信息列表。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表5。 失败的设备QoS带宽统计开销设置信息列表。 - processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 - 表5 FailQosDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid" data REFERENCE 详细请参见表3。 失败的设备QoS带宽统计开销设置详细信息。 - 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考QosDeviceResponse。 返回状态码为204：执行成功，无响应体。 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/device/qos 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 { "qosPolicies" : [ { "deviceId" : "00000000-0000-0000-0000-00000000000", "qosOverHead" : "link" } ] }

响应示例 返回状态码为200：配置成功，响应体参考QosDeviceResponse。 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" : "", "success" : [ { "deviceId" : "00000000-0000-0000-0000-00000000000", "qosOverHead" : "link" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid", "data" : { "deviceId" : "00000000-0000-0000-0000-00000000000", "qosOverHead" : "link" } } ], "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考QosDeviceResponse。 HTTP/1.1 202 Accepted 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 返回状态码为204：执行成功，无响应体。 HTTP/1.1 204 No Content 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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 qosDeviceInfos 是 REFERENCE 详细请参见表2。 配置设备QoS带宽统计开销请求数据。 - 表2 QosDeviceInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 qosPolicies 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 设备QoS带宽统计开销设置详细信息。 - 表3 QosDeviceInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid - - 设备ID，UUID格式。 "00000000-0000-0000-0000-00000000000" qosOverHead 是 string 4~7个字符。 - 设备QoS带宽统计开销设置类型，该字段可以设置为以下几种： a) link：仅包括报文的链路层 b) physics：包括报文的物理层和链路层 "link"

响应参数 返回状态码为200：查询成功，响应体参考BatchQueryClassificationProfilesResponse。 表3 BatchQueryClassificationProfilesResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-100个列表项，详细请参见表9。 流量过滤策略信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考BatchQueryClassificationProfilesResponse。 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" : "", "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "app", "operator" : "and", "aclType" : "ipv4", "l3Acls" : [ { "priority" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePort" : 1, "sourcePortEnd" : 1, "destinationPort" : 1, "destinationPortEnd" : 1, "dscp" : 1, "protocolNum" : 1, "tcpFlag" : "ack,fin" } ], "applicationGroupIds" : [ "00000000-0000-0000-0000-000000000000" ], "enableVlanRange" : false, "vlanRange" : { "start" : 1, "end" : 4094 }, "enableP8021" : false, "p8021" : 1, "enableSourceMac" : false, "sourceMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableDestinationMac" : false, "destinationMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableL2Protocol" : false, "l2ProtocolNum" : "0x0800", "adn" : false, "experienceLevel" : "", "applyType" : "FW", "sourceIps" : [ "10.1.1.2/32" ], "sourceIpSets" : [ "sourceIp" ], "sourceDomainSets" : [ "domainSet" ], "destIps" : [ "10.1.1.2/32" ], "destIpSets" : [ "destIp" ], "destDomainSets" : [ "domainSet" ], "protocols" : [ { "name" : "TCP", "protocolNum" : 6, "srcPort" : "0-65535", "dstPort" : "0-65535" } ] } ] } 返回状态码为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的示例 POST /controller/campus/v1/sdwan/policy/traffic/classification-profiles/action/batch-query 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 { "ids" : [ "" ], "applyType" : "" }

账号简介 当前华为乾坤支持如下几类账号，请参见表1。 表1 账号类型说明 账号类型 说明 华为官网账号 当您使用已有的华为官网账号首次登录华为乾坤控制台时，该账号无法直接登录华为乾坤控制台，需要在华为乾坤控制台完成注册后再登录： 如果首次登录区域一控制台，请在“其他登录方式”中选择“华为官网账号”后，根据“华为乾坤资源调整及新用户注册指南”的提示信息注册后才可登录，具体请参见账号注册。 如果首次登录区域二控制台，系统会帮您自动创建同名账号，默认形式是“账号+（uniportal）”。 华为乾坤账号 用于登录华为乾坤控制台，是使用云服务的账号。 华为坤灵账号 仅在SOHO场景下使用，支持工程商通过坤灵账号登录华为乾坤控制台，进行远程运维和业务部署。 当前，部分复杂网络功能暂不支持在华为坤灵APP端操作，但是支持登录Web端进行操作。Web端支持操作的部分常见功能请参见表2。 表2 Web端支持操作的部分常见功能 分类 常用功能 详细说明 基础配置 远程登录设备Web页面 AR路由器和交换机（S210除外）在华为坤灵系统上线后，支持通过Web端跳转登录到设备Web页面。 LAN侧配置 链路聚合 将多个物理接口捆绑为一个逻辑接口，增加链路带宽，提升链路可靠性。 DHCP Snooping 保证DHCP客户端从合法的DHCP服务器获取IP地址，并记录DHCP客户端IP地址与MAC地址等参数的对应关系，防止网络上针对DHCP攻击。 运维 用户接入信息列表查看 支持查看接入网络的用户摘要信息，包括终端MAC地址、流量、时延、丢包、厂商类型等。 接口性能查看 支持显示接口信息，包括报文、流量、速率、宽带利用率等。 设备日志收集 支持下载设备日志文件。

响应示例 返回状态码为201：创建成功返回。 HTTP/1.1 201 Created 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" : 100, "data" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] } 返回状态码为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的示例 POST /controller/sdwan/v1/naas/virtual/device 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 { "deviceInfos" : [ { "parentId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "tenant1", "isExclusiveResource" : false, "vpnNumber" : 100, "bandWidth" : 100, "siteNumber" : 100, "sdwanBandwidth" : 100, "encryptedSdwanBandwidth" : 100, "vxlanBandwidth" : 100, "status" : 0, "role" : "Interworking Gateway", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 VirtualDevice 是 REFERENCE 详细请参见表2。 子设备信息。 - 表2 VirtualDeviceRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceInfos 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 子设备列表。 - 表3 VirtualDeviceInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 parentId 否 string 0~128个字符。 - 父设备ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 string 0~64个字符。 - 子设备ID, 创建时不使用。 "00000000-0000-0000-0000-000000000000" deviceName 否 string 1~63个字符。 - 子设备名称。 "tenant1" isExclusiveResource 否 boolean true false - 是否独占资源。 false vpnNumber 否 int32 [1-1024] - VPN数量。 100 bandWidth 否 int32 [10-10240] - 带宽，废弃，由sdwan带宽，sdwan加密带宽，vxlan带宽替代。 100 siteNumber 否 int32 [1-1024] - 站点数量。 100 sdwanBandwidth 否 int32 [0-10000] - sdwan带宽,Mbit/s。 100 encryptedSdwanBandwidth 否 int32 [0-2000] - sdwan加密带宽,Mbit/s。 100 vxlanBandwidth 否 int32 [0-10000] - VXLAN带宽,Mbit/s。 100 status 否 int32 [0-6] - 子设备状态，非配置字段，查询时返回。0：注册异常，1：上线异常，2：离线异常，3：在线，4：离线。 0 role 否 string 1~32个字符。 - 设备角色。取值范围：Interworking Gateway。不填默认Interworking Gateway。 "Interworking Gateway" siteId 否 string 1~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName 否 string 0~64个字符。 - 站点名称。 "site1"

响应参数 返回状态码为201：创建成功返回。 表4 VirtualDeviceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总数。 100 data ARRAY_REFERENCE 0-32个列表项，详细请参见表5。 子设备列表。 - 表5 VirtualDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 parentId string 0~128个字符。 - 父设备ID。 "00000000-0000-0000-0000-000000000000" deviceId string 0~64个字符。 - 子设备ID, 创建时不使用。 "00000000-0000-0000-0000-000000000000" deviceName string 1~63个字符。 - 子设备名称。 "tenant1" isExclusiveResource boolean true false - 是否独占资源。 false vpnNumber int32 [1-1024] - VPN数量。 100 bandWidth int32 [10-10240] - 带宽，废弃，由sdwan带宽，sdwan加密带宽，vxlan带宽替代。 100 siteNumber int32 [1-1024] - 站点数量。 100 sdwanBandwidth int32 [0-10000] - sdwan带宽,Mbit/s。 100 encryptedSdwanBandwidth int32 [0-2000] - sdwan加密带宽,Mbit/s。 100 vxlanBandwidth int32 [0-10000] - VXLAN带宽,Mbit/s。 100 status int32 [0-6] - 子设备状态，非配置字段，查询时返回。0：注册异常，1：上线异常，2：离线异常，3：在线，4：离线。 0 role string 1~32个字符。 - 设备角色。取值范围：Interworking Gateway。不填默认Interworking Gateway。 "Interworking Gateway" siteId string 1~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName string 0~64个字符。 - 站点名称。 "site1" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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-nat-address-group:snat-address-group" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "name", "mode" : "full-cone", "mode-pattern" : { "reverse-enable" : true, "address-zone" : "global" }, "sections" : { "section" : [ { "section-id" : 5, "start-ip" : "192.168.1.2", "end-ip" : "192.168.1.5" } ] }, "vrid" : 6, "port-block" : { "size" : 10, "extended-times" : 1, "start-port" : 1000, "end-port" : 1100 } } ] } 返回状态码为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

响应参数 返回状态码为200：操作成功。 表3 snat-address-group-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nat-address-group:snat-address-group ARRAY_REFERENCE 详细请参见表4。 源NAT地址池。 - 表4 nes-ne-snat-address-group对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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~34个字符。 - 源NAT地址池名称，单一主键字段。 "name" mode string pat no-pat full-cone pat NAT模式。 "full-cone" mode-pattern REFERENCE 详细请参见表5。 NAT模式扩展。AR6700V-L款型不支持。 - sections REFERENCE 详细请参见表6。 地址段。 - vrid int64 [1-255] - VRRP备份组号。AR6700V-L款型不支持。 6 port-block REFERENCE 详细请参见表8。 端口预分配。AR6700V-L款型不支持。 - 表5 mode-pattern对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 reverse-enable boolean true false true Servermap反向。 true address-zone string global local - 安全域。 "global" 表6 sections对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 section ARRAY_REFERENCE 详细请参见表7。 地址段列表。 - 表7 sections-section对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 section-id int32 [0-65535] - 地址段ID，单一主键字段。 5 start-ip string - - 起始IP地址。 "192.168.1.2" end-ip string - - 结束IP地址。 "192.168.1.5" 表8 port-block对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 size int32 [8-16384] - 预分配端口块大小。 10 extended-times int32 [1-3] - 增量分配的次数。 1 start-port int32 [0-65535] - 起始端口。 1000 end-port int32 [0-65535] - 结束端口。 1100 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nat-address-group:snat-address-group 表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的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-address-group:snat-address-group 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"

响应示例 返回状态码为201：接口调用成功，响应体参考GreTunnelResponse。 HTTP/1.1 201 Created 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" : "", "data" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "fc00:3::1/64", "srcIpAddress" : "192.168.1.1", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "destVpnId" : "00000000-0000-0000-0000-000000000000", "destWanLinkId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "key" : "123456", "checkSum" : "", "enableIpsec" : "", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "enableKeepAlive" : false, "period" : 5, "retryTimes" : 3, "mtu" : 1500 } ] } 返回状态码为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的示例 POST /controller/campus/v1/sdwan/net/site/inter/connect/gre/tunnel 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 { "greTunnelInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "fc00:3::1/64", "srcIpAddress" : "192.168.1.1", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "destVpnId" : "00000000-0000-0000-0000-000000000000", "destWanLinkId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "key" : "123456", "checkSum" : "", "enableIpsec" : "", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "enableKeepAlive" : false, "period" : 5, "retryTimes" : 3, "mtu" : 1500 } ] }

响应参数 返回状态码为201：接口调用成功，响应体参考GreTunnelResponse。 表4 GreTunnelResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表5。 成功添加或更新的GRE Tunnel配置。 - 表5 GreTunnelInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string - - 对应站点的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId string - - 对应设备的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" id string - - GRE Tunnel ID,更新,删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" tunnelPortName string - - GRE Tunnel端口名，不能重复。创建时必填。 "Tunnel0/0/400" wanLinkId string - - Wan链路的ID。和业务VPN ID二选一。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId string 0~64个字符。 - 业务VPN ID，和Wan链路的ID二选一。 "00000000-0000-0000-0000-000000000000" ipAddress string - - GRE隧道IP地址。创建时必填。 "fc00:3::1/64" srcIpAddress string - - GRE隧道源IP地址。创建时必填。 "192.168.1.1" srcInterfaceId string 0~64个字符。 - 源接口Id，对应LOOPBACK ID；与GRE隧道源IP地址二选一。 "00000000-0000-0000-0000-000000000000" destVpnId string 0~64个字符。 - 目的VPN ID，非必填。 "00000000-0000-0000-0000-000000000000" destWanLinkId string 0~64个字符。 - 目的WAN链路ID，非必填。 "00000000-0000-0000-0000-000000000000" dstIpAddress string - - GRE隧道目的IP地址。创建时必填。 "192.168.1.2" key string - - GRE Key。 "123456" checkSum boolean true false false GRE 校验和，创建时不填默认为false。 - enableIpsec boolean true false false GRE 是否启动IPSec，创建时不填默认为false。V600版本设备不支持使能IPSec。 - ipsecProfileId string - - IPSec模板ID, 启动IPSec时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" enableKeepAlive boolean true false false 是否使能隧道keepAlive能力。 false period int32 [1-32767] - 指定发送KeepAlive报文的定时器周期,整数形式，取值范围是1～32767，单位是秒。缺省值是5秒。KeepAlive使能后必须配置。 5 retryTimes int32 [1-255] - 指定不可达计数器参数,整数形式，取值范围是1～255。缺省值是3。KeepAlive使能后必须配置。 3 mtu int32 [1280-9000] 1500 MTU，取值范围：1280-9000，默认1500。 1500 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 greTunnelRequest 是 REFERENCE 详细请参见表2。 创建GRE Tunnel配置请求数据。 - 表2 GreTunnelRequest对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 greTunnelInfos 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 GRE Tunnel列表。 - 表3 GreTunnelInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string - - 对应站点的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 否 string - - 对应设备的ID。创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" id 否 string - - GRE Tunnel ID,更新,删除时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" tunnelPortName 否 string - - GRE Tunnel端口名，不能重复。创建时必填。 "Tunnel0/0/400" wanLinkId 否 string - - Wan链路的ID。和业务VPN ID二选一。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 string 0~64个字符。 - 业务VPN ID，和Wan链路的ID二选一。 "00000000-0000-0000-0000-000000000000" ipAddress 否 string - - GRE隧道IP地址。创建时必填。 "fc00:3::1/64" srcIpAddress 否 string - - GRE隧道源IP地址。创建时必填。 "192.168.1.1" srcInterfaceId 否 string 0~64个字符。 - 源接口Id，对应LOOPBACK ID；与GRE隧道源IP地址二选一。 "00000000-0000-0000-0000-000000000000" destVpnId 否 string 0~64个字符。 - 目的VPN ID，非必填。 "00000000-0000-0000-0000-000000000000" destWanLinkId 否 string 0~64个字符。 - 目的WAN链路ID，非必填。 "00000000-0000-0000-0000-000000000000" dstIpAddress 否 string - - GRE隧道目的IP地址。创建时必填。 "192.168.1.2" key 否 string - - GRE Key。 "123456" checkSum 否 boolean true false false GRE 校验和，创建时不填默认为false。 - enableIpsec 否 boolean true false false GRE 是否启动IPSec，创建时不填默认为false。V600版本设备不支持使能IPSec。 - ipsecProfileId 否 string - - IPSec模板ID, 启动IPSec时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" enableKeepAlive 否 boolean true false false 是否使能隧道keepAlive能力。 false period 否 int32 [1-32767] - 指定发送KeepAlive报文的定时器周期,整数形式，取值范围是1～32767，单位是秒。缺省值是5秒。KeepAlive使能后必须配置。 5 retryTimes 否 int32 [1-255] - 指定不可达计数器参数,整数形式，取值范围是1～255。缺省值是3。KeepAlive使能后必须配置。 3 mtu 否 int32 [1280-9000] 1500 MTU，取值范围：1280-9000，默认1500。 1500

响应示例 返回状态码为200：使能成功，返回体参考DeviceFreeRuleConfigResponse。 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" : "", "success" : [ { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "aclProfileId" : "50601b1c-c751-4072-9bca-2cf79b63bf70", "aclProfileName" : "acl", "freeRules" : [ { "ruleId" : 0, "sourceType" : "any", "sourceContent" : "192.168.1.1/32", "destType" : "any", "destContent" : "192.168.1.1/32" } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "aclProfileId" : "50601b1c-c751-4072-9bca-2cf79b63bf70", "aclProfileName" : "acl", "freeRules" : [ { "ruleId" : 0, "sourceType" : "any", "sourceContent" : "192.168.1.1/32", "destType" : "any", "destContent" : "192.168.1.1/32" } ] } } ] } 返回状态码为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 /controller/campus/rest/sdwan/v1/device/nac/free-rule 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 [ { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "aclProfileId" : "50601b1c-c751-4072-9bca-2cf79b63bf70", "aclProfileName" : "acl", "freeRules" : [ { "ruleId" : 0, "sourceType" : "any", "sourceContent" : "192.168.1.1/32", "destType" : "any", "destContent" : "192.168.1.1/32" } ] } ]

响应参数 返回状态码为200：使能成功，返回体参考DeviceFreeRuleConfigResponse。 表5 DeviceFreeRuleConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" success ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 成功的信息。 - fail ARRAY_REFERENCE 0-100个列表项，详细请参见表6。 失败的信息。 - 表6 FailDeviceFreeRuleConfigInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 失败的信息。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 requestBody 是 REFERENCE 详细请参见表2。 默认放行规则配置信息。 - 表2 DeviceFreeRuleConfigInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 DeviceFreeRuleConfigInfos 是 ARRAY_REFERENCE 0-2个列表项，详细请参见表3。 批量默认放行规则结构体。 - 表3 DeviceFreeRuleConfigInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" deviceId 是 string 0~36个字符。 - 设备ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" aclProfileId 否 string 0~36个字符。 - acl模板ID。V600设备不支持。V300设备不支持IPv6 ACL模板，且地址类型为 域名 的IPv4 ACL模板不生效。与freeRules不支持同时配置。 "50601b1c-c751-4072-9bca-2cf79b63bf70" aclProfileName 否 string 0~32个字符。 - acl模板名称，仅供查询显示，配置时无需填写。 "acl" freeRules 否 ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 规则列表，与aclProfileId不支持同时配置。 - 表4 FreeRuleDataInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ruleId 否 int32 [0-511] - Rule ID。 0 sourceType 否 string 0~36个字符。 - 源类型。 "any" sourceContent 否 string 0~128个字符。 - 源内容。 "192.168.1.1/32" destType 否 string 0~36个字符。 - 目的类型。 "any" destContent 否 string 0~128个字符。 - 目的内容。 "192.168.1.1/32"

响应示例 返回状态码为200：修改成功，响应体参考DomainSetResponse。 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" : "", "processInstanceId" : "", "success" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "domainNames" : [ "www.test.com" ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "domainNames" : [ "www.test.com" ] } } ] } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考DomainSetResponse。 HTTP/1.1 202 Accepted 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