华为云用户手册

响应参数 返回状态码为200：接口调用成功，响应体参考OspfRouteGlobalResponse，返回的OSPF路由信息中仅包含对应的ID。 表4 OspfRouteGlobalResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-8个列表项，详细请参见表5。 创建或者更新成功的OSPF路由全局进程信息。 - fail ARRAY_REFERENCE 0-8个列表项，详细请参见表6。 创建或者更新失败的OSPF路由全局进程信息。 - 表5 OspfRouteGlobalInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 对应站点ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId uuid - - 设备ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId uuid - - 所在VPN ID。格式是uuid，创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId uuid - - 所在TNP ID。格式是uuid，创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" routerId string - - 用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.1网段。 "192.168.1.1" processId int32 [1-65535] - 进程号。创建时必填。EVPN隧道模式下，Underlay场景，取值范围20001-30000；Overlay场景，取值范围：1-20000。 501 defaultRouteAdvertisement boolean true false false 是否开启通告默认路由。创建时必填。 false defaultRouteCost int32 [1-16777214] 1 默认路由开销。开启通告默认路由时必填。 1 defaultRouteType int32 - 2 OSPF通告默认路由时的外部路由类型,开启通告默认路由时必填,取值范围1-2，Type1外部路由表示此类路由的可信度高，Type2外部路由表示此类路由的可信度低。 1 internalPreference int32 [1-255] 10 内部优先级。创建时必填。 10 asePreference int32 [1-255] 150 ASE优先级。创建时必填。 150 routeRedistribute ARRAY_REFERENCE 0-64个列表项，详细请参见表16。 路由引入。 - asbrSummarys ARRAY_REFERENCE 0-64个列表项，详细请参见表17。 边界路由聚合列表。 - exportRoutePolicy REFERENCE 详细请参见表18。 发布路由策略 - importRoutePolicy REFERENCE 详细请参见表18。 接收路由策略 - configSource string 0~32个字符。 - 配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。 "Wan" 表6 FailOspfRouteGlobalInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 OSPF路由全局进程信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/ospf/global 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 { "globalInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "routerId" : "192.168.1.1", "processId" : 501, "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "defaultRouteType" : 1, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "BGP", "processId" : 501, "cost" : 1, "externalRouteType" : 1 } ], "asbrSummarys" : [ { "ipAddress" : "10.1.0.0/16", "cost" : 0, "tag" : 1, "distributeDelay" : 1, "advertise" : true, "generateNull0Route" : false } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "importRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "configSource" : "Wan" } ] }

URI /controller/campus/v1/sdwan/netstream/{deviceId}/interface/ifName/samplerEnable/delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 0~36个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 delSampleEnableInfo 是 REFERENCE 详细请参见表3。 删除接口采样使能信息。 - 表3 DelSampleEnableInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ifName 是 string 1~63个字符。 - 接口名称。 "GE0/0/0" direction 是 string inbound outbound - 采样方向。 "inbound"

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ospfRouteGlobalInfos 是 REFERENCE 详细请参见表2。 OSPF路由全局进程信息。 - 表2 OspfRouteGlobalInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 globalInfos 否 ARRAY_REFERENCE 1-8个列表项，详细请参见表3。 OSPF路由全局进程信息。 - 表3 OspfRouteGlobalInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 uuid - - 对应站点ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 否 uuid - - 设备ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 uuid - - 所在VPN ID。格式是uuid，创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId 否 uuid - - 所在TNP ID。格式是uuid，创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" routerId 否 string - - 用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.1网段。 "192.168.1.1" processId 否 int32 [1-65535] - 进程号。创建时必填。EVPN隧道模式下，Underlay场景，取值范围20001-30000；Overlay场景，取值范围：1-20000。 501 defaultRouteAdvertisement 否 boolean true false false 是否开启通告默认路由。创建时必填。 false defaultRouteCost 否 int32 [1-16777214] 1 默认路由开销。开启通告默认路由时必填。 1 defaultRouteType 否 int32 - 2 OSPF通告默认路由时的外部路由类型,开启通告默认路由时必填,取值范围1-2，Type1外部路由表示此类路由的可信度高，Type2外部路由表示此类路由的可信度低。 1 internalPreference 否 int32 [1-255] 10 内部优先级。创建时必填。 10 asePreference 否 int32 [1-255] 150 ASE优先级。创建时必填。 150 routeRedistribute 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表4。 路由引入。 - asbrSummarys 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表5。 边界路由聚合列表。 - exportRoutePolicy 否 REFERENCE 详细请参见表6。 发布路由策略 - importRoutePolicy 否 REFERENCE 详细请参见表6。 接收路由策略 - configSource 否 string 0~32个字符。 - 配置源信息，用于区分是WAN业务还是LanWan互联业务，仅查询接口使用，不能修改，取值范围：Wan、LanWan。 "Wan"

