华为云用户手册

  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-l3-sub-interface:l3-sub-interface 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" { "huawei-nce-e-l3-sub-interface:l3-sub-interface" : [ { "config-status" : "", "last-committed-time" : "", "related-pkg-version" : "", "edit-state" : "", "if-name" : "Vbdif20.20", "dot1q-vlans" : { "vlan-list" : "20" }, "vlan-type-dot1q" : { "vlan-type-vid" : 20 } } ] }
  • 响应示例 返回状态码为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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-l3-sub-interface:l3-sub-interface 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-l3-sub-interface:l3-sub-interface 是 REFERENCE 详细请参见表4。 l3 sub interface parameters - 表4 nes-ne-l3-sub-interface-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-l3-sub-interface:l3-sub-interface 否 ARRAY_REFERENCE 详细请参见表5。 l3 sub interface parameters - 表5 nes-ne-l3-sub-interface对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 config-status 否 string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved - - last-committed-time 否 string 0~255个字符。 - 最后提交时间,该特性最后提交时间;不支持编辑,仅查询返回。 - related-pkg-version 否 string 0~255个字符。 - 包版本,插件包版本;不支持编辑,仅查询返回。 - edit-state 否 string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态,对应运行状态、候选状态、取消部署状态、未部署状态;不支持编辑,仅查询返回。 - if-name 否 string 1~63个字符。 - Interface name "Vbdif20.20" dot1q-vlans 否 REFERENCE 详细请参见表6。 Configure dot1q termination. - vlan-type-dot1q 否 REFERENCE 详细请参见表7。 Configure VLAN-type dot1q. - 表6 dot1q-vlans对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vlan-list 是 string 满足正则表达((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])?(-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))?(,((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])(-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))?))*)|((([\\+|\\-](409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))|([\\+|\\-]\\((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\\)))?(,(([\\+|\\-](409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9]))|([\\+|\\-]\\((409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])-(409[0-4]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{1,2}|[1-9])\\))))*)。 - Dot1q termination VLAN ID list. The VLAN in VLAN-list can not exist in the VLAN-list of dot1q-VLANs-group. "20" 表7 vlan-type-dot1q对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vlan-type-vid 是 int32 [1-4094] - VLAN ID of the VLAN sub-interface; 20
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryFirewallPolicyResponse。 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", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserDefaultAction" : "deny", "internetToUserFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "userToInternetDefaultAction" : "permit", "userToInternetFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "internetToUserSessionLogEnable" : false, "userToInternetSessionLogEnable" : false, "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_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的示例 GET /controller/campus/v1/sdwan/policy/security/firewall-policies?policyName=qos 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
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryFirewallPolicyResponse。 表2 QueryFirewallPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表8。 防火墙策略信息。 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,返回设备所有MAC静态绑定信息。 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 { "interfaceNameList" : ["GigabitEthernet0/0/1","GigabitEthernet0/0/2"], "staticMacList" : [ { "macAddress" : "XX:XX:XX:XX:XX:XX", "vlanId" : 1, "interfaceName" : "GigabitEthernet0/0/1", "id" : "de5813f8ff1e41f5ba9c324da70b49ed" } ], "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 10, "errcode" : "0", "errmsg" : "" } 返回状态码为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
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/lswstaticmac/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/staticmac?pageIndex=1&pageSize=20 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/v1/networkservice/networkconfig/net/lswstaticmac/devices/{deviceId}/staticmac 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 是 integer [1-1024] - 页面索引,支持静态mac地址列表分页。 1 pageSize 是 integer [1-1000] - 每页显示记录数,支持静态mac地址列表分页。 20
  • 响应示例 返回状态码为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" : { "defendPolicies" : [ { "whitelist" : [ { "aclConfigType" : "Custom", "aclProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "customAclRuleList" : [ { "ruleId" : 1, "policy" : "permit", "protocol" : "tcp", "srcIp" : "192.168.1.0/24", "srcPort" : "23", "dstIp" : "192.168.2.0/24", "dstPort" : "24", "description" : "Rule1" } ] } ], "id" : "fbb684c80d37406fbafa4b06d6151e2e" } ] } } 返回状态码为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/networkconfig/lswdefendpolicy/devices/{deviceId}/defendpolicy 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d6151e2e"
  • 响应参数 返回状态码为200:查询成功。 表2 GetDefendPolicyResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 防攻击策略列表 - 表3 DefendPolicyListDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 defendPolicies ARRAY_REFERENCE 0-1个列表项,详细请参见表7。 查询交换机防攻击策略配置数据列表。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/lswdefendpolicy/devices/fbb684c8-0d37-496f-bafa-4b06d6151e2e/defendpolicy 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
  • 响应参数 返回状态码为204:删除成功。 返回状态码为40X:参数不正确。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。 表2 错误码描述 Status Code Error Code Error Message Parameter 错误说明 400 0x006e004b 解析请求体发生错误。 错误的参数字段。 请求体body存在错误。 409 0x00c80014 设备组{0}不存在。 {0}:设备组名。 删除的设备组不存在。 500 0x00c80006 操作数据库异常。 - 系统内部错误,操作数据库存在异常。
  • 响应示例 HTTP/1.1 204 No Content Server: product only Date: Tue, 19 Nov 2019 21:38:43 GMT Connection: keep-alive Keep-Alive: timeout=60 X-Frame-Options: DENY Strict-Transport-Security: max-age=31536000;incodeSubDomains Cache-Control: no-cache, no-store, must-revalidate X-Content-Type-Options: nosniff Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT X-XSS-Protection: 1; mode=block
  • 请求示例 cURL示例 curl -k -s -L -i -X DELETE \ https://{ip:port}/restconf/data/device-shell-group-northbound:device-shell-group/device-group/cccc2 \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -H 'x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9' HTTP示例 DELETE /restconf/data/device-shell-group-northbound:device-shell-group/device-group/cccc2 HTTP/1.1 Host: {ip:port} Content-Type: application/json x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9 Cache-Control: no-cache
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryPageInfoOutputDto。 表2 QueryPageInfoOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表3。 Portal定制页面信息列表。 - 表3 PortalPageInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - Portal定制页面id,UUID格式 "68b5bc98ed4340dfb586faa161803c56" pageName string 1~128个字符。 - Portal定制页面名称 "page" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryPageInfoOutputDto。 HTTP/1.1 200 OK Date: Tue,31 Dec 2024 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "68b5bc98ed4340dfb586faa161803c56", "pageName" : "page" } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Tue,31 Dec 2024 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: Tue,31 Dec 2024 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 GET /controller/campus/v2/accountservice/portalpage/page?pageName=pageName 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:接口调用成功,响应体参考ClientStatisticalInfoDto。 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" : { "exprWorse" : 10, "exprBad" : 10, "exprGood" : 10, "exprBetter" : 10, "speedBad" : 10, "speedGood" : 10, "speedBetter" : 10, "oneHour" : 100, "oneToTwoHour" : 100, "twoToFourHour" : 100, "fourToSixHour" : 100, "sixToEightHour" : 100, "eightHour" : 100 } } 返回状态码为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
  • 响应参数 返回状态码为200:接口调用成功,响应体参考ClientStatisticalInfoDto。 表2 ClientStatisticalInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码信息。 "0" errmsg string 0~256个字符。 - 结果信息。 "" data REFERENCE 详细请参见表3。 - - 表3 QueryTerminalStatisticsOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 exprWorse int32 [0-2147483647] - 体验-差的终端个数。该字段暂未实现,始终为0。 10 exprBad int32 [0-2147483647] - 体验-一般的终端个数。体验一般的标准为,丢包率大于等于5%。 10 exprGood int32 [0-2147483647] - 体验-良好的终端个数。体验良好的标准为,丢包率大于等于3%且小于5%。 10 exprBetter int32 [0-2147483647] - 体验-优的终端个数。体验优的标准为,丢包率小于3%。 10 speedBad int32 [0-2147483647] - 速度-慢的终端个数。速度慢的标准为,速度小于11Mbps。 10 speedGood int32 [0-2147483647] - 速度-中的终端个数。速度中的标准为,速度大于等于11Mbps且小于等于54Mbps。 10 speedBetter int32 [0-2147483647] - 速度-快的终端个数。速度快的标准为,速度大于54Mbps。 10 oneHour int32 [0-2147483647] - 在线一小时的终端数。 100 oneToTwoHour int32 [0-2147483647] - 在线一至二小时的终端数。 100 twoToFourHour int32 [0-2147483647] - 在线二至四小时的终端数。 100 fourToSixHour int32 [0-2147483647] - 在线四至六小时的终端数。 100 sixToEightHour int32 [0-2147483647] - 在线六至八小时的终端数。 100 eightHour int32 [0-2147483647] - 在线八小时以上的终端数。 100 返回状态码为400:参数错误,查询失败。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/station/online/statistic/b473118d-17ff-4f4f-9fa9-a4c0e1e87e42 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:修改成功,响应体参考TrafficSteeringPolicyResponse。 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", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "TrafficSteeringPolicy", "policyPriority" : 50, "switchoverCondition" : "custom", "delay" : 50, "jitter" : 50, "packetLossRate" : 50, "preferredTransportNetworks" : [ { "transportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "priority" : 1 } ], "secondaryTransportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "enableFixed" : true, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "advancedSetting" : { "enableSwitchThresholdUp" : true, "switchThresholdUp" : 90, "enableSwitchThresholdLow" : true, "switchThresholdLow" : 20, "actionNotSatisfied" : 1, "enableAdvancePriority" : true, "advancePriority" : 1, "switchMode" : 1, "policyBtwTN" : 1, "bwConditionList" : [ { "transportNetwork" : "Internet", "bwUpType" : "0", "bwUpLimitValPer" : "50", "bwLowType" : "0", "bwLowLimitValPer" : "20", "bwAppUpType" : "1", "bwMaxApp" : "20", "bwAppLowType" : "1", "bwMinApp" : "10" } ], "isGwFirst" : false, "enablePacketReplication" : false, "loadBalanceMode" : "Flow" }, "status" : 1, "isActive" : true } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "TrafficSteeringPolicy", "policyPriority" : 50, "switchoverCondition" : "custom", "delay" : 50, "jitter" : 50, "packetLossRate" : 50, "preferredTransportNetworks" : [ { "transportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "priority" : 1 } ], "secondaryTransportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "enableFixed" : true, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "advancedSetting" : { "enableSwitchThresholdUp" : true, "switchThresholdUp" : 90, "enableSwitchThresholdLow" : true, "switchThresholdLow" : 20, "actionNotSatisfied" : 1, "enableAdvancePriority" : true, "advancePriority" : 1, "switchMode" : 1, "policyBtwTN" : 1, "bwConditionList" : [ { "transportNetwork" : "Internet", "bwUpType" : "0", "bwUpLimitValPer" : "50", "bwLowType" : "0", "bwLowLimitValPer" : "20", "bwAppUpType" : "1", "bwMaxApp" : "20", "bwAppLowType" : "1", "bwMinApp" : "10" } ], "isGwFirst" : false, "enablePacketReplication" : false, "loadBalanceMode" : "Flow" }, "status" : 1, "isActive" : true } } ] } 返回状态码为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的示例 PUT /controller/campus/v1/sdwan/policy/traffic/traffic-steering-policies 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 { "effectImmediate" : true, "trafficSteeringPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "TrafficSteeringPolicy", "policyPriority" : 50, "switchoverCondition" : "custom", "delay" : 50, "jitter" : 50, "packetLossRate" : 50, "preferredTransportNetworks" : [ { "transportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "priority" : 1 } ], "secondaryTransportNetworks" : [ "00000000-0000-0000-0000-000000000000" ], "enableFixed" : true, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "advancedSetting" : { "enableSwitchThresholdUp" : true, "switchThresholdUp" : 90, "enableSwitchThresholdLow" : true, "switchThresholdLow" : 20, "actionNotSatisfied" : 1, "enableAdvancePriority" : true, "advancePriority" : 1, "switchMode" : 1, "policyBtwTN" : 1, "bwConditionList" : [ { "transportNetwork" : "Internet", "bwUpType" : "0", "bwUpLimitValPer" : "50", "bwLowType" : "0", "bwLowLimitValPer" : "20", "bwAppUpType" : "1", "bwMaxApp" : "20", "bwAppLowType" : "1", "bwMinApp" : "10" } ], "isGwFirst" : false, "enablePacketReplication" : false, "loadBalanceMode" : "Flow" }, "status" : 1, "isActive" : true } ] }
  • 请求示例 HTTP的示例 PUT /controller/campus/rest/sdwan/v1/device/dot1x/config/disable 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 { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "deviceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956", "interfaceId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956" }
  • 响应示例 返回状态码为200:去使能成功,响应体参考CommonResponse。 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" : "" } 返回状态码为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:接口调用成功,响应体参考QueryCommunityFilterResponse。 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" : 20, "pageIndex" : 1, "data" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "mode" : "basic", "name" : "communityTest", "nodes" : [ { "index" : 1, "matchMode" : "permit", "communityMembers" : ["10"], "regular" : "^65537$" } ] } ] } 返回状态码为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/sdwan/routing-protocol/community-filter?pageIndex=1&pageSize=20&siteId=a99f794e-b510-438c-a75d-de59f02347eb&deviceId=a99f794e-b510-438c-a75d-de59f02347eb 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/v1/sdwan/routing-protocol/community-filter 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-65535] 1 当前页,默认值为1。 1 pageSize 否 int32 [1-100] 20 每页显示数量,默认值为20。 20 siteId 是 string - - 站点ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 是 string - - 设备ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb"
共100000条