华为云用户手册

响应示例 返回状态码为200：接口调用成功，响应体参考QueryGreTunnelResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "fc00:3::1/64", "srcIpAddress" : "192.168.1.1", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "destVpnId" : "00000000-0000-0000-0000-000000000000", "destWanLinkId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "key" : "123456", "checkSum" : "", "enableIpsec" : "", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "enableKeepAlive" : false, "period" : 5, "retryTimes" : 3, "mtu" : 1500 } ] } 返回状态码为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的示例 GET /controller/campus/v1/sdwan/net/site/inter/connect/gre/tunnel?id=fbb684c8-0d37-496f-bafa-4b06d5151e2e&siteId=fbb684c8-0d37-496f-bafa-4b06d5151e2e&deviceId=00000000-0000-0000-0000-000000000000&vpnId=00000000-0000-0000-0000-000000000000&keyWord=Tunnel0/0/1&pageIndex=1&pageSize=20&order=asc 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

URI /controller/campus/v1/sdwan/net/site/inter/connect/gre/tunnel 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 string - - GRE Tunnel id。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" siteId 否 string - - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceId 否 string - - 设备ID。 "00000000-0000-0000-0000-000000000000" vpnId 否 string - - VPN ID。 "00000000-0000-0000-0000-000000000000" keyWord 否 string - - 查询关键字。 "Tunnel0/0/1" pageIndex 否 int32 - 1 当前页数，默认是1。 1 pageSize 否 int32 - 20 每页显示数量，默认是20。 20 order 否 string 0~20个字符。 - 按照Tunnel端口名排序，asc:升序，desc：降序，不填写不排序。 "asc"

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/saas/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 { "pathSelectionPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "PathSelectionPolicy", "description" : "description", "networkAssessmentInfo" : { "lossBaseLine" : 1, "lossFactor" : 50, "delayBaseLine" : 100, "delayFactor" : 50, "loadBalanceInfo" : { "balanceEnable" : true, "lossDiffer" : 10, "delayDiffer" : 50, "srcIpBalanceEnable" : false } }, "appDetectionUrlInfos" : [ { "detectionUrlId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "appName" : "Google", "detectionUrl" : "https://www.huawei.com" } ], "detectionInfo" : { "type" : "HTTP", "frequency" : 300, "probeCount" : 10, "interval" : 5 } } ] }