请求参数 表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-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nvo3:nvo3 否 REFERENCE 详细请参见表5。 三层网络虚拟化配置参数。 - 表5 nvo3-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vni 否 int64 [1-16777215] - VNI ID，单一主键字段。 10 static-peer 否 ARRAY_REFERENCE 详细请参见表7。 头端复制列表。 - 表7 nes-ne-nvo3-vni-instance-static-peer-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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"

请求示例 HTTP的示例 PATCH /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" : { "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

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：接口调用成功，响应体参考DeleteOpsParamResponse。 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" : [ "00000000-0000-0000-0000-000000000000" ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : "00000000-0000-0000-0000-000000000000" } ] } 返回状态码为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/cloud/ops/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 { "siteIds" : ["00000000-0000-0000-0000-000000000000"] }

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-cli:command-aliases/command-alias/test1 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-cli:command-alias" : { "alias" : "test1", "command" : "test2", "parameter" : "$test3" } }

响应示例 返回状态码为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-cli:command-aliases/command-alias/{alias} 表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" alias 是 string 1~63个字符。满足正则表达[a-zA-Z][a-zA-Z0-9-]*。 - 指定别名。必填，支持大、小写字母，数字及连字符"-"，字母开头，不区分大小写，字符间不能有空格。别名定义出现循环嵌套或嵌套层次超过16层时，该别名节点无效，不会用于进行字符串替换。单一主键字段。 "test1"

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 command-alias 是 REFERENCE 详细请参见表4。 别名实例。 -

请求示例 HTTP的示例 GET /controller/campus/v3/sites?pageIndex=1&pageSize=20&name=siteName&id=ea25fdbf-8dee-4823-bac2-5bfe8e3359ca&sort=%2Bname 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/v3/sites 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-5000] 0 分页时，当前页面索引，值为空或=0时默认获取第一页pagesize为100的数据。 1 pageSize 否 int32 [0-100] 20 分页时，当前页面设备数据长度；值为空或=0且pageIndex值不为空或0时，此参数默认20。 20 name 否 string 0~128个字符。 - 站点名称模糊查询，支持精确和模糊匹配，不支持正则。 "siteName" id 否 string 0~64个字符。 - 站点ID，如果不为空，则按照站点ID精确查询。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca" sort 否 string 0~32个字符。 - 只能按站点名称排序，+name表示升序，-name表示降序。【URL中的+表示是空格，+号用%2B代替】 "%2Bname"

响应示例 返回状态码为200：查询站点列表返回体，响应体参考querySitesOut。 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, "pageIndex" : 1, "pageSize" : 20, "data" : [ { "id" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "tenantId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359ca", "name" : "site1", "organizationId" : "671cbc38-38eb-49a5-88c4-d7a35bf5bf11", "organizationName" : "南京研究所", "description" : "site1", "type" : ["AP"], "latitude" : "50", "longtitude" : "111", "longitude" : "111", "contact" : "David", "tag" : ["abcd"], "isolated" : false, "email" : "xxx@xxx.xxx", "phone" : "152XXXXXXXX", "postcode" : "215000", "address" : "66 JiangYun Road", "approvalSwitch" : false, "autoApprovalSwitch" : false, "autoTopoCheck" : false, "validityPeriod" : 1, "siteCode" : "", "siteCodeExpireTime" : 1686131018523, "isSiteCodeExpired" : false, "totalDeviceCount" : 100, "siteTag" : "" } ] } 返回状态码为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 /restconf/v1/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-local-user-policy:local-user-policy/password-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 { "huawei-nce-e-local-user-policy:password-policy" : { "expire-days" : "", "history-record-number" : "", "change-check" : true, "alert-original" : true } }

