华为云用户手册

  • 响应示例 返回状态码为200:操作成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 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,16 Feb 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-traffic-behavior:traffic-behavior 是 REFERENCE 详细请参见表4。 流行为配置。 -
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-traffic-behavior:traffic-behavior/{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~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 名称,单一主键字段。 "Traffic Behavior"
  • 响应示例 返回状态码为200:删除成功,响应体参考DetectionUrlResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 1 } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 1 } } ] } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/detection-url/action/batch-delete 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 { "detectionUrlInfos" : [ { "id" : "000000-0000-0000-0000-000000000000", "appName" : "Google", "detectionUrl" : "https://huawei.com", "appType" : 1 } ] }
  • 响应示例 返回状态码为200:查询成功,返回结构体参见MgmtVlanResponseDto。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : { "vlanId" : 10, "wiredPnpVlanId" : 10, "wirelessPnpVlanId" : 10, "ipType" : "IPv4", "ip" : "10.0.0.10", "mask" : "24", "gateway" : "10.0.0.254", "isAutoAddUpPort" : false, "isLinkAggregationReceive" : false, "identifyStaticRoute" : true, "destinationMask" : "22", "destinationPrefixIp" : "10.20.0.0", "preference" : 5 } }
  • 响应参数 返回状态码为200:查询成功,返回结构体参见MgmtVlanResponseDto。 表2 MgmtVlanResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 MgmtVlanDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vlanId int32 [1-4094] - 管理VLAN,该参数可选值为“默认”、“自定义”,当选择“自定义”时,该值为必填。 10 wiredPnpVlanId int32 [1-4094] - 有线自协商管理VLAN。 10 wirelessPnpVlanId int32 [1-4094] - 无线自协商管理VLAN。 10 ipType string 0~10个字符。 IPv4 IP类型,支持IPv4和IPv6。当ip,mask,gateway没传时,IP获取类方式默认为动态,此参数无效,会根据设备所在站点的南向接入IP类型自动判断是IPv4还是IPv6;当ip,mask,gateway传值时,此参数生效。为了向前兼容,该缺省值为IPv4。 "IPv4" ip string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 静态IP地址,支持配置单播IP地址,IP格式需要与ipType字段中的IP类型匹配。参数ip、mask、gateway填写时需同时填写。 "10.0.0.10" mask string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 掩码范围是(IPv4:1~32,IPv6:1~128)范围内的整数。参数ip、mask、gateway填写时需同时填写。 "24" gateway string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 网关地址,支持配置单播IP地址,IP格式需要与ipType字段中的IP类型匹配。参数ip、mask、gateway填写时需同时填写。 "10.0.0.254" isAutoAddUpPort boolean true false false 上行口自动放行。默认值为false。 false isLinkAggregationReceive boolean true false - 支持Eth-trunk自协商固化配置,设备上线协商后才支持配置,默认为空,相关节点不做下发 false identifyStaticRoute boolean true false false 自定义静态路由。默认值为false。 true destinationMask string 1~3个字符。 - 掩码,不允许修改。范围:(IPv4:1~32,IPv6:1~128) "22" destinationPrefixIp string 1~45个字符。 - 目的地址,必填。必须是合法的IPv4或IPv6地址,IP格式需要与ipType字段中的IP类型匹配,不允许修改。 "10.20.0.0" preference integer [1-255] - 优先级。取值越小,优先等级越高,不填时默认为60。 5
  • URI /controller/campus/v1/networkservice/networkconfig/net/lswmgmtvlan/devices/{deviceId}/mgmtvlan 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 32~36个字符。 - 设备ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/lswmgmtvlan/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/mgmtvlan 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:查询成功,响应体参考QueryBehaviorsResponse。 表2 QueryBehaviorsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码:0 表示接口执行成功,非0 表示接口执行失败。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表9。 策略行为模板信息。 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/behavior-profile?behaviorName=qos profile name&qosProfileType=lan&behaviorType=qos 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:查询成功,响应体参考QueryBehaviorsResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : false } } ] } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/networkservice/networkconfig/net/lswport/devices/updowntrap 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 { "upDownTrapInfos" : [ { "deviceId" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "interfaceTrapDto" : [ { "interfaceName" : "XGigabitEthernet0/0/2", "upDownTrapEnable" : true } ] } ] }
  • 响应示例 返回状态码为200:修改接口的链路层状态变化告警开关配置响应。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : ["705a719d-82fe-4f4e-aac3-521cb2ea08b3","705a719d-82fe-4f4e-aac3-521cb2ea08b4"], "failList" : [ { "errcode" : "0", "errmsg" : "", "deviceId" : "fbde1c5d-5b94-49e3-a912-48641015e45c" } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 updownTrapConfigDto 是 REFERENCE 详细请参见表2。 修改接口的链路层状态变化告警开关配置信息 - 表2 UpdownTrapConfigDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 upDownTrapInfos 是 ARRAY_REFERENCE 1-20个列表项,详细请参见表3。 该字段可能包含敏感信息和个人数据,请妥善做好保护。 接口列表。 - 表3 UpDownTrapInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID,UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" interfaceTrapDto 是 ARRAY_REFERENCE 1-100个列表项,详细请参见表4。 该字段可能包含敏感信息和个人数据,请妥善做好保护。 接口列表。 - 表4 InterfaceTrapDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaceName 是 string 1~64个字符。 - 设备名称。 "XGigabitEthernet0/0/2" upDownTrapEnable 是 boolean true false true 是否使能接口的链路层状态变化告警开关。默认值为true。 true
  • 附录一(可定制编程接口) 表1 可定制编程接口 可定制编程接口示例 /restconf/v1/data/huawei-ac-applications:applications /restconf/v1/data/huawei-ac-applications:applications/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx} /restconf/v1/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/operations/{xxx} /restconf/v1/operations/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v1/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/operations/huawei-nce-aoc-config-template-application:create-template-app /restconf/operations/huawei-nce-aoc-config-template-application:batch-delete-nes /restconf/operations/huawei-nce-aoc-config-template-application:submit-template-app /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id} /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/template/{template-id} /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/template /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/template/{template-id}/variable /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/template/{template-id}/variable/{variable-name} /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/device /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/device/{ne-id} /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/device/{ne-id}/template/{template-id} /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/device/{ne-id}/template/{template-id}/variable /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/device/{ne-id}/template/{template-id}/variable/{variable-name} /restconf/data/huawei-nce-aoc-config-template-application:template-application/{template-app-id}/device/{ne-id}/preview /restconf/operations/huawei-nce-aoc-config-template:query-templates /restconf/operations/huawei-nce-aoc-config-template:query-children-templates-by-id /restconf/operations/huawei-nce-aoc-config-template:query-features-by-template-id /restconf/operations/huawei-nce-aoc-config-template:create-template /restconf/operations/huawei-nce-aoc-config-template:delete-template /restconf/operations/huawei-nce-aoc-config-template:copy-template /restconf/operations/huawei-nce-aoc-config-template:query-template-content /restconf/data/huawei-nce-aoc-config-template-binding:template-binding/{binding-id} /restconf/data/huawei-nce-aoc-config-template-binding:template-binding/{binding-id}/template/{template-id} /restconf/operations/huawei-nce-aoc-config-template-binding:create-template-binding /restconf/operations/huawei-nce-aoc-config-template-binding:query-template-bindings /restconf/operations/huawei-nce-aoc-config-template-binding:query-binding-devices /restconf/operations/huawei-nce-aoc-config-template-binding:unbound-template-binding /restconf/operations/huawei-nce-aoc-config-template-binding:unbound-devices-from-binding /restconf/operations/huawei-nce-aoc-config-template-binding:deploy-template-binding /restconf/operations/huawei-nce-aoc-config-template-binding:batch-deploy-template-binding /restconf/data/huawei-nce-aoc-config-template-binding:template-binding/{binding-id}/device/{device-id}/different-preview /restconf/data/huawei-nce-aoc-config-template-binding:template-binding/{binding-id}/device/{device-id}/preview /restconf/data/huawei-nce-aoc-config-template-binding:template-binding/{binding-id}/device/{device-id}/deployed-view /restconf/operations/huawei-nce-aoc-config-template:replace-template /restconf/operations/huawei-nce-aoc-config-template:create-temporary-job /restconf/operations/huawei-nce-aoc-config-template:edit-temporary-template /restconf/operations/huawei-nce-aoc-config-template:execute-temporary-job /restconf/operations/huawei-nce-aoc-config-template:query-temporary-change /restconf/operations/huawei-nce-aoc-config-template:delete-temporary-job /restconf/v2/data/huawei-ac-applications:applications /restconf/v2/data/huawei-ac-applications:applications/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-applications:applications/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes:inventory-cfg/nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} /restconf/v2/data/huawei-ac-nes-device:nes/ne/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx}/{xxx} 父主题: 开放可编程接口
  • 响应示例 返回状态码为200:查询成功,响应体参考QuerySecurityZoneResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : 10, "pageIndex" : 1, "data" : [ { "id" : "000000-0000-0000-0000-000000000000", "name" : "test_1", "description" : "XXX", "priority" : 50, "attackDefenseEnable" : false, "isDefault" : false } ] } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/policy/security/zone 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-1000] 1 当前页数,默认是1。 1 pageSize 否 int32 [0-1000] 20 每页显示数量,默认是20。 20 sort 否 string 0~255个字符。 - 排序字段。 "name" id 否 string 0~64个字符。 - 安全域ID。 "000000-0000-0000-0000-000000000000" zoneName 否 string 0~64个字符。 - 安全 域名 称,支持模糊匹配。 "trust" queryDefault 否 boolean true false false 是否仅查询默认的安全域,为空时则混合查询。 false
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/security/zone?pageIndex=1&pageSize=20&sort=name&id=000000-0000-0000-0000-000000000000&zoneName=trust&queryDefault=false 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:查询成功,响应体参考QuerySecurityZoneResponse。 表2 QuerySecurityZoneResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" totalRecords int32 [0-65535] - 总的数据条数。 1 pageSize int32 [0-65535] - 每页显示数量。 10 pageIndex int32 [0-65535] - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表5。 安全域信息。 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/bandwidth-management-policies/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 { "bandwidthMgrPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ] }
  • 响应示例 返回状态码为200:删除成功,响应体参考BandwidthMgrPolicyResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } } ] } 返回状态码为204:执行成功,没有数据。 HTTP/1.1 204 No Content Date: Sun,16 Feb 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,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:查询成功返回。 表2 QueryRouteBgpResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表18。 查询返回的Bgp信息,兼容老版本,不推荐使用。 - bgpPeers ARRAY_REFERENCE 0-32个列表项,详细请参见表3。 查询返回的BGP对等体信息。 - 表3 RouteLinkAllBgpInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkId string 36个字符。 - 互联接口标识。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" linkName string 0~64个字符。 - 互联接口名称, 创建、更新不填,查询返回。 "ConnectLink" deviceId string 36个字符。 - 设备标识。创建、更新不填。查询返回。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceName string 0~64个字符。 - 设备名称,创建、更新不填,查询返回。 "Core-1" deviceType string 0~10个字符。 - 设备类型,创建、更新不填,查询返回。 "LSW" configSource string 0~32个字符。 - 配置源 "LANWAN" bgpPeer REFERENCE 详细请参见表32。 BGP对等体配置参数 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功返回。 HTTP/1.1 200 OK Date: Sun,16 Feb 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-4b06d5151e2e", "peerInfo" : { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 } }, "coreBgpAdvancedInfo" : { "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false }, "gatewayBgpAdvancedInfo" : { "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false }, "coreBgpPeers" : [ { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } ], "gatewayBgpPeers" : [ { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } ] }, "bgpPeers" : [ { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "configSource" : "LANWAN", "bgpPeer" : { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/interconnection/route/bgp?linkId=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
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/terminal-privacy/b9b34988-0dff-4def-9e55-7bc0b3dc21b4/site?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-ACCESS-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:查询成功,响应体参考SitesInTerminalPrivacy。 表3 SitesInTerminalPrivacy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string - - 错误信息。当没有错误时返回""。 "" pageIndex int32 - - 页码。 1 pageSize int32 - - 页长。 20 total int32 - - 站点总数。 100 sites ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 站点列表。 - 表4 SiteInTerminalPrivacy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 站点ID。 "4b573916-11f3-4dd6-ba5b-ebf04c74dae8" name string - - 站点名称。 "site1" siteType string - - 站点类型。 "AP" 返回状态码为400:查询失败,参数校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:查询失败,服务内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考SitesInTerminalPrivacy。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "pageIndex" : 1, "pageSize" : 20, "total" : 100, "sites" : [ { "id" : "4b573916-11f3-4dd6-ba5b-ebf04c74dae8", "name" : "site1", "siteType" : "AP" } ] } 返回状态码为400:查询失败,参数校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /controller/campus/api/v1/terminal-privacy/{privacyId}/site 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 privacyId 是 string - - 终端隐私设置策略ID,UUID格式。 "b9b34988-0dff-4def-9e55-7bc0b3dc21b4" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - 1 页码,该字段的取值范围是:1-2147483647。 1 pageSize 否 int32 [10-100] 10 页长,该字段的取值范围是:10-100。 10
  • URI /controller/campus/v1/networkservice/networkconfig/net/domainname/sites/{siteId}/domainnames 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
共100000条