响应参数 返回状态码为200：删除成功，响应体参考PathSelectionPolicyResponse。 PathSelectionPolicyResponse对象的参数列表，详细请参见表8。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考PathSelectionPolicyResponse。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除成功，响应体参考PathSelectionPolicyResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "PathSelectionPolicy", "description" : "description", "networkAssessmentInfo" : { "lossBaseLine" : 1, "lossFactor" : 50, "delayBaseLine" : 100, "delayFactor" : 50, "loadBalanceInfo" : { "balanceEnable" : true, "lossDiffer" : 10, "delayDiffer" : 50, "srcIpBalanceEnable" : false } }, "appDetectionUrlInfos" : [ { "detectionUrlId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "appName" : "Google", "detectionUrl" : "https://www.huawei.com" } ], "detectionInfo" : { "type" : "HTTP", "frequency" : 300, "probeCount" : 10, "interval" : 5 } } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "PathSelectionPolicy", "description" : "description", "networkAssessmentInfo" : { "lossBaseLine" : 1, "lossFactor" : 50, "delayBaseLine" : 100, "delayFactor" : 50, "loadBalanceInfo" : { "balanceEnable" : true, "lossDiffer" : 10, "delayDiffer" : 50, "srcIpBalanceEnable" : false } }, "appDetectionUrlInfos" : [ { "detectionUrlId" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "appName" : "Google", "detectionUrl" : "https://www.huawei.com" } ], "detectionInfo" : { "type" : "HTTP", "frequency" : 300, "probeCount" : 10, "interval" : 5 } } } ], "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考PathSelectionPolicyResponse。 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的示例 POST /controller/campus/v1/sdwan/policy/bind-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 { "policyId" : "00000000-0000-0000-0000-000000000000", "policyType" : "qos", "effectImmediate" : true, "sites" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site1", "tnpIds" : [ "00000000-0000-0000-0000-000000000000" ], "externalPortIds" : [ "00000000-0000-0000-0000-000000000000" ], "lanPortIds" : [ "00000000-0000-0000-0000-000000000000" ], "devicePortTypes" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "portType" : "EvpnTunnel" } ], "destSites" : [ "00000000-0000-0000-0000-000000000000" ] } ], "status" : "committing" }

响应参数 返回状态码为200：配置成功，响应体参考ApplyPolicyResponse。 ApplyPolicyResponse对象的参数列表，详细请参见表6。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考ApplyPolicyResponse。 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

接口约束 1、该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、当policyType为vpn bandwidth时，接口返回202，表示请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功；接口返回其他状态码，表示请求已处理完成。当policyType为其他类型时，接口在提交之后立即返回，实际业务还在执行中，可通过对应策略的查询接口查询执行状态。 3、当policyType为traffic filter、vpn bandwidth、qos时，不支持绑定策略到FW网关站点。

响应示例 返回状态码为200：配置成功，响应体参考ApplyPolicyResponse。 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" : "", "errparam" : "["policyName"]", "processInstanceId" : "" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考ApplyPolicyResponse。 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

响应示例 返回状态码为201：创建交换机防攻击策略配置成功，返回交换机防攻击策略配置信息。 HTTP/1.1 201 Created Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部服务错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为201：创建交换机防攻击策略配置成功，返回交换机防攻击策略配置信息。 表6 DefendPolicyResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表7。 防攻击策略 - 表7 DefendPolicyDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 whitelist ARRAY_REFERENCE 1个列表项，详细请参见表8。 交换机防攻击策略白名单列表。 - id string 32个字符。 - 防攻击策略id "fbb684c80d37406fbafa4b06d6151e2e" 表8 WhiteListDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 aclConfigType string Profile Custom - ACL配置方式。 "Custom" aclProfileId string 0~36个字符。 - ACL模板ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" customAclRuleList ARRAY_REFERENCE 1-32个列表项，详细请参见表9。 自定义ACL规则列表。 - 表9 AclRule对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ruleId int64 [0-4294967294] - 规则优先级编号。 1 policy string permit deny - 策略，有效值permit，deny。 "permit" protocol string udp tcp any icmp - 协议，有效值udp，tcp，any，icmp，为空时，默认赋予值为any。 "tcp" srcIp string 0~64个字符。 - 源IP地址，可以输入Any表示任意IP，支持通配符掩码，如192.168.1.0/0.255.0.255。 "192.168.1.0/24" srcPort string 0~65535个字符。 - 源端口号，或源端口段。范围：整数（例如1000）或者整数段（1-100），且整数和整数段包含的值在0~65535。 "23" dstIp string 0~64个字符。 - 目的IP地址，可以输入Any表示任意IP，支持通配符掩码，如192.168.1.0/0.255.0.255。 "192.168.2.0/24" dstPort string 0~65535个字符。 - 目的端口号，或目的端口段。范围：整数（例如1000）或者整数段（1-100），且整数和整数段包含的值在0~65535。 "24" description string 0~127个字符。 - 规则描述。 "Rule1" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/api/v1/networkconfig/lswdefendpolicy/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/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 { "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" } ] } ] }

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

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 创建交换机防攻击策略配置信息。 - 表3 CreateDefendPolicyDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 whitelist 是 ARRAY_REFERENCE 1个列表项，详细请参见表4。 交换机防攻击策略白名单列表。 - 表4 WhiteListDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 aclConfigType 是 string Profile Custom - ACL配置方式。 "Custom" aclProfileId 否 string 0~36个字符。 - ACL模板ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" customAclRuleList 否 ARRAY_REFERENCE 1-32个列表项，详细请参见表5。 自定义ACL规则列表。 - 表5 AclRule对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ruleId 是 int64 [0-4294967294] - 规则优先级编号。 1 policy 是 string permit deny - 策略，有效值permit，deny。 "permit" protocol 否 string udp tcp any icmp - 协议，有效值udp，tcp，any，icmp，为空时，默认赋予值为any。 "tcp" srcIp 否 string 0~64个字符。 - 源IP地址，可以输入Any表示任意IP，支持通配符掩码，如192.168.1.0/0.255.0.255。 "192.168.1.0/24" srcPort 否 string 0~65535个字符。 - 源端口号，或源端口段。范围：整数（例如1000）或者整数段（1-100），且整数和整数段包含的值在0~65535。 "23" dstIp 否 string 0~64个字符。 - 目的IP地址，可以输入Any表示任意IP，支持通配符掩码，如192.168.1.0/0.255.0.255。 "192.168.2.0/24" dstPort 否 string 0~65535个字符。 - 目的端口号，或目的端口段。范围：整数（例如1000）或者整数段（1-100），且整数和整数段包含的值在0~65535。 "24" description 否 string 0~127个字符。 - 规则描述。 "Rule1"

响应示例 返回状态码为200：查询成功，响应体参考QueryCustomApplicationResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "appName" : "app", "description" : "", "extendApp" : false, "appType" : "", "appGroups" : [ "00000000-0000-0000-0000-000000000000" ], "applicationGroups" : [ { "applicationGroupName" : "", "applicationGroupId" : "" } ], "applicationRules" : [ { "ruleName" : "rule", "ruleId" : "00000000-0000-0000-0000-000000000000", "description" : "tcpRule", "destinationIP" : "10.1.1.1/32", "port" : "1,2,3-20", "protocolType" : "tcp", "signatureEnable" : false, "context" : "flow", "direction" : "request", "plainString" : "abcde", "dscp" : 20, "domain" : "www.example.com", "sourceIp" : "192.168.10.5/32", "sourcePortRange" : "30-50" } ], "configId" : "00000000-0000-0000-0000-000000000000" } ] } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：查询成功，响应体参考QueryCustomApplicationResponse。 表2 QueryCustomApplicationResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-2304个列表项，详细请参见表7。 自定义应用信息。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/application/custom-applications 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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nat-address-group:snat-address-group 表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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nat-address-group:snat-address-group 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"

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

