华为云用户手册

响应参数 返回状态码为200：查询成功返回。 表2 QueryLinkOspfResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表9。 查询返回的OSPF邻居信息。兼容升级，后续废弃。 - OspfInterfaceList ARRAY_REFERENCE 0-8个列表项，详细请参见表3。 OSPF邻居信息列表。 - 表3 LinkOspfInterface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 36个字符。 - 设备ID。 "6ef14414-99d7-4062-9de5-1183dbd87f27" deviceName string 0~128个字符。 - 设备名称。 "Device" deviceType string 0~10个字符。 - 设备类型。 "Core" processId int32 [1-20000] - 网关侧OSPF进程号，必填。取值范围：1-20000。 10 routerId string 0~64个字符。 - 用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。兼容升级场景，废弃字段。 "192.168.1.1" configSource string 0~32个字符。 - 配置源 "LANWAN" OspfIntfInfo REFERENCE 详细请参见表14。 OSPF路由信息。 - 返回状态码为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-route-policy:community-filter" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "filter1", "filter-type" : "basic", "basic-node" : [ { "sequence" : 1, "match-mode" : "permit", "community-member" : [ { "value" : "1:1" } ] } ] } ] } 返回状态码为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 community-filter-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:community-filter ARRAY_REFERENCE 详细请参见表4。 团体属性过滤器配置参数。 - 表4 nes-ne-community-filter对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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-99，字符串形式时1-51个字符且不能都是数字，单一主键字段。 "filter1" filter-type string basic advanced - 过滤类型。 "basic" basic-node ARRAY_REFERENCE 1-65535个列表项，详细请参见表5。 节点。 - 表5 nes-ne-community-filter-basic-node对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 sequence int64 [1-4294967295] - 序号，单一主键字段。 1 match-mode string permit deny - 匹配类型。 "permit" community-member ARRAY_REFERENCE 0-20个列表项，详细请参见表6。 团体属性。 - 表6 nes-ne-community-filter-basic-node-community-member对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 value string - - 团体值，取值范围为0-65535:0-65535 或 1-4294967040 或 4294967044-4294967295，单一主键字段。 "1:1" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:community-filter 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"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:community-filter 表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-route-policy:route-policy HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

响应示例 返回状态码为200：操作成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:route-policy 表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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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

请求示例 HTTP的示例 POST /controller/campus/v3/config/configsave 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" : "e33db980-848a-4b1d-a347-425580f0b7f3", "saveAll" : true, "deviceIds" : [ "d623ead6-a2cc-4c3c-9039-dcc8fa898a60" ] }

响应示例 返回状态码为200：接口调用成功，响应体参考QueryBgpPeerResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 1, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ] } ] } 返回状态码为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 /controller/campus/v1/sdwan/routing-protocol/bgp-peer-info 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid - - VPN ID。查询vpnv4 bgp时不填，其余场景vpnId与tnpId二者必填其一，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - TNP ID。查询vpnv4 bgp时不填，其余场景vpnId与tnpId二者必填其一，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 uuid - - 设备ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" pageIndex 否 int32 [1-65535] 1 当前页，默认值为1。 1 pageSize 否 int32 [1-100] 20 每页显示数量，默认值为20。 20 keyword 否 string 0~64个字符。 - 查询对端IP，支持模糊查询。 "192.168.2.21"

