华为云用户手册

响应参数 返回状态码为201：创建成功，响应体参考CentralizedAccessBatchResponse。 表4 CentralizedAccessBatchResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-2000个列表项，详细请参见表6。 成功的集中上网策略信息列表。 - fail ARRAY_REFERENCE 0-2000个列表项，详细请参见表5。 失败的集中上网策略信息列表。 - processInstanceId string 0~36个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 - 表5 FailCentralizedAccessInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid." data REFERENCE 详细请参见表6。 失败的集中上网策略请求体 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 centralizedAccessInfos 是 REFERENCE 详细请参见表3。 创建集中上网配置请求数据。 - 表3 CentralizedAccessInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 centralizedAccessInfo 否 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 集中上网策略添加或者更新的请求体。 -

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/internet/00000000-0000-0000-0000-000000000000/centralized-access/batch 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 { "centralizedAccessInfo" : [ { "areaId" : "00000000-0000-0000-0000-000000000000", "areaName" : "area_1", "description" : "centralized access", "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "priority" : "1" } ], "enableIpv6" : false } ] }

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bgp:bgp HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-bgp:bgp" : { "local-as" : "65001", "graceful-restart-enable" : true } }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-bgp:bgp 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

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

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:bgp 是 REFERENCE 详细请参见表4。 BGP配置。 - 表4 bgp-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:bgp 否 REFERENCE 详细请参见表5。 BGP配置。 - 表5 bgp-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 local-as 否 string 1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。 - 本地AS，6700V子设备不支持。 "65001" graceful-restart-enable 否 boolean true false - GR 使能，AR6700V主设备和AR6700V子设备不支持。 true

响应示例 返回状态码为200：更新成功，响应体参考NatResponse。 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" : { "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 } ] } ] } }

请求示例 HTTP的示例 PUT /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-ACCESS-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：创建设备成功，响应体参考CreateDeviceBean。 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" : [ { "id" : "00000000-0000-0000-0000-000000000001", "name" : "AR1", "esn" : "2102351BTJ0000000666", "description" : "AR", "resourceId" : "HUAWEI", "tenantId" : "00000000-0000-0000-0000-000000000001", "siteId" : "00000000-0000-0000-0000-000000000001", "deviceModel" : "AR161EW", "tags" : ["AP01"], "systemIp" : "192.168.1.1", "ztpConfirm" : true, "role" : ["Gateway"] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "esn" : "2102351BTJ0000000666", "name" : "AR1", "deviceModel" : "AR161EW", "systemIp" : "192.168.1.1", "oldTenantId" : "00000000-0000-0000-0000-000000000004", "oldTenantName" : "tenant1", "oldDeviceGroupId" : "00000000-0000-0000-0000-000000000004", "oldDeviceGroupName" : "group1" } } ], "isRegisterEnable" : true, "forceRegister" : 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

请求示例 HTTP的示例 POST /controller/campus/v3/devices 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 { "devices" : [ { "esn" : "2102351BTJ0000000666", "name" : "AR1", "siteId" : "00000000-0000-0000-0000-000000000000", "description" : "AR", "resourceId" : "HUAWEI", "deviceModel" : "AR161EW", "systemIp" : "192.168.1.1", "tags" : ["AP01"], "ztpConfirm" : true, "role" : ["Gateway"], "performance" : 0 } ], "isRegisterEnable" : true, "forceRegister" : true }

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

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-direct-route-vlink:vlink-if 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-direct-route-vlink:vlink-if" : { "if-name" : "GE0/0/3", "vlink-route" : [ { "address-family" : "ipv4uni" } ], "vlink-configuration" : { "preference" : 233 } } }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-direct-route-vlink:vlink-if 表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"

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-direct-route-vlink:vlink-if 是 REFERENCE 详细请参见表4。 ARP Vlink直连路由。 - 表4 nes-ne-vlink-if-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-direct-route-vlink:vlink-if 否 REFERENCE 详细请参见表5。 ARP Vlink直连路由。 - 表5 vlink-if-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 if-name 否 string 1~63个字符。 - interface name "GE0/0/3" vlink-route 否 ARRAY_REFERENCE 详细请参见表6。 发布ARP Vlink直连路由。 - vlink-configuration 否 REFERENCE 详细请参见表7。 Vlink配置。 - 表6 nes-ne-vlink-if-vlink-route-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 address-family 否 string ipv4uni ipv6uni - 地址族类型，单一主键字段。 "ipv4uni" 表7 vlink-configuration-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 preference 否 int32 [0-255] - 优先级。 233

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nvo3:nvo3 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-nvo3:nvo3" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "source-nve" : "Nve1", "source-vtep-ip" : "10.1.1.1", "vni-instance" : [ { "vni" : 10, "static-peer" : [ { "address" : "10.1.2.1" } ] } ] } ] }

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

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nvo3:nvo3 是 REFERENCE 详细请参见表4。 三层网络虚拟化配置参数。 - 表4 nes-ne-nvo3-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nvo3:nvo3 否 ARRAY_REFERENCE 详细请参见表5。 三层网络虚拟化配置参数。 - 表5 nes-ne-nvo3对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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" source-nve 否 string 1~63个字符。 - 源端接口，仅支持NVE口，单一主键字段。 "Nve1" source-vtep-ip 否 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.1.1.1" vni-instance 否 ARRAY_REFERENCE 详细请参见表6。 VxLAN 网络标识。 - 表6 nes-ne-nvo3-vni-instance对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vni 否 int64 [1-16777215] - VNI ID，单一主键字段。 10 static-peer 否 ARRAY_REFERENCE 详细请参见表7。 头端复制列表。 - 表7 nes-ne-nvo3-vni-instance-static-peer对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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.1.2.1"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nvo3:nvo3 表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：接口调用成功，响应体参考EncryptRdbResponse。 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 返回状态码为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/v1/sdwan/encryptrdb/settings 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 { "settings" : true, "scope" : "all", "siteIds" : [ "00000000-0000-0000-0000-000000000000" ] }

