华为云用户手册

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/site?templateId=fbb684c8-0d37-496f-bafa-4b06d515j7l6&siteName=SpokeSite&pageIndex=1&pageSize=10 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

响应参数 返回状态码为200：接口调用成功，响应体参考OverlayWanBgpPolicyTempBindResponse。 表2 OverlayWanBgpPolicyTempBindResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" vpnId string - - 关联VPNID。 "00000000-0000-0000-0000-000000000000" vpnName string - - 关联VPN名称。 "VPN1" pageIndex int32 - - 分页索引 1 pageSize int32 - - 分页大小 10 totalRecords int32 - - 总数 10 data ARRAY_REFERENCE 0-2000个列表项，详细请参见表3。 BGP路由模板列表。 - 表3 OverlayWanBgpPolicyTemplateBindSites对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string - - 站点ID。 "2e7b7338-627f-4a0b-b4a5-092a331142d2" siteName string - - 站点名称。 "站点名称" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

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

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/performance/site/app/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

响应示例 返回状态码为200：查询成功，响应体参考AppDetailResponse。 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", "appId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "appName" : "app", "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天（站点应用流量数据为40天），且查询时间范围小于等于24H时，返回原始分钟级数据，时间范围大于24H时，返回小时级别数据； *查询开始时间大于7天（站点应用流量数据为40天），小于等于60天，且查询时间范围小于等于7天时，返回小时级别数据，时间范围大于7天时，返回天级别数据； *查询开始时间大于60天时，返回天级别数据； *查询流量指标（netstream）时，后台返回两种流量数据（netstream_upward，netstream_downward）； *流量包含netstream的Overlay流量和Local Breakout流量之和； *查询应用质量数据时，不包含链路信息，同时查询流量与质量数据，分开返回应用信息。

URI /controller/campus/v1/sdwan/performance/site/app/list 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点标识，UUID格式，可由网络侧提供接口获取。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" metric 是 string - - 查询指标，该字段可以设置为以下几种： a) netstream：流量，单位是字节（Byte）。 b) packetloss：丢包，单位是百分比（%）。 c) 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"

响应示例 返回状态码为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-queue-template:user-queue-profile 是 REFERENCE 详细请参见表4。 QoS模板。 - 表4 nes-ne-user-queue-profile-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-queue-template:user-queue-profile 否 REFERENCE 详细请参见表5。 QoS模板。 - 表5 user-queue-profile-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~63个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 模板名称，单一主键字段。 "UserQueueProfile" mode 否 string normal time-range 8cos-enhance - 模板模式。AR6700V主设备，AR6700V子设备和AR6700V-L款型不支持。 "normal" description 否 string 1~63个字符。 - 描述。AR6700V主设备，AR6700V子设备和AR6700V-L款型不支持。 "test" traffic-behavior-user-queue 否 ARRAY_REFERENCE 0-256个列表项，详细请参见表6。 流行为用户队列。 - 表6 nes-ne-user-queue-profile-traffic-behavior-user-queue-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~31个字符。 - 流行为用户队列名称，单一主键字段。 "name" scheduler-mode 否 string pq drr not-config - 调度模式。 "pq" weight 否 int32 [1-100] - 权重。 10 cir 否 int64 [64-100000000] - 承诺速率。 64 pir 否 int64 [8-100000000] - 峰值速率。 10 cir-percent 否 int32 [1-100] - 承诺百分比。 20 pir-percent 否 int32 [1-100] - 峰值百分比。 30 cbs 否 int64 [0-4194304] - 承诺突发尺寸。 10 pbs 否 int64 [0-4194304] - 峰值突发尺寸。 10

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-queue-template:user-queue-profile 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-queue-template:user-queue-profile" : { "name" : "UserQueueProfile", "mode" : "normal", "description" : "test", "traffic-behavior-user-queue" : [ { "name" : "name", "scheduler-mode" : "pq", "weight" : 10, "cir" : 64, "pir" : 10, "cir-percent" : 20, "pir-percent" : 30, "cbs" : 10, "pbs" : 10 } ] } }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-queue-template:user-queue-profile 表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 /controller/campus/v1/networkservice/networkconfig/net/lswport/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/ports 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 { "interfaceNames" : ["GigabitEthernet0/0/1","GigabitEthernet0/0/2"] }

响应示例 返回状态码为200：重置交换机端口配置成功，返回结构体参见ConfigResetResponseDto。 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" : [ "" ], "fail" : [ "" ] }

URI /controller/campus/v1/networkservice/networkconfig/net/lswport/devices/{deviceId}/ports 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应参数 返回状态码为200：去使能成功，响应体参考DeviceFreeRuleConfigResponse。 表2 DeleteDeviceFreeRuleConfigResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" siteId string 0~36个字符。 - 站点ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" deviceId string 0~36个字符。 - 设备ID。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" 返回状态码为204：接口调用成功，无数据。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

URI /controller/campus/rest/sdwan/v1/device/nac/free-rule 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 0~36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceId 否 string 0~36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

请求示例 HTTP的示例 DELETE /controller/campus/rest/sdwan/v1/device/nac/free-rule?siteId=fbb684c8-0d37-496f-bafa-4b06d5151e2e&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：去使能成功，响应体参考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" : "", "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956" } 返回状态码为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

响应示例 返回状态码为200：操作成功。响应体参考CutPortalOnlineUserOutputDto。 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" : "Partially successful.", "success" : [ "2eab8922-a37d-4355-9788-33caade63b5a" ], "failure" : [ { "errcode" : "3201", "errmsg" : "The parameter is incorrect, the user does not exist, or the user has gone offline.", "data" : "aaab8922-a37d-4355-9788-33caade63b5a" } ] } 返回状态码为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/onlineusers/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 { "onlineUserIds" : [ "2eab8922-a37d-4355-9788-33caade63b5a" ], "userType" : 5 }

响应示例 返回状态码为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-direct-route-vlink:vlink-if/{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个字符。 - interface name "GE0/0/3"

请求参数 表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直连路由。 -

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

请求示例 HTTP的示例 POST /controller/campus/v1/lanwan/mirror/fbb684c8-0d37-496f-bafa-4b06d5151e2e/mirrorport-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 { "mirrorPorts" : [ "fbb684c8-0d37-496f-bafa-4b06d5151e2e" ] }

响应示例 返回状态码为200：删除成功，返回体参考ConfigPortResponse。 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" : [ { "portId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portName" : "GE0/0/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 /controller/campus/v1/lanwan/mirror/{observeId}/mirrorport-detachment 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 observeId 是 string 36个字符。 - 观察口标识。uuid格式。与查询观察端口返回体中portId一致。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

URI /controller/campus/v1/networkservice/networkconfig/net/time/site-templates/{siteTemplateId}/times 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string - - 站点模板ID，格式为UUID格式。 "fbb684c8-0d37-496f-bafa-4b06db151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 isForceOverride 否 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 { "errcode" : "0", "errmsg" : "", "data" : { "timezoneId" : "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845", "enableDaylight" : false, "ntpList" : ["10.0.0.2","10.0.0.5"], "enableTimeSync" : true } }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/time/site-templates/fbb684c8-0d37-496f-bafa-4b06db151e2e/times?isForceOverride=true 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 { "timezoneId" : "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845", "enableDaylight" : false, "ntpList" : ["10.0.0.2","10.0.0.5"], "enableTimeSync" : true }