响应参数 返回状态码为200：接口调用成功，响应体参考QueryBgpPeerResponse。 表2 QueryBgpPeerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码：0 表示接口执行成功，非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" totalRecords integer - - 总数据条数。 1 pageSize integer - - 每页显示数量，默认20。 20 pageIndex integer - - 当前页，从1开始。 1 data ARRAY_REFERENCE 0-2个列表项，详细请参见表5。 BGP路由信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/bgp-peer-info?vpnId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&deviceId=a99f794e-b510-438c-a75d-de59f02347eb&pageIndex=1&pageSize=20&keyword=192.168.2.21 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,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-ipv4:ipv4" : [ { "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" : "Vbdif1", "address-type" : "address", "access-type" : "Static", "address" : "10.10.1.1", "mask" : 24, "unnumbered-if-name" : "LoopBack1", "mtu" : 1500, "sub-address" : [ { "address" : "10.10.1.2", "mask" : 24 } ] } ] } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ipv4:ipv4 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-ipv4:ipv4 表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：操作成功。 表3 ipv4-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ipv4:ipv4 ARRAY_REFERENCE 详细请参见表4。 接口IPv4配置参数。 - 表4 nes-ne-ipv4对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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" if-name string 1~63个字符。 - 接口名称，AR6700V仅支持类型为Vbdif、LoopBack的接口，单一主键字段。 "Vbdif1" address-type string address unnumbered - 地址类型。 "address" access-type string Static DHCP - 接入类型。 "Static" 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}]+)?。 - IPv4地址，当接口类型为Static时允许配置。 "10.10.1.1" mask int32 [1-32] - 掩码。 24 unnumbered-if-name string 1~63个字符。 - 借用接口名称，当地址类型为unnumbered时允许配置。 "LoopBack1" mtu int32 [46-9600] 1500 MTU，接口类型为Nve、LoopBack时不支持。 1500 sub-address ARRAY_REFERENCE 详细请参见表5。 IPv4从地址，AR6700V不支持。 - 表5 nes-ne-ipv4-sub-address对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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}]+)?。 - IPv4从地址，单一主键字段。 "10.10.1.2" mask int32 [1-32] - 掩码。 24 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 flowGlobalInput 否 REFERENCE 详细请参见表2。 全局配置入参 - 表2 FlowGlobalInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 period 否 int32 [1-600] 10 排障统计周期，默认10s,支持1s/10s/60s/600s 10 measure 否 REFERENCE 详细请参见表3。 染色位 - 表3 MeasureData对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tosBit 否 int32 [3-7] - Tos染色位 3 flagBit 否 int32 [0-0] - Flag染色位 0

响应示例 返回状态码为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" } 返回状态码为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 /v1/performanceservice/flow/globals 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 { "period" : 10, "measure" : { "tosBit" : 3, "flagBit" : 0 } }

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/fwnat/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/fwnat/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 { "ids" : [ "de5813f8ff1e41f5ba9c324da70b49ed" ] }

响应参数 返回状态码为200：删除防火墙设备NAT配置成功。 表4 FwNatDeleteResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success ARRAY_REFERENCE 0-64个列表项，详细请参见表5。 删除成功的防火墙设备NAT配置。 - fail REFERENCE 详细请参见表6。 - - 表5 DeleteFwNatInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~32个字符。 - NAT策略id。 - name string 0~128个字符。 - 名称。 - 表6 FwNatDeleteResponseFailDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0x00c80014" errmsg string 0~256个字符。 - 错误信息。 "The id does not exist." data REFERENCE - - - - 表7 DeleteFwNatInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 0~32个字符。 - NAT策略id。 - name string 0~128个字符。 - 名称。 - 返回状态码为400：校验失败信息。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除防火墙设备NAT配置成功。 HTTP/1.1 200 OK Date: Sun,20 Jan 2019 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "success" : [{ "id" : "de5813f8ff1e41f5ba9c324da70b49ed", "name" : "nat1" }], "fail" : null } 返回状态码为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

URI /controller/campus/v1/networkservice/networkconfig/net/fwnat/devices/{deviceId}/fwnat/action/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备标识，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为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" : "", "data" : [ { "name" : "vn1", "vpnInstanceName" : "vpn1", "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ], "ipsecEncryption" : true, "overlayHeadLength" : 36, "enableIPv6" : true, "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /controller/campus/v1/lanwan/vn?vnId=a99f794e-b510-438c-a75d-de59f02347eb HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