URI /restconf/v1/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-local-user-policy:local-user-policy/password-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。 -

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 password-policy 是 REFERENCE 详细请参见表3。 配置本地用户密码策略。 - 表3 password-policy-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-local-user-policy:password-policy 否 REFERENCE 详细请参见表4。 - - 表4 password-policy对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 expire-days 否 int32 [0-999] 90 密码过期时间，0表示没有过期时间。 - history-record-number 否 int32 [0-12] 5 每个用户记录的历史密码最大个数。 - change-check 否 boolean true false false 首次登陆提示修改密码。 true alert-original 否 boolean true false - 密码告警。 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的示例 POST /controller/campus/v1/sdwan/net/ports/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 { "ports" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portType" : "GE", "portNumber" : "2/0/0", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Device1", "portSwitch" : "layer2-port", "isPhysical" : false, "stpEnable" : true, "pnpVlanEnable" : true, "linkInfo" : { "linkType" : "Ethernet", "cellular" : { "apn" : "abc" }, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 }, "ethernet" : { "negotiationMode" : "auto", "media" : "copper", "duplex" : "full", "speed" : 100 } }, "isMemberEthTrunk" : true, "isMemberWanLink" : true, "isInterLink" : true, "bandwidth" : 10, "trustEnable" : false, "trust" : "dscp", "description" : "port description", "isRuLink" : true, "ruMntAddress" : "192.168.2.1", "prefixLength" : 24 } ] }

响应示例 返回状态码为200：正常响应返回体，返回的Port信息中仅包含对应的ID，响应体参考PortResponse。 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" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portType" : "GE", "portNumber" : "2/0/0", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Device1", "portSwitch" : "layer2-port", "isPhysical" : false, "stpEnable" : true, "pnpVlanEnable" : true, "linkInfo" : { "linkType" : "Ethernet", "cellular" : { "apn" : "abc" }, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 }, "ethernet" : { "negotiationMode" : "auto", "media" : "copper", "duplex" : "full", "speed" : 100 } }, "isMemberEthTrunk" : true, "isMemberWanLink" : true, "isInterLink" : true, "bandwidth" : 10, "trustEnable" : false, "trust" : "dscp", "description" : "port description", "isRuLink" : true, "ruMntAddress" : "192.168.2.1", "prefixLength" : 24 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portType" : "GE", "portNumber" : "2/0/0", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Device1", "portSwitch" : "layer2-port", "isPhysical" : false, "stpEnable" : true, "pnpVlanEnable" : true, "linkInfo" : { "linkType" : "Ethernet", "cellular" : { "apn" : "abc" }, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 }, "ethernet" : { "negotiationMode" : "auto", "media" : "copper", "duplex" : "full", "speed" : 100 } }, "isMemberEthTrunk" : true, "isMemberWanLink" : true, "isInterLink" : true, "bandwidth" : 10, "trustEnable" : false, "trust" : "dscp", "description" : "port description", "isRuLink" : true, "ruMntAddress" : "192.168.2.1", "prefixLength" : 24 } } ] } 返回状态码为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

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/application/application-groups 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 { "applicationGroups" : [ { "id" : "00000000-0000-0000-0000-000000000000", "groupName" : "officeApp", "description" : "", "predefinedApps" : [ { "applicationId" : "2601", "applicationType" : "DPI", "applicationName" : "", "categoryName" : "", "categoryId" : "" } ], "customApps" : [ "00000000-0000-0000-0000-000000000000" ], "customApplications" : [ { "applicationName" : "", "applicationId" : "" } ], "saType" : "SA_H30071002", "shortId" : "", "experienceLevel" : "", "configId" : "00000000-0000-0000-0000-000000000000" } ] }

响应示例 返回状态码为201：创建成功，响应体参考ApplicationGroupResponse。 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" : "OK", "errmsg" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "groupName" : "officeApp", "description" : "", "predefinedApps" : [ { "applicationId" : "2601", "applicationType" : "DPI", "applicationName" : "", "categoryName" : "", "categoryId" : "" } ], "customApps" : [ "00000000-0000-0000-0000-000000000000" ], "customApplications" : [ { "applicationName" : "", "applicationId" : "" } ], "saType" : "SA_H30071002", "shortId" : "", "experienceLevel" : "", "configId" : "00000000-0000-0000-0000-000000000000" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "groupName" : "officeApp", "description" : "", "predefinedApps" : [ { "applicationId" : "2601", "applicationType" : "DPI", "applicationName" : "", "categoryName" : "", "categoryId" : "" } ], "customApps" : [ "00000000-0000-0000-0000-000000000000" ], "customApplications" : [ { "applicationName" : "", "applicationId" : "" } ], "saType" : "SA_H30071002", "shortId" : "", "experienceLevel" : "", "configId" : "00000000-0000-0000-0000-000000000000" } } ] } 返回状态码为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