响应参数 返回状态码为200：接口调用成功，响应体参考EncryptRdbResponse。 表3 EncryptRdbResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" 返回状态码为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 { "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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnBaseInfo 是 REFERENCE 详细请参见表2。 VN信息。 - 表2 UpdateVnInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~32个字符。 - VN名称。 "vn1" ipsecEncryption 否 boolean true false false 当链路未开启IPSEC加密功能时，可基于VPN配置是否开启IPSEC加密。 true vpnInstanceName 否 string 0~31个字符。 - 自定义下发到设备的VPN实例名称，可不填。如不填充，由系统自动生成。 "vpn1" overlayHeadLength 否 int32 [1-255] - VPN隧道长度扣除字节数。当VPN隧道长度扣除字节数为空时，表示不配置VPN隧道长度扣除字节数。tunnel建议的扣除长度为36；开启Ipsec时，建议扣除94;开启Ipsec、NAT时，建议扣除102，V600版本设备从V600R022C00版本开始支持此功能，AR6700V-L从V600R023C00版本开始支持此功能。 36 enableIPv6 否 boolean true false false 是否使能IPv6能力，兼容字段，后续使用ipType字段，enableIPv6为false时，相当于ipType取值IPv4，enableIPv6为true时，相当于ipType取值IPv4IPv6。V300版本的设备当前IPv6只支持本地开局，不支持站点间互访、overlay Qos、智能选路，集中上网功能。V600版本的设备需要升级到R022C10及后续版本才能支持以上功能，AR6700V-L从V600R023C10版本开始支持此功能。 true ipType 否 string 0~200个字符。 - IP类型。GRE隧道模式支持的字段：IPv4、IPv4IPv6。enableIPv6与ipType都配置的情况下，优先使用ipType。 "IPv4" description 否 string 0~200个字符。 - VN业务描述。 "vn" id 是 string 0~36个字符。 - VN标识。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6"

请求示例 HTTP的示例 PUT /controller/campus/v1/lanwan/vn 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 { "name" : "vn1", "ipsecEncryption" : true, "vpnInstanceName" : "vpn1", "overlayHeadLength" : 36, "enableIPv6" : true, "ipType" : "IPv4", "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" }

