华为云用户手册

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:global-ip-pool 是 REFERENCE 详细请参见表4。 DHCP地址池配置参数。 -

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

响应参数 返回状态码为200：操作成功。 表3 nvo3-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nvo3:nvo3 ARRAY_REFERENCE 详细请参见表4。 三层网络虚拟化配置参数。 - 表4 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 详细请参见表5。 VxLAN 网络标识。 - 表5 nes-ne-nvo3-vni-instance对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vni int64 [1-16777215] - VNI ID，单一主键字段。 10 static-peer ARRAY_REFERENCE 详细请参见表6。 头端复制列表。 - 表6 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" 返回状态码为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-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" } ] } ] } ] } 返回状态码为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"

请求示例 HTTP的示例 GET /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-AC CES S-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 POST /controller/campus/ui/v1/sdwan/openapi/maintenance/cli/export HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/octerstream,application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "exportPassword" : "Example@123", "passwordEnhance" : true, "exportAll" : true, "siteIds" : [ "00000000-0000-0000-0000-000000000000" ], "deviceIds" : [ "00000000-0000-0000-0000-000000000000" ], "esns" : [ "AR500102390000000001" ] }

响应参数 返回状态码为200：导出成功。 返回状态码为400：请求参数错误，响应体参考ExportCmdResponse。 表3 ExportCmdResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码，0表示成功，非0表示失败。 "error" errmsg string - - 错误信息。 "" 返回状态码为500：系统内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：导出成功。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误，响应体参考ExportCmdResponse。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "error", "errmsg" : "" } 返回状态码为500：系统内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/octerstream,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-route-policy:community-filter 是 REFERENCE 详细请参见表4。 团体属性过滤器配置参数。 -

响应示例 返回状态码为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:community-filter/{name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" name 是 string - - 名称，整数形式时范围1-99，字符串形式时1-51个字符且不能都是数字，单一主键字段。 "filter1"

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

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/lswmgmtvlan/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/pnpenable 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 { "pnpEnable" : false, "pnpLinkAggregationDisable" : false }

URI /controller/campus/v1/networkservice/networkconfig/net/lswmgmtvlan/sites/{siteId}/pnpenable 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 32~36个字符。 - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为200：修改成功，返回结构体参见PnpEnableResponseDto。 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" : { "pnpEnable" : false, "pnpLinkAggregationDisable" : false } }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 站点内自协商管理VLAN配置参数体，结构体参见PnpEnableDto。 - 表3 PnpEnableDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pnpEnable 是 boolean true false false PNP功能使能。默认值为false。 false pnpLinkAggregationDisable 否 boolean true false false PNP自协商功能使能。默认值为false。 false

响应示例 返回状态码为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-ipv4-urpf:ipv4-urpf/{if-name} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" if-name 是 string 1~63个字符。 - 接口名称，单一主键字段。 "GE0/0/1"

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ipv4-urpf:ipv4-urpf 是 REFERENCE 详细请参见表4。 接口IPv4 URPF配置。 -

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ipv4-urpf:ipv4-urpf/GE0%2F0%2F1 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-ipv4-urpf:ipv4-urpf" : { "if-name" : "GE0/0/1", "mode" : "strict", "default-route" : true } }

响应示例 返回状态码为200：配置成功。 HTTP/1.1 200 OK { "errcode": "0", "errmsg": "", "data": { "isolate": 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

响应参数 返回状态码为200：查询成功，响应体参考LinkDetailResponse。 表2 LinkDetailResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-100000000个列表项，详细请参见表3。 - - 表3 LinkInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkId string 36个字符。 - 链路长ID。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" linkName string 0~128个字符。 - 链路名称。 "link" metricDatas ARRAY_REFERENCE 0-100000000个列表项，详细请参见表4。 指标返回值，包括流量、丢包、抖动、时延。 - 返回状态码为400：校验异常 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考LinkDetailResponse。 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" : [ { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "linkName" : "link", "metricDatas" : [ { "name" : "***", "value" : [ { "timestamp" : "1985-04-12T23:20:50.52Z", "value" : 50 } ] } ] } ] } 返回状态码为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、该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用； 2、返回数据类型与用户查询时间范围以及查询开始时间有关： *查询开始时间小于等于7天，且查询时间范围小于等于24H时，返回原始分钟级数据，时间范围大于24H时，返回小时级别数据； *查询开始时间大于7天，小于等于60天，且查询时间范围小于等于7天时，返回小时级别数据，时间范围大于7天时，返回天级别数据； *查询开始时间大于60天时，返回天级别数据； *查询流量指标（netstream）时，后台返回两种流量数据（netstream_upward，netstream_downward）； *流量包含WAN链路的Overlay流量和Local Breakout流量之和；。

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-ACCESS-TOKEN: x-yyyyyy

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

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

请求示例 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" }