响应示例 返回状态码为200：删除成功，响应体参考QosProfileResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ { "id" : "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 } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "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 } } ] } 返回状态码为204：执行成功，无响应体。 HTTP/1.1 204 No Content Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误，无响应体。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误，无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/qos-profiles/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 { "qosProfiles" : [ { "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 } ] }

响应参数 返回状态码为200：接口调用成功，响应体参考BgpRoutePeerResponse。返回的BGP路由信息中仅包含对应的vpnId，siteId，deviceId。 BgpRoutePeerResponse对象的参数列表，详细请参见表4。 返回状态码为204：接口调用成功，无响应体。 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：接口调用成功，响应体参考BgpRoutePeerResponse。返回的BGP路由信息中仅包含对应的vpnId，siteId，deviceId。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ] } } ] } 返回状态码为204：接口调用成功，无响应体。 HTTP/1.1 204 No Content Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/bgp-peer-info/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 { "peerInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ] } ] }

请求示例 HTTP的示例 POST /v1/networkservice/hierarchy-template/template-groups/00000000-0000-0000-0000-000000000000/template-bindings 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 { "bindId" : "00000000-0000-0000-0000-000000000000", "siteIds" : [ "00000000-0000-0000-0000-000000000000" ] }

响应示例 返回状态码为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 { "totalRecords" : 100, "progress" : 0.9, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "TemplateBinding1", "templateId" : "00000000-0000-0000-0000-000000000000", "createTime" : "1713880927744", "description" : "this is TemplateBinding1", "totalDeviceNum" : 100, "deployedLastestSuccessDeviceCount" : 100, "templateBindingStatus" : "last-template-partly-deployed", "deployLastVersion" : true, "templateName" : "this is template1", "devices" : { "totalRecords" : 100, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "device1", "ip" : "127.0.0.1", "siteName" : "site1", "deployStatus" : "deployment-successed", "deployTime" : "1713880927744", "deployLastVersion" : true, "deployErrorMsg" : {"errorCode":"0x00c8000c","errorType":"APPLICATION","message":"The request failed because the mandatory node is empty"} } ] } } ] } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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的示例 GET /controller/campus/v1/networkservice/networkconfig/profile/apvpn/encryptionpolicy/fbb684c8-0d37-496f-bafa-4b06db151e2e 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：查询成功。 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" : { "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e", "name" : "TEST", "ikeVersion" : "v1", "ikeEncryptAlgorithm" : "aes-256", "ikeNegotiationMode" : "main", "ikeAuthAlgorithm" : "sha2-256", "ikeIntegrityAlgorithm" : "sha2-256", "ikePrf" : "sha2-256", "ipsecTransformProtocol" : "ah", "ipsecEncapsulationMode" : "tunnel", "ipsecAhAuthAlgorithm" : "sha2-256", "ipsecAuthAlgorithm" : "sha2-256", "ipsecEncryptAlgorithm" : "aes-256", "ipsecPfs" : "group1", "ipsecLifetimeSeconds" : "30", "ipsecLifetimeKilobytes" : "256", "ipsecDpdType" : "periodic", "ipsecDpdMsg" : "seq-hash-notify", "ipsecDpdInterval" : "30", "ipsecDpdTimeout" : "15", "ikeDh" : "group1", "ikeLifeTime" : "60" } }