华为云用户手册

请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-if 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"

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

请求示例 HTTP的示例 GET /v1/performanceservice/identify/instances/5c37d9e8-cdf6-11e8-a4fc-286ed488df6b 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" : "Success", "data" : { "name" : "test", "description" : "五元组模板", "fiveTuple" : { "protocol" : "TCP", "srcIp" : "192.168.0.1/32", "dstIp" : "192.168.0.1/32", "srcPortRange" : "100-200", "dstPortRange" : "200", "fiveTupleType" : 0 }, "id" : "9a157da3-9e59-41c9-8312-254a38a3b275" } } 返回状态码为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：查询识别流模板数据成功后的状态返回码。 表2 StreamProfileDetailOutPut对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" data REFERENCE 详细请参见表3。 模板详情信息 - 表3 StreamProfilePutInput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~256个字符。 - 模板名称 "test" description string 0~512个字符。 - 模板描述 "五元组模板" fiveTuple REFERENCE 详细请参见表4。 五元组信息 - id string 1~36个字符。 - 模板id "9a157da3-9e59-41c9-8312-254a38a3b275" 返回状态码为400：查询识别流模板数据失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500：接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/site/fbde1c5d-5b94-49e3-a912-48641015e45c/apssid?isReturnPwd=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：站点内SSID信息，返回结构体参见QuerySsidResponse。 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" : "de5813f8ff1e41f5ba9c324da70b49ed", "name" : "Huawei-Guest", "pki" : "default", "tags" : [ { "name" : "testApTag" } ], "strategyId" : "6e930b21-a107-45a9-96a2-f1443ca82f39", "enable" : true, "connectionMode" : "bridge", "vlans" : [ { "priority" : 0, "vlanId" : 10, "vlanDesc" : "work", "tags" : [ { "name" : "testApTag" } ] } ], "vlanId" : 10, "vlanDesc" : "work", "vlanMode" : "vlanId", "vlanPoolId" : "1e930b21-a307-45a9-96a2-f1443ca84f39", "vlanPoolName" : "vlanPool", "hidedEnable" : false, "autoOffTrackLinkEnable" : false, "arpCheckEnable" : true, "ipCheckEnable" : true, "dhcpStrictEnable" : false, "dhcpv6SlaacStrictEnable" : 0, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "gameSpeedUpEnable" : false, "relativeRadios" : 3, "relativeOnlyTwoRadios" : 3, "dtimInterval" : 1, "advertiseApNameSwitch" : true, "frequencyNavigation" : true, "maxUserNumber" : 10, "userSeparation" : false, "separationOption" : "disable", "userL2LanIsolate" : false, "staNetworkDetect" : true, "muMiMo" : true, "associationTimeout" : 5, "erSuSwitch" : true, "userFlowSyslogEnable" : false, "multiLinkOper" : false, "lay3RoamSwitch" : true, "suExtendedRangeSwitch" : false, "muRtsSwitch" : false, "muRtsThreshold" : 2347, "forbiddenOldTerminal" : false, "reachMaxSta" : 1, "igmpSnooping" : false, "multicast2Unicast" : "disable", "bcmcDenyAll" : false, "bonjourTransparent" : false, "powerSave" : false, "beacon2gRate" : "1Mbps", "beacon5gRate" : "6Mbps", "beacon6gRate" : "6Mbps", "sipPort" : 5060, "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "timeTemplateName" : "全天", "seaSwitch" : false, "overDsPrivate" : "disable", "blackAndWhite" : { "bindingType" : 2, "terminalMacList" : [ "XX:XX:XX:XX:XX:XX" ], "terminalOUIList" : [ "02:02:01" ] }, "ssidAuth" : { "mode" : "ppsk", "oweTransitionMode" : true, "transitionOpenSsid" : "de5813f8ff1e41f5ba9c324da70b49ed", "pskEncryptType" : "wpa2", "wepType" : "WEP40", "wepDefaultKey" : 0, "enableMacAuth" : false, "saeEncryptType" : "", "saeSecurityKey" : "", "pskSaeEncryptType" : "", "pskSaeSecurityKey" : "", "securityKey" : "", "securityKeyType" : "AES", "dot1xEncryptType" : "", "dot1xQuietPeriod" : 60, "dot1xQuietTimes" : 10, "portal" : { "mode" : "portalDisable", "pushProtocol" : "https", "freeAuthEnable" : true, "authExpireUnit" : "day", "authExpire" : 10, "escapeStrategy" : 2, "escapeProfileName" : "escapeStrategy1", "escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c", "freeAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "freeAclTmplName" : "free-rule", "controllerPortalType" : "haca", "masterPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "masterPortalTmplName" : "", "bakPortalEnable" : false, "bakPortalTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "bakPortalTmplName" : "", "authRedirectUrlCarryEnable" : false, "radiusEnable" : false, "radiusTmplId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "radiusTmplName" : "", "fastPushEnable" : true, "portalPageId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "wechatUrlAuthEnable" : false, "weComAuthEnable" : false, "dingTalkEnable" : false, "normalEnable" : false, "registerEnable" : false, "registerExpire" : 2, "registerExpireUnit" : "hour", "userRegisterMaxAccessNumber" : 0, "userGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "smsAuthEnable" : false, "smsPasswordExpire" : 5, "smsPasswordExpireUnit" : "minute", "smsUserRegisterEnable" : false, "smsUserExpire" : 2, "smsUserExpireUnit" : "hour", "smsUserMaxAccessNumber" : 0, "smsUserGroupId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc", "emailAuthEnable" : false, "passCodeEnable" : false, "oneKeyAuthEnable" : false, "anonymousEnable" : false, "socialMediaEnable" : false, "twitterEnable" : false, "sinaEnable" : false, "qqEnable" : false, "qrCodeAuthEnable" : false, "qrCodeRegisterEnable" : false, "googleEnable" : false, "accountingEnable" : false, "accountingExpire" : 15, "interconnectionMode" : "API", "userNameKey" : "用户", "passwordKey" : "", "urlMatchMode" : 0, "successUrlKey" : "", "authFailedUrlKey" : "", "logoutSuccessUrlKey" : "", "logoutFailedUrlKey" : "", "logoutUrlKey" : "", "radiusModelId" : "0b6d8077-947a-41d0-a539-c8a02c5fe6dc" }, "radius" : { "radiusTmplId" : "", "radiusTmplName" : "", "staticEnable" : "", "iconnectAccessEnable" : "", "autoReauthenTime" : "", "hacaEnable" : "" }, "macAutoBinding" : true, "macAuthMethod" : "", "escapeStrategy" : "noAuth", "escapeProfileName" : "escapeStrategy1", "escapeProfileId" : "5871926c-2a5e-4340-a931-19ce019a231c", "haca" : { "authComponentId" : "00000000-0000-0000-0000-000000000000", "authComponentIp" : "10.20.0.0", "bakAuthComponentId" : "00000000-0000-0000-0000-000000000000", "bakAuthComponentIp" : "10.20.0.0" } }, "vapBackupConfig" : { "vapBackupEnable" : false, "radiusBackupTmplId" : "cf23f275-01e6-4301-890e-407e1d78c53e", "rejectNewAccess" : false }, "ssidPolicy" : { "securityPolicy" : { "highReliableSliceAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "highReliableSliceAclTplName" : "test-slice-acl", "highReliableSliceAclTplIdIpv6" : "b90f8190-e12f-4323-95f3-4018309209c4", "highReliableSliceAclTplNameIpv6" : "test-slice-acl", "securityAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "securityAclTmplName" : "test-security-acl", "securityIPv6AclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c4", "securityIPv6AclTmplName" : "test-security-acl", "tunnelAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "tunnelAclTmplName" : "test-tunnel-acl", "ipsecAclTmplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "ipsecAclTmplName" : "test-ipsec-acl", "tcpAdjustMss" : 1380, "appTrafficAcls" : { "appTrafficAclList" : [ { "direction" : "inbound", "index" : 0, "dscp" : 1, "appTrafficAclTplId" : "b90f8190-e12f-4323-95f3-4018309209c5", "appTrafficAclName" : "test-tunnel-acl" } ] }, "urlFilter" : { "enable" : true, "mode" : 1, "urls" : [ "" ], "hostNames" : [ "" ] }, "appsPolicys" : { "siteSaList" : [ { "appId" : 1, "type" : "app", "appType" : 1, "appName" : "test_name", "action" : "permit", "dscp" : 1, "car" : 1000 } ] } }, "ssidRateLimit" : { "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0" }, "terminalRateLimit" : { "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0", "timeRange" : [ { "timeTemplateId" : "b90f8190-e12f-4323-95f3-4018309209c4", "upEnable" : true, "upLimit" : "50.0", "downEnable" : true, "downLimit" : "50.0" } ] }, "terminalDynamicRateLimit" : { "dynamicEnable" : false, "dynamicLimit" : 16 }, "ipv6Enable" : false, "ndTrustPort" : false }, "dot11r" : false, "overDs" : false, "reassociateTimeout" : 1, "serviceGuarantee" : "performanceFirst", "activeDullClient" : false, "wmmScene" : "default", "edcaClientConfigList" : [ { "accessCategory" : "acvo", "aifsn" : 10, "ecwmax" : 10, "ecwmin" : 10, "txoplimit" : 10 } ], "insertOption82Enable" : false, "option82" : { "circuitId" : { "connectorPattern" : "colon", "contentType" : "ap-mac", "format" : "ascii", "userDefinedText" : "xxx" }, "remoteId" : { "connectorPattern" : "colon", "contentType" : "ap-mac", "format" : "ascii", "userDefinedText" : "xxx" } }, "forwardMode" : "direct", "softgreProfileId" : "fbde1c5d-5b94-49e3-a912-48641015e45f", "configName" : "ssid-config-name", "phyProtection" : "security-priority" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：站点内SSID信息，返回结构体参见QuerySsidResponse。 表3 QuerySsidResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-100个列表项，详细请参见表27。 SSID信息，结构体参见SsidConfigOut。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