请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/certification/device/certificate?deviceId=fbb684c8-0d37-496f-bafa-4b06d5151e2e 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：查询成功，响应体参考QueryDeviceCertificateResponseDto。 表2 QueryDeviceCertificateResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~64个字符。 - 错误码。 "0" errmsg string 1~64个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 DeviceCertificateDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 1~64个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" deviceEsn string 1~64个字符。 - 设备ESN。 "esn" certificationStatus string 1~64个字符。 - 证书状态（0：初始化，1：申请中，2：申请成功，3：申请失败，4：等待中）。 "0" issuer string - - 证书授权者（"Huawei Equipment CA"，"Huawei Switch & Enterprise Communications Product Line CA"，"Other 3rd Issuer CA"）。 "Huawei Equipment CA" issuerDatetime int64 - - 发行时间（UTC）。 1557187200000 expirationDatetime int64 - - 到期时间（UTC）。 1558656000000 failureReason string 0~256个字符。 - 失败原因。 "在线更新设备证书失败" 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QueryDeviceCertificateResponseDto。 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" : { "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceEsn" : "esn", "certificationStatus" : "0", "issuer" : "Huawei Equipment CA", "issuerDatetime" : 1557187200000, "expirationDatetime" : 1558656000000, "failureReason" : "在线更新设备证书失败" } } 返回状态码为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：查询成功，响应体参考QueryFloorLocationDetailsResponse。 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" : "error", "data" : { "name" : "F3", "buildingName" : "N1", "image" : "iVBORw0KGgoAAAANSUhEUgAAAEIAAAA8CAYAAADSfGxZAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAEXRFWHRTb2Z0d2FyZQBTbmlwYXN0ZV0Xzt0AAAEKSURBVGiB7dvRaoMwGEDhP3Hv/4I+hPei/rs5Slo2lw1KITsHSi0m0X54acpxHBkRUUqJiIjMvI6fuzv3fD4zo123Z87dmLOvxvZe625s/XHmP0kIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChKChINqX13/bUBDtG/cnSi/OUBCZGeu6xrZtDwA9GMNBzPMcy7Jcv9vvu8pIG1cy81rv/Hw3duiNK7XWqPXxL+373jf3FTf07k6MzIxpmrrmfLzyht7R+cj37O9qG/KJ+EtCkBAkBAlBQpAQ9AkRmWqufm0+xwAAAABJRU5ErkJggg==", "scale" : "0.022", "locatedDeviceList" : [ { "id" : "c2b378d8-145f-4e46-8d71-c3709695dd06", "name" : "AP6605", "status" : "0", "deviceType" : "", "positionX" : "32", "positionY" : "32", "planPositionX" : "32", "planPositionY" : "32" } ], "unLocatedDeviceList" : [ { "id" : "c2b378d8-145f-4e46-8d71-c3709695dd06", "name" : "AP6605", "status" : "0", "deviceType" : "" } ] } } 返回状态码为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：查询成功，响应体参考QueryFloorLocationDetailsResponse。 表2 QueryFloorLocationDetailsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "error" data REFERENCE 详细请参见表3。 楼层布放信息模型 - 表3 FloorLocationDetails对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string - - 楼层名称。 "F3" buildingName string - - 楼层所属楼栋名称。 "N1" image byte - - 楼层图纸。 "iVBORw0KGgoAAAANSUhEUgAAAEIAAAA8CAYAAADSfGxZAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAEXRFWHRTb2Z0d2FyZQBTbmlwYXN0ZV0Xzt0AAAEKSURBVGiB7dvRaoMwGEDhP3Hv/4I+hPei/rs5Slo2lw1KITsHSi0m0X54acpxHBkRUUqJiIjMvI6fuzv3fD4zo123Z87dmLOvxvZe625s/XHmP0kIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChCAhSAgSgoQgIUgIEoKEICFICBKChKChINqX13/bUBDtG/cnSi/OUBCZGeu6xrZtDwA9GMNBzPMcy7Jcv9vvu8pIG1cy81rv/Hw3duiNK7XWqPXxL+373jf3FTf07k6MzIxpmrrmfLzyht7R+cj37O9qG/KJ+EtCkBAkBAlBQpAQ9AkRmWqufm0+xwAAAABJRU5ErkJggg==" scale double - - 比例尺，表示图上距离与实际距离的比，例如：图上0.01米代表实际1米，则比例尺为0.01。 "0.022" locatedDeviceList ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表4。 已布放设备列表。 - unLocatedDeviceList ARRAY_REFERENCE 0-2147483647个列表项，详细请参见表5。 未布放设备列表。 - 表4 LocatedDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 设备ID，格式UUID。 "c2b378d8-145f-4e46-8d71-c3709695dd06" name string - - 设备名称。 "AP6605" status string 0 1 3 4 - 设备状态 0: 正常 1: 告警 3: 离线 4: 未注册 "0" deviceType string AP AR FW LSW AC OLT ONT - 设备类型 "AP" - 接入点 "AR" - 接入路由器 "FW" - 防火墙 "LSW" - 交换机 "AC" - 接入控制器 "OLT" - 光线路终端 "ONT" - 光网络终端 - positionX int32 - - 设备布放坐标X，单位：像素。 "32" positionY int32 - - 设备布放坐标Y，单位：像素。 "32" planPositionX int32 - - 设备规划坐标X，单位：像素。 "32" planPositionY int32 - - 设备规划坐标Y，单位：像素。 "32" 表5 DeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 设备ID，格式UUID。 "c2b378d8-145f-4e46-8d71-c3709695dd06" name string - - 设备名称。 "AP6605" status string 0 1 3 4 - 设备状态 0: 正常 1: 告警 3: 离线 4: 未注册 "0" deviceType string AP AR FW LSW AC OLT ONT - 设备类型 "AP" - 接入点 "AR" - 接入路由器 "FW" - 防火墙 "LSW" - 交换机 "AC" - 接入控制器 "OLT" - 光线路终端 "ONT" - 光网络终端 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误，无响应体。 详细信息请参见实际响应消息体。