响应参数 返回状态码为200：查询成功返回。 表2 QueryVnResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-300个列表项，详细请参见表3。 VN信息。 - 表3 VnInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 0~32个字符。 - VN名称。 "vn1" vpnInstanceName string 0~31个字符。 - 下发到设备的VPN实例名称，无需填充，查询返回。 "vpn1" siteInfos ARRAY_REFERENCE 0-100个列表项，详细请参见表4。 站点ID列表，最大100个。 - ipsecEncryption boolean true false true 当链路未开启IPSEC加密功能时，可基于VPN配置是否开启IPSEC加密。 true overlayHeadLength int32 [1-512] - VPN隧道长度扣除字节数。当overlayHeadLength为null时，表示不配置overlayHeadLength 36 enableIPv6 boolean true false false 是否使能IPv6能力 true description string 0~200个字符。 - VN业务描述。 "vn" id string 0~36个字符。 - VN标识。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" 表4 SiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 36个字符。 - 站点标识，uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" siteName string 0~64个字符。 - 站点名称，不需要填充。 "site" isWanServiceNeeded boolean true false true 是否需要配置网关业务。站点中设备无网关角色时，isWanServiceNeeded置为false。站点有AR设备并且是网关角色并且站点已经开局时，如果需要配置网关设备业务，isWanServiceNeeded置为true。默认true。 true routeDistinguisher string 0~21个字符。 - 路由标识RD，填写后不支持修改。支持的格式如下：2字节自治系统号:4字节用户自定义数，其中自治系统号的取值范围是0～65535，用户自定义数的取值范围是0～4294967295，例如101:3。自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；整数形式4字节自治系统号:2字节用户自定义数，自治系统号的取值范围是65536～4294967295，用户自定义数的取值范围是0～65535，例如0:3或者65537:3。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0:0；点分形式4字节自治系统号:2字节用户自定义数，点分形式自治系统号通常写成x.y的形式，x和y的取值范围都是0～65535，用户自定义数的取值范围是0～65535，例如0.0:3或者0.1:0。其中，自治系统号和用户自定义数不能同时为0，即RD的值不能是0.0:0；IPv4地址:2字节用户自定义数，例如：192.168.122.15:1。IP地址的取值范围是0.0.0.0～255.255.255.255；用户自定义数的取值范围是0～65535。不可配置5500:5500因预留给增强模式下的vlanif使用。 "101:3" status string SUCCESS CONFIGURING FAIL - 下发状态，不需要填充。 "SUCCESS" errMsg string 0~256个字符。 - 错误信息，不需要填充。 "" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:global-ip-pool/pool1 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-dhcpv4:global-ip-pool" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "gateway-list" : [ { "gateway-ip" : "10.1.1.1", "mask" : 24 } ], "section" : [ { "section-index" : 1, "start-ip" : "10.1.1.1", "end-ip" : "10.1.1.100" } ], "dns-list" : [ { "dns-ip" : "10.1.1.1" } ], "excluded-ip-address" : [ { "start-ip-address" : "10.1.1.10", "end-ip-address" : "10.1.1.20" } ], "static-bind" : [ { "static-bind-ip" : "10.1.1.1", "static-bind-mac" : "xxxx-xxxx-xxxx" } ], "option" : [ { "option-code" : 7, "ip-addresses" : [ "10.1.1.1" ], "ascii-string" : "test", "hex-string" : "00", "cipher-string" : "test@test", "sub-options" : { "sub-option" : [ { "sub-option-code" : 1, "ip-addresses" : [ "10.1.1.2" ], "ascii-string" : "test" } ] } } ], "ip-pool-name" : "pool1", "vpn-instance" : "overlay_vpn", "network-ipv4-address" : "10.1.1.0", "network-mask" : 24, "lease-time" : { "day" : 10, "hour" : 10, "minute" : 10, "unlimited" : true }, "domain-name" : "test.com" } ] }

响应示例 返回状态码为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