华为云用户手册

  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/classification-profiles 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 { "classificationProfiles" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "app", "operator" : "and", "aclType" : "ipv4", "l3Acls" : [ { "priority" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePort" : 1, "sourcePortEnd" : 1, "destinationPort" : 1, "destinationPortEnd" : 1, "dscp" : 1, "protocolNum" : 1, "tcpFlag" : "ack,fin" } ], "applicationGroupIds" : [ "00000000-0000-0000-0000-000000000000" ], "enableVlanRange" : false, "vlanRange" : { "start" : 1, "end" : 4094 }, "enableP8021" : false, "p8021" : 1, "enableSourceMac" : false, "sourceMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableDestinationMac" : false, "destinationMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableL2Protocol" : false, "l2ProtocolNum" : "0x0800", "adn" : false, "experienceLevel" : "", "applyType" : "FW", "sourceIps" : [ "10.1.1.2/32" ], "sourceIpSets" : [ "sourceIp" ], "sourceDomainSets" : [ "domainSet" ], "destIps" : [ "10.1.1.2/32" ], "destIpSets" : [ "destIp" ], "destDomainSets" : [ "domainSet" ], "protocols" : [ { "name" : "TCP", "protocolNum" : 6, "srcPort" : "0-65535", "dstPort" : "0-65535" } ] } ] }
  • 响应示例 返回状态码为200:修改成功,响应体参考ClassificationProfileResponse。 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" : "app", "operator" : "and", "aclType" : "ipv4", "l3Acls" : [ { "priority" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePort" : 1, "sourcePortEnd" : 1, "destinationPort" : 1, "destinationPortEnd" : 1, "dscp" : 1, "protocolNum" : 1, "tcpFlag" : "ack,fin" } ], "applicationGroupIds" : [ "00000000-0000-0000-0000-000000000000" ], "enableVlanRange" : false, "vlanRange" : { "start" : 1, "end" : 4094 }, "enableP8021" : false, "p8021" : 1, "enableSourceMac" : false, "sourceMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableDestinationMac" : false, "destinationMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableL2Protocol" : false, "l2ProtocolNum" : "0x0800", "adn" : false, "experienceLevel" : "", "applyType" : "FW", "sourceIps" : [ "10.1.1.2/32" ], "sourceIpSets" : [ "sourceIp" ], "sourceDomainSets" : [ "domainSet" ], "destIps" : [ "10.1.1.2/32" ], "destIpSets" : [ "destIp" ], "destDomainSets" : [ "domainSet" ], "protocols" : [ { "name" : "TCP", "protocolNum" : 6, "srcPort" : "0-65535", "dstPort" : "0-65535" } ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "app", "operator" : "and", "aclType" : "ipv4", "l3Acls" : [ { "priority" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePort" : 1, "sourcePortEnd" : 1, "destinationPort" : 1, "destinationPortEnd" : 1, "dscp" : 1, "protocolNum" : 1, "tcpFlag" : "ack,fin" } ], "applicationGroupIds" : [ "00000000-0000-0000-0000-000000000000" ], "enableVlanRange" : false, "vlanRange" : { "start" : 1, "end" : 4094 }, "enableP8021" : false, "p8021" : 1, "enableSourceMac" : false, "sourceMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableDestinationMac" : false, "destinationMac" : { "address" : "00:e0:fc:12:34:56", "mask" : "0xffff-ffff-0000" }, "enableL2Protocol" : false, "l2ProtocolNum" : "0x0800", "adn" : false, "experienceLevel" : "", "applyType" : "FW", "sourceIps" : [ "10.1.1.2/32" ], "sourceIpSets" : [ "sourceIp" ], "sourceDomainSets" : [ "domainSet" ], "destIps" : [ "10.1.1.2/32" ], "destIpSets" : [ "destIp" ], "destDomainSets" : [ "domainSet" ], "protocols" : [ { "name" : "TCP", "protocolNum" : 6, "srcPort" : "0-65535", "dstPort" : "0-65535" } ] } } ] } 返回状态码为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的示例 PUT /controller/campus/v1/sdwan/overlay-network/bridge-domains 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 { "bridgeDomains" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } ], "fullReplace" : false }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考BridgeDomainResponse。 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", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } } ] } 返回状态码为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:接口调用成功,响应体参考DeviceGroupTagResp。 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" : 20, "totalRecords" : 1, "data" : [ { "tagId" : "31f35021-e656-472a-8937-9c6d6da76e6e", "tagName" : "test" } ] } 返回状态码为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
  • URI /controller/campus/v1/performanceservice/endpointbehavior/tags 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID,UUID格式。 "9dffc44b-1824-42a4-ac48-616e3f0eaa2a" pageSize 是 integer [1-1000] 20 分页的大小。 20 pageIndex 是 integer [1-2147483647] 1 分页的序号。 1
  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/endpointbehavior/tags?siteId=9dffc44b-1824-42a4-ac48-616e3f0eaa2a&pageSize=20&pageIndex=1 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:接口调用成功,响应体参考DeviceGroupTagResp。 表2 DeviceGroupTagResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码信息。 "0" errmsg string 0~256个字符。 - 结果信息。 "" pageIndex integer [0-2147483647] - 分页的序号。 1 pageSize integer [0-1000] - 分页的大小。 20 totalRecords integer [0-2147483647] - 本次查询的设备标签总数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表3。 查询到的设备标签信息。 - 表3 DeviceGroupTag对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 tagId string 0~64个字符。 - 标签ID。 "31f35021-e656-472a-8937-9c6d6da76e6e" tagName string 0~32个字符。 - 标签名。 "test" 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为201:创建认证模板成功,响应体参考LswAuthConfigResponse。 HTTPS 201 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "data":[ { "id":"18e4c8f942254308ac4b9733297d4083", "name":null, "ssidName":null, "authMode":null, "escapeStrategy":null, "escapeStrategyId":null, "escapePolicyName":null, "apFreeAuthEnable":null, "forceDomainEnable": true, "preAuthPrivilege":null, "authFailPrivilege":null, "voiceDeviceNoAuth":null, "hasPermission":null, "portalConfigDto":null, "radiusConfigDto":null } ] } 返回状态码为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/api/v1/lswauth/wired/20ab206c-5f5f-4cb6-9090-05cda5e9727b HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "name":"test12132", "authMode":1, "escapeStrategy":0, "apFreeAuthEnable":false, "forceDomainEnable": true, "preAuthPrivilege":{ "preAuthPrivilegeEnable":false, "vlan":"" }, "authFailPrivilege":{ "authFailPrivilegeEnable":false, "vlan":"" }, "voiceDeviceNoAuth":{ "voiceDeviceNoAuthEnable":false }, "portalConfigDto":{ "pagePushMode":0, "freeAuthEnable":false, "internalPortalConfigDto":{ "portalProtocol":1, "pushMethod":0, "ipv6Enable":false, "accountingPeriod":null, "masterPortalTemplateId":"1a638aed-d4b3-44ed-aaf1-f69dd9c4cfa8", "masterPortalTemplateName":"fff", "slavePortalServerEnable":false, "authorRedirectUrlParamEnable":false, "pushPageId":"9012b661-1750-4338-b84d-8ecf672bb790", "normalAccessConfigDto":{ "registerEnable":false, "userExpiredTime":null } } }, "radiusConfigDto":{ "radiusTemplateId":"ba07ac68-ba8e-4aa8-b0d6-041813827802", "radiusTemplateName":"iae" } }
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ssl-policy:ssl-policies/{policy-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" policy-name 是 string 1~23个字符。满足正则表达[a-z0-9_]*。 - ssl-policies名称配置,范围为1-23位小写字符,数字,下划线 "test1"
  • 请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ssl-policy:ssl-policies/test1 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:操作成功。 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的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:route-policy/policy1/nodes HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-route-policy:nodes" : { "sequence" : 1, "match-mode" : "permit", "condition" : { "match-tag" : 1, "match-ipv4-type" : "ipv4-prefix", "match-ipv4-prefix" : "prefix1", "match-ipv6-type" : "ipv6-prefix", "match-ipv6-prefix" : "prefix1", "community-filter" : [ { "community-filter-name" : "communityFilterName1" } ], "ext-community-filter" : [ { "ext-community-filter-name" : "extCommunityFilterName1" } ] }, "action" : { "apply-tag" : 10, "apply-cost" : 10, "apply-local-preference" : 10, "apply-ext-community-color" : "100", "apply-community" : { "operation" : "replace", "set-community-type" : "inline", "communities" : [ "1:1" ] }, "apply-ext-community" : { "operation" : "replace", "ext-community-member" : [ { "value" : "1:1" } ] } } } }
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:route-policy/{name}/nodes 表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~200个字符。 - 名称,单一主键字段。 "policy1"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nodes 是 REFERENCE 详细请参见表4。 节点。 - 表4 nes-ne-route-policy-exactProperties-nodes-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:nodes 否 REFERENCE 详细请参见表5。 节点。 - 表5 nodes-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sequence 是 int64 [0-65535] - 序号,单一主键字段。 1 match-mode 否 string permit deny - 匹配类型。 "permit" condition 否 REFERENCE 详细请参见表7。 条件。 - action 否 REFERENCE 详细请参见表10。 应用。 -
  • 响应示例 返回状态码为200:查询成功,响应体参考LinkDetailResponse。 HTTP/1.1 200 OK Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : [ { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "linkName" : "link", "metricDatas" : [ { "name" : "***", "value" : [ { "timestamp" : "1985-04-12T23:20:50.52Z", "value" : 50 } ] } ] } ] } 返回状态码为400:校验异常 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部服务器错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/performance/intersite/link/list?sourceSiteId=fbb684c8-0d37-496f-bafa-4b06d515j7l6&destSiteId=fbb684c8-0d37-496f-bafa-4b06d515j7l6&metric=packetloss&startTime=1985-04-12T23:20:50.052Z&endTime=1985-04-12T23:20:50.052Z HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • URI /controller/campus/v1/sdwan/performance/intersite/link/list 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sourceSiteId 是 string 0~36个字符。 - 源站点标识,UUID格式,可由网络侧提供接口获取。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" destSiteId 是 string 0~36个字符。 - 目的站点标识,UUID格式,可由网络侧提供接口获取。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" metric 是 string - - 查询指标,该字段可以设置为以下几种: a) netstream:流量,单位是字节(Byte)。 b) packetloss:丢包,单位是百分比(%)。 c) jitter:抖动,单位是毫秒(ms)。 d) delay:时延,单位是毫秒(ms)。 如果查询多个指标用逗号分隔(如:netstream,delay)。 "packetloss" startTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的开始时间,UTC时间,直接调用URL,特殊符号参数需要手动转义,如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z" endTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的结束时间,UTC时间,直接调用URL,特殊符号参数需要手动转义,如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z"
  • 接口约束 1、该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用; 2、返回数据类型与用户查询时间范围以及查询开始时间有关: *查询开始时间小于等于7天,且查询时间范围小于等于24H时,返回原始分钟级数据,时间范围大于24H时,返回小时级别数据; *查询开始时间大于7天,小于等于60天,且查询时间范围小于等于7天时,返回小时级别数据,时间范围大于7天时,返回天级别数据; *查询开始时间大于60天时,返回天级别数据; *查询流量指标(netstream)时,后台只返回netstream_upward流量数据。
  • 响应示例 返回状态码为200:修改成功,响应体参考LocalAccessPolicyResponse。 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" : "000000-0000-0000-0000-000000000000", "vpnId" : "000000-0000-0000-0000-000000000000", "vpnName" : "VPN1", "siteId" : "000000-0000-0000-0000-000000000000", "siteName" : "site1", "trackIP" : "10.12.13.14", "enableVas" : true, "classificationProfiles" : [ "000000-0000-0000-0000-000000000000" ], "enableLocalFirst" : true, "masterSiteSource" : "tenant", "masterSiteId" : "000000-0000-0000-0000-000000000000", "masterSiteName" : "site1", "backupSiteSource" : "tenant", "backupSiteId" : "000000-0000-0000-0000-000000000000", "backupSiteName" : "site1", "internetAccessType" : "localAccess", "transportNetworkConfigs" : [ { "transportNetworkPortId" : "000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "internet1", "transportNetworkPortVpnName" : "underlay_1", "enableNat" : true, "enableIpv6" : true, "priority" : "1", "bandwidth" : 10, "trackIP" : "10.12.13.14", "dhcpTrackIP" : "10.12.13.14", "mtu" : 9000, "downlinkBandwidth" : 1000, "uplinkBandwidth" : 1000, "downlinkQos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "rulePriority" : 1, "ruleClassificationId" : "00000000-0000-0000-0000-000000000000", "ruleClassificationName" : "qosClassificationName", "ruleProfileId" : "00000000-0000-0000-0000-000000000000", "ruleProfileName" : "templateName" } ], "uplinkQos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "rulePriority" : 1, "ruleClassificationId" : "00000000-0000-0000-0000-000000000000", "ruleClassificationName" : "qosClassificationName", "ruleProfileId" : "00000000-0000-0000-0000-000000000000", "ruleProfileName" : "templateName" } ] } ], "ipsecTunnelConfigs" : [ { "trackIP" : "10.12.13.14", "wanLinkName" : "AR 104", "deviceName" : "AR 104", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : "1", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "bandwidth" : 10 } ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "000000-0000-0000-0000-000000000000", "vpnId" : "000000-0000-0000-0000-000000000000", "vpnName" : "VPN1", "siteId" : "000000-0000-0000-0000-000000000000", "siteName" : "site1", "trackIP" : "10.12.13.14", "enableVas" : true, "classificationProfiles" : [ "000000-0000-0000-0000-000000000000" ], "enableLocalFirst" : true, "masterSiteSource" : "tenant", "masterSiteId" : "000000-0000-0000-0000-000000000000", "masterSiteName" : "site1", "backupSiteSource" : "tenant", "backupSiteId" : "000000-0000-0000-0000-000000000000", "backupSiteName" : "site1", "internetAccessType" : "localAccess", "transportNetworkConfigs" : [ { "transportNetworkPortId" : "000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "internet1", "transportNetworkPortVpnName" : "underlay_1", "enableNat" : true, "enableIpv6" : true, "priority" : "1", "bandwidth" : 10, "trackIP" : "10.12.13.14", "dhcpTrackIP" : "10.12.13.14", "mtu" : 9000, "downlinkBandwidth" : 1000, "uplinkBandwidth" : 1000, "downlinkQos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "rulePriority" : 1, "ruleClassificationId" : "00000000-0000-0000-0000-000000000000", "ruleClassificationName" : "qosClassificationName", "ruleProfileId" : "00000000-0000-0000-0000-000000000000", "ruleProfileName" : "templateName" } ], "uplinkQos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "rulePriority" : 1, "ruleClassificationId" : "00000000-0000-0000-0000-000000000000", "ruleClassificationName" : "qosClassificationName", "ruleProfileId" : "00000000-0000-0000-0000-000000000000", "ruleProfileName" : "templateName" } ] } ], "ipsecTunnelConfigs" : [ { "trackIP" : "10.12.13.14", "wanLinkName" : "AR 104", "deviceName" : "AR 104", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : "1", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "bandwidth" : 10 } ] } } ], "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalAccessPolicyResponse。 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的示例 PUT /controller/campus/v1/sdwan/policy/traffic/local-access 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 { "localAccessPolicies" : [ { "id" : "000000-0000-0000-0000-000000000000", "vpnId" : "000000-0000-0000-0000-000000000000", "vpnName" : "VPN1", "siteId" : "000000-0000-0000-0000-000000000000", "siteName" : "site1", "trackIP" : "10.12.13.14", "enableVas" : true, "classificationProfiles" : [ "000000-0000-0000-0000-000000000000" ], "enableLocalFirst" : true, "masterSiteSource" : "tenant", "masterSiteId" : "000000-0000-0000-0000-000000000000", "masterSiteName" : "site1", "backupSiteSource" : "tenant", "backupSiteId" : "000000-0000-0000-0000-000000000000", "backupSiteName" : "site1", "internetAccessType" : "localAccess", "transportNetworkConfigs" : [ { "transportNetworkPortId" : "000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "internet1", "transportNetworkPortVpnName" : "underlay_1", "enableNat" : true, "enableIpv6" : true, "priority" : "1", "bandwidth" : 10, "trackIP" : "10.12.13.14", "dhcpTrackIP" : "10.12.13.14", "mtu" : 9000, "downlinkBandwidth" : 1000, "uplinkBandwidth" : 1000, "downlinkQos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "rulePriority" : 1, "ruleClassificationId" : "00000000-0000-0000-0000-000000000000", "ruleClassificationName" : "qosClassificationName", "ruleProfileId" : "00000000-0000-0000-0000-000000000000", "ruleProfileName" : "templateName" } ], "uplinkQos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "rulePriority" : 1, "ruleClassificationId" : "00000000-0000-0000-0000-000000000000", "ruleClassificationName" : "qosClassificationName", "ruleProfileId" : "00000000-0000-0000-0000-000000000000", "ruleProfileName" : "templateName" } ] } ], "ipsecTunnelConfigs" : [ { "trackIP" : "10.12.13.14", "wanLinkName" : "AR 104", "deviceName" : "AR 104", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : "1", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "bandwidth" : 10 } ] } ] }
  • 响应参数 返回状态码为200:修改成功,响应体参考LocalAccessPolicyResponse。 LocalAccessPolicyResponse对象的参数列表,详细请参见表7。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalAccessPolicyResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为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" : [ { "deviceId" : "d623ead6-a2cc-4c3c-9039-dcc8fa898a60", "esn" : "AA50082935AAAC003037", "configStates" : [ { "featureIdentify" : "initloginuser", "state" : 0, "featureItems" : [ { "id" : "7b4b8bedffdc416ab97c406fdbdc4cb4", "name" : "accampus", "messageId" : "DEVICECONFIG_74f70f6630874f87a8598cf44ae906ca", "operation" : "0", "state" : "3", "errorMessage" : "internal error", "updateTime" : "2019-05-30 15:12:50" } ] } ] } ] }
  • 请求示例 HTTP的示例 POST /controller/campus/v1/networkconfigservice/configresult 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 { "pageIndex" : "1", "pageSize" : "20", "siteIds" : ["770545b0-e306-4c9a-9b7d-d76fc5f60182"], "deviceIds" : ["d623ead6-a2cc-4c3c-9039-dcc8fa898a60"] }
  • 响应参数 返回状态码为200:查询设备配置结果成功。 表3 StateResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 详细请参见表4。 配置结果信息。 - 表4 ConfigStateResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string - - 设备ID。 "d623ead6-a2cc-4c3c-9039-dcc8fa898a60" esn string - - 设备ESN。 "AA50082935AAAC003037" configStates ARRAY_REFERENCE 详细请参见表5。 设备的各个特性配置结果。 - 表5 FeatureStateDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 featureIdentify string - - 特性类型。 "initloginuser" state int32 - - 配置下发状态,取值范围:0---成功;1---告警;2---预配置;3---失败;4---正在下发。 0 featureItems ARRAY_REFERENCE 详细请参见表6。 设备对应特性的配置结果。 - 表6 FeatureItemStateDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 单个特性ID。 "7b4b8bedffdc416ab97c406fdbdc4cb4" name string - - 单个特性名称。 "accampus" messageId string - - 下发单个特性的报文ID。 "DEVICECONFIG_74f70f6630874f87a8598cf44ae906ca" operation int32 - - 单个特性对应的操作类型,取值范围:0---新增(Add);1---删除(Delete);2---修改(Update)。 "0" state int32 - - 单个特性的配置下发状态,取值范围:0---成功;1---告警;2---预配置;3---失败;4---正在下发。 "3" errorMessage string - - 错误信息。 "internal error" updateTime string - - 更新时间。 "2019-05-30 15:12:50"
  • 响应示例 返回状态码为200:查询组织成功,响应体参考GetOrgOut。 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" : "", "orgId" : "b473118d-17ff-4f4f-9fa9-a4c0e1e87e42", "path" : "/org1/org2", "level" : "2" }
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/organization/id?id=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
  • 请求参数 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表4。 Radius探测配置参数体,结构体参见RadiusDetectDto。 - 表4 RadiusDetectDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deadInterval 是 int32 [1-300] - RADIUS服务器的探测周期。 5 deadCount 是 int32 [1-65535] - 每个探测周期RADIUS服务器连续无响应的最大次数。 2 deadDetect 否 string 0~24个字符。满足正则表达by-server-ip|by-authentication-server。 - 配置进行存活检测的服务器,by-server-ip代表对RADIUS认证服务器和计费服务器同时进行存活检测,by-authentication-server代表仅对RADIUS认证服务器进行存活检测 "by-server-ip" detectCycle 否 int32 [1-5] 2 探测周期循环次数。 2
共100000条