响应示例 返回状态码为201：创建成功信息，响应体参考MobileTerminalCreateResponse。 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" : "", "successList" : [ { "id" : "62008e2c-6bf2-48ea-a17c-d278c594d83a", "imsi" : "460030912121001", "imei" : "990000862471854", "msisdn" : "11111111111", "authorIpv4" : "192.168.10.1", "authorIpv6" : "FC00::1101/64", "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "isBlocked" : false, "description" : "Huawei phone" } ], "failList" : [ { "errcode" : "0x022b0006", "errmsg" : "imei is conflict", "id" : "62008e2c-6bf2-48ea-a17c-d278c594d83a", "imsi" : "460030912121001", "imei" : "990000862471854", "msisdn" : "11111111111", "authorIpv4" : "192.168.10.1", "authorIpv6" : "FC00::1101/64", "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "isBlocked" : false, "description" : "Huawei phone" } ] } 返回状态码为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

响应参数 返回状态码为201：创建成功信息，响应体参考MobileTerminalCreateResponse。 表4 MobileTerminalCreateResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息 "" successList ARRAY_REFERENCE 0-1000个列表项，详细请参见表5。 创建终端成功的列表 - failList ARRAY_REFERENCE 0-1000个列表项，详细请参见表6。 创建终端失败的列表 - 表5 MobileTerminalDtoWithId对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 终端id。uuid格式 "62008e2c-6bf2-48ea-a17c-d278c594d83a" imsi string 0~20个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 SIM卡唯一标识，imsi和imei至少填一个，该参数传值时，请填写10-20位数字。 "460030912121001" imei string 0~20个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端唯一标识，imsi和imei至少填一个，该参数传值时，请填写14-20位数字。3GPP标准中，IMEI只有前14位有效，实际存储时只存储前14位。 "990000862471854" msisdn string 0~1050个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端的msisdn，只能是数字或者以+开头的数字。 "11111111111" authorIpv4 string 0~20个字符。 - 终端ip，只支持IPv4地址。 "192.168.10.1" authorIpv6 string 0~128个字符。 - 终端IPv6地址，可以带前缀长度，若不填前缀长度，默认设为64位 "FC00::1101/64" terminalGroupId string 32~36个字符。 - 自定义终端组ID。uuid格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" isBlocked boolean true false false 是否加入黑名单，处于黑名单的终端无法认证。默认值为false。 false description string 0~200个字符。 - 对终端的描述，1~200个字符，不能包含特殊字符。 "Huawei phone" 表6 MobileTerminalFail对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x022b0006" errmsg string - - 错误信息。 "imei is conflict" id string - - 终端id。uuid格式 "62008e2c-6bf2-48ea-a17c-d278c594d83a" imsi string 0~20个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 SIM卡唯一标识，imsi和imei至少填一个，该参数传值时，请填写10-20位数字。 "460030912121001" imei string 0~20个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端唯一标识，imsi和imei至少填一个，该参数传值时，请填写14-20位数字。3GPP标准中，IMEI只有前14位有效，实际存储时只存储前14位。 "990000862471854" msisdn string 0~1050个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 终端的msisdn，只能是数字或者以+开头的数字。 "11111111111" authorIpv4 string 0~20个字符。 - 终端ip，只支持IPv4地址。 "192.168.10.1" authorIpv6 string 0~128个字符。 - 终端IPv6地址，可以带前缀长度，若不填前缀长度，默认设为64位 "FC00::1101/64" terminalGroupId string 32~36个字符。 - 自定义终端组ID。uuid格式 "22fbb5f2-d07e-4710-94ac-7705517ab842" isBlocked boolean true false false 是否加入黑名单，处于黑名单的终端无法认证。默认值为false。 false description string 0~200个字符。 - 对终端的描述，1~200个字符，不能包含特殊字符。 "Huawei phone" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QueryResponse。 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" : { "deviceLog" : [ { "detail" : "Aug 27 2018 11:43:41+08:00 20000000000SGB00000000 %%01CM/5/USER_OFFLINERESULT(s)[56168]:[WLAN_STA_INFO_OFFLINE]ACMAC:00-00-00-00-00-00;", "deviceName" : "20000000000SGB00000000", "esn" : "20000000000SGB00000000", "deviceMac" : "xx-xx-xx-xx-xx-xx", "sceneName" : "Station login and logout", "time" : "2018-08-27 11:43:41", "stationMac" : "xx-xx-xx-xx-xx-xx" } ], "nextRowkey" : "" } } 返回状态码为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/accountservice/terminalmgr/mobile/endpoint 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 { "terminalContents" : [ { "imsi" : "460030912121001", "imei" : "990000862471854", "msisdn" : "11111111111", "authorIpv4" : "192.168.10.1", "authorIpv6" : "FC00::1101/64", "terminalGroupId" : "22fbb5f2-d07e-4710-94ac-7705517ab842", "isBlocked" : false, "description" : "Huawei phone" } ] }