URI /controller/campus/v3/networkconfig/site/{siteId}/apssid 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 UUID 36个字符。 - 站点标识，UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 isReturnPwd 否 boolean true false false 是否返回SSID密码。 false

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-queue-template:user-queue-profile/{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~63个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 模板名称，单一主键字段。 "UserQueueProfile"

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-queue-template:user-queue-profile/UserQueueProfile 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 { "huawei-nce-e-queue-template:user-queue-profile" : [ { "config-status" : "reserved", "last-committed-time" : "last-committed-time", "related-pkg-version" : "related-pkg-version", "edit-state" : "RUNNING", "name" : "UserQueueProfile", "mode" : "normal", "description" : "test", "traffic-behavior-user-queue" : [ { "name" : "name", "scheduler-mode" : "pq", "weight" : 10, "cir" : 64, "pir" : 10, "cir-percent" : 20, "pir-percent" : 30, "cbs" : 10, "pbs" : 10 } ] } ] } 返回状态码为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/v3/profile/escape/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 { "ids" : [ "4f350825-919c-47b7-b853-f51f15912396" ] }

响应示例 返回状态码为200：删除逃生模板的返回信息。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "success" : [ "4f350825-919c-47b7-b853-f51f15912396" ], "fail" : [ { "errcode" : "0302000020", "errmsg" : "The amount of deleting escape template exceeds the maximum limit.", "data" : "4f350825-919c-47b7-b853-f51f15912392" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应示例 返回状态码为200：接口调用成功，响应体参考OverlayWanBgpPolicyAllTemplateResponse。 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" : "", "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 10, "data" : [ { "templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "templateName" : "Template1", "templateDesc" : "template desc", "vpnId" : "310473a6-8006-48a3-9558-543d32ea1757", "vpnName" : "VPN", "siteCount" : "20" } ] } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

URI /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/vpn 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 string - - vpnId。必填参数。 "00000000-0000-0000-0000-000000000000" templateName 否 string - - 模板名称。 "Template1" pageIndex 否 int32 [0-2147483647] - 页面索引，不填时默认为1。 1 pageSize 否 int32 [0-1000] - 页面大小。 10

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/vpn?vpnId=00000000-0000-0000-0000-000000000000&templateName=Template1&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：查询成功，响应体参考QueryTenantCAServerResponse。 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" : [ { "tenantId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "caServerId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "caName" : "cusCA", "caUrl" : "http://host:port/certsrv/mscep/mscep.dll", "caHttpsUrl" : "https://host:port/certsrv/mscep/mscep.dll" } ] } 返回状态码为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/oamservice/certification/caserver?tenantId=fbb684c8-0d37-496f-bafa-4b06d5151e2e HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy

响应参数 返回状态码为200：查询成功，响应体参考QueryTenantCAServerResponse。 表2 QueryTenantCAServerResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-20个列表项，详细请参见表3。 租户授权CA服务器信息。 - 表3 TenantCAServer对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 tenantId string 0~64个字符。 - 租户ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" caServerId string - - CA服务器ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" caName string 0~64个字符。 - CA服务器名称。 "cusCA" caUrl string 0~128个字符。 - CA服务器http方式SCEP证书申请URL。 "http://host:port/certsrv/mscep/mscep.dll" caHttpsUrl string 0~128个字符。 - CA服务器https方式SCEP证书申请URL。 "https://host:port/certsrv/mscep/mscep.dll" 返回状态码为400：校验异常，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /v1/networkservice/hierarchy-template/template-groups/tasks/00000000-0000-0000-0000-000000000000/template-bindings/00000000-0000-0000-0000-000000000000/binding-devices?pageIndex=1&pageSize=20&deviceName=device1&siteName=site1 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 /v1/networkservice/hierarchy-template/template-groups/tasks/{taskId}/template-bindings/{bindId}/binding-devices 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 taskId 是 string 36个字符。 - 绑定任务ID，UUID格式。 "00000000-0000-0000-0000-000000000000" bindId 是 string 36个字符。 - 绑定关系ID，UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-2000] 1 页码。 1 pageSize 否 int32 [1-100] 20 每页数量。 20 deviceName 否 string 0~128个字符。 - 设备名称。 "device1" siteName 否 string 0~128个字符。 - 站点名称。 "site1"

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

响应示例 返回状态码为201：创建成功，响应体参考SessionWhitelistResponse。 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" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policy1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "ruleCount" : 1, "sessionWhitelistType" : "spr,firewall", "aclRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocolNum" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePortStart" : 1, "sourcePortEnd" : 1, "destinationPortStart" : 1, "destinationPortEnd" : 1 } ] } ] } 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/session-whitelist/00000000-0000-0000-0000-000000000000 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", "policyName" : "policy1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "ruleCount" : 1, "sessionWhitelistType" : "spr,firewall", "aclRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocolNum" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePortStart" : 1, "sourcePortEnd" : 1, "destinationPortStart" : 1, "destinationPortEnd" : 1 } ] }

请求示例 HTTP的示例 POST /controller/campus/v1/lanwan/interconnection/route/static/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 { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreStaticRouteIdList" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "gatewayStaticRouteIdList" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"] }

响应示例 返回状态码为200：删除IPv4静态路由返回体。 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" : { "vnId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreStaticRouteIdList" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "gatewayStaticRouteIdList" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"] }, "fail" : { "coreStaticRouteIdList" : { "errcode" : "0", "errmsg" : "", "routeIdList" : [ "" ] }, "gatewayStaticRouteIdList" : { "errcode" : "0", "errmsg" : "", "routeIdList" : [ "" ] } } } 返回状态码为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：查询成功，响应体参考QueryDynamicQosPolicyResponse。 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" : "00000000-0000-0000-0000-000000000000", "name" : "qos1", "direction" : "Outbound", "peerSiteNum" : 1, "ruleNum" : 1, "adaptiveQosEnable" : false } ] } 返回状态码为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/policy/traffic/dynamic/qos/00000000-0000-0000-0000-000000000000 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：修改成功，响应体参考SyslogResponse。 SyslogResponse对象的参数列表，详细请参见表3。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考SimpleResponse。 SyslogResponse对象的参数列表，详细请参见表3。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。