华为云用户手册

  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/bandwidth-management-policies/action/batch-delete HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy { "bandwidthMgrPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ] }
  • 响应示例 返回状态码为200:删除成功,响应体参考BandwidthMgrPolicyResponse。 HTTP/1.1 200 OK Date: Sun,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" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "bandwidth1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "bandwidthMgrRule" : { "priority" : 1, "classificationId" : "00000000-0000-0000-0000-000000000000", "classificationName" : "classificationName", "profileId" : "00000000-0000-0000-0000-000000000000", "profileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName" }, "status" : 1 } } ] } 返回状态码为204:执行成功,没有数据。 HTTP/1.1 204 No Content Date: Sun,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:查询成功返回。 表2 QueryRouteBgpResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表18。 查询返回的Bgp信息,兼容老版本,不推荐使用。 - bgpPeers ARRAY_REFERENCE 0-32个列表项,详细请参见表3。 查询返回的BGP对等体信息。 - 表3 RouteLinkAllBgpInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkId string 36个字符。 - 互联接口标识。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" linkName string 0~64个字符。 - 互联接口名称, 创建、更新不填,查询返回。 "ConnectLink" deviceId string 36个字符。 - 设备标识。创建、更新不填。查询返回。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceName string 0~64个字符。 - 设备名称,创建、更新不填,查询返回。 "Core-1" deviceType string 0~10个字符。 - 设备类型,创建、更新不填,查询返回。 "LSW" configSource string 0~32个字符。 - 配置源 "LANWAN" bgpPeer REFERENCE 详细请参见表32。 BGP对等体配置参数 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功返回。 HTTP/1.1 200 OK Date: Sun,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-4b06d5151e2e", "peerInfo" : { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 } }, "coreBgpAdvancedInfo" : { "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false }, "gatewayBgpAdvancedInfo" : { "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false }, "coreBgpPeers" : [ { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } ], "gatewayBgpPeers" : [ { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } ] }, "bgpPeers" : [ { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "configSource" : "LANWAN", "bgpPeer" : { "coreAs" : 65002, "corePeerIp" : "192.168.10.1", "gatewayAs" : 100, "gatewayPeerIp" : "192.168.10.1", "keepaliveTime" : 60, "holdTime" : 180, "authMode" : "KEYCHAIN", "md5Pwd" : "Abc123", "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInformation" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "deviceId" : "b473136d-17ff-4f4f-9fa9-a4c0e1e87e42", "familyGlobalInfo" : { "externalPreferences" : 30, "defaultRouteRedistribution" : false, "routeRedistribute" : ["Static","Direct"], "aggregationRoute" : ["192.168.10.0/24"], "compareDifAsMed" : false, "maxLoadBalanceNum" : 1 }, "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "192.168.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "communityFilters" : [ { "name" : "teamName", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : ["1","2"] } ], "wholeMatch" : true } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ 100 ], "communityNumberList" : [ "100" ] }, "applyAsPath" : { "asNumbers" : [ 100 ] }, "applyMetric" : { "cost" : 60 }, "preferredValue" : 100, "localPreference" : 100, "nodeIndex" : 20060 } } ], "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "advertiseCommunity" : false } } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,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/lanwan/interconnection/route/bgp?linkId=fbb684c8-0d37-496f-bafa-4b06d5151e2e HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:查询成功,响应体参考SitesInTerminalPrivacy。 表3 SitesInTerminalPrivacy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string - - 错误信息。当没有错误时返回""。 "" pageIndex int32 - - 页码。 1 pageSize int32 - - 页长。 20 total int32 - - 站点总数。 100 sites ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 站点列表。 - 表4 SiteInTerminalPrivacy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 站点ID。 "4b573916-11f3-4dd6-ba5b-ebf04c74dae8" name string - - 站点名称。 "site1" siteType string - - 站点类型。 "AP" 返回状态码为400:查询失败,参数校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:查询失败,服务内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考SitesInTerminalPrivacy。 HTTP/1.1 200 OK Date: Sun,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, "total" : 100, "sites" : [ { "id" : "4b573916-11f3-4dd6-ba5b-ebf04c74dae8", "name" : "site1", "siteType" : "AP" } ] } 返回状态码为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/api/v1/terminal-privacy/b9b34988-0dff-4def-9e55-7bc0b3dc21b4/site?pageIndex=1&pageSize=10 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • URI /controller/campus/api/v1/terminal-privacy/{privacyId}/site 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 privacyId 是 string - - 终端隐私设置策略ID,UUID格式。 "b9b34988-0dff-4def-9e55-7bc0b3dc21b4" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 - 1 页码,该字段的取值范围是:1-2147483647。 1 pageSize 否 int32 [10-100] 10 页长,该字段的取值范围是:10-100。 10
  • 响应示例 返回状态码为200:查询成功,返回结构体参见DomainNameResponseDto。 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" : { "domainName" : "www.example.com" } }
  • URI /controller/campus/v1/networkservice/networkconfig/net/domainname/sites/{siteId}/domainnames 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/domainname/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/domainnames 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:查询成功,返回结构体参见DomainNameResponseDto。 表2 DomainNameResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 DomainNameDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 domainName string 1~255个字符。满足正则表达[a-zA-Z0-9_\-\.]*$。 - 设备 域名 。 "www.example.com"
  • 响应参数 返回状态码为201:获取成功返回的URL信息,响应体参考UrlResponse。 表3 UrlResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-200个列表项,详细请参见表4。 成功的URL列表。 - fail ARRAY_REFERENCE 0-200个列表项,详细请参见表5。 失败的URL列表。 - 表4 UrlInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 url string - - 包含WAN链接配置、设备类型信息的URL信息。 "https://192.168.1.1/portal?url_lang=en?h5lpcXAKCViV+xh1QPmDNQ==?qcioxn0dnot224jq48Q5gk0txAX7rI7c60CKL6TaxIRH0H855kKzSy5cCQwDwasyWGFjRBHD8BKRQtIh20p2GhCc2LdYFSGrUJO/CC4NGwnQfFnJGT7OKE81Ot3R9K1uRWhLUPPaxpZXhEOjL4/OiS0/z4Mh3WdxBLvLrmVZ0V0p4At9ED/ekkYUu2xOkv7cSLwLda9P9i/gU5dF8SuP8/QI0vDax+pr7abPiFaPeyrxPivNJfhJfKqfcqmJoEDLjzk3dBvOE4AusIjsm8mMGarSZG49JJQP0w2f5+S6yDE/o9Idpp7UirQjtSQlxtrbY0xBdY4mkIdWVl203LKXVhs94uP52uDACkdDIVfecDi3xVOTnoxfMwdJXg/O01niLDV41zRk9Us+brDPecAazOf4vyHXYePjNoQJYVR8EBOG4wTDqcBw6IXmNDTjxbPQCaxSrEwxNh9QYKI4gWcIcOmsodWK+D16RUnL3KvhorHaDybIjKFhPwQFvEUxrjkZmMM7WYikU+O9qNbYXjeVAw==" siteId uuid - - 站点ID,uuid格式。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "Site1" deviceId uuid - - 设备ID,uuid格式。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "Device1" 表5 FailDataInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" siteId uuid - - 站点ID,uuid格式。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "Site1" deviceId uuid - - 设备ID,uuid格式。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "Device1" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/sites/provision/urls 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 { "siteIds" : ["00000000-0000-0000-0000-000000000000"], "encryptionKey" : "123456abc", "validityPeriod" : 7, "certificateEnable" : true, "certificateVerifyType" : "verifyType", "certificateVerifyCode" : "10.1.1.1", "enableWeakAlgorithm" : false }
  • 响应示例 返回状态码为201:获取成功返回的URL信息,响应体参考UrlResponse。 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" : "", "success" : [ { "url" : "https://192.168.1.1/portal?url_lang=en?h5lpcXAKCViV+xh1QPmDNQ==?qcioxn0dnot224jq48Q5gk0txAX7rI7c60CKL6TaxIRH0H855kKzSy5cCQwDwasyWGFjRBHD8BKRQtIh20p2GhCc2LdYFSGrUJO/CC4NGwnQfFnJGT7OKE81Ot3R9K1uRWhLUPPaxpZXhEOjL4/OiS0/z4Mh3WdxBLvLrmVZ0V0p4At9ED/ekkYUu2xOkv7cSLwLda9P9i/gU5dF8SuP8/QI0vDax+pr7abPiFaPeyrxPivNJfhJfKqfcqmJoEDLjzk3dBvOE4AusIjsm8mMGarSZG49JJQP0w2f5+S6yDE/o9Idpp7UirQjtSQlxtrbY0xBdY4mkIdWVl203LKXVhs94uP52uDACkdDIVfecDi3xVOTnoxfMwdJXg/O01niLDV41zRk9Us+brDPecAazOf4vyHXYePjNoQJYVR8EBOG4wTDqcBw6IXmNDTjxbPQCaxSrEwxNh9QYKI4gWcIcOmsodWK+D16RUnL3KvhorHaDybIjKFhPwQFvEUxrjkZmMM7WYikU+O9qNbYXjeVAw==", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "Device1" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "Device1" } ] } 返回状态码为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
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dhcpv4:dhcpv4-if 是 REFERENCE 详细请参见表4。 DHCPv4接口GND模型。 -
  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-if/GE0%2F0%2F2 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-dhcpv4:dhcpv4-if" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "if-name" : "GE0/0/2", "dhcp-type" : "server", "encapsulation" : { "suboption" : "circuit-id remote-id subscriber-id vendor-specific-id" }, "option82-formats" : { "option82-format" : [ { "sub-option-type" : "remote-id", "option82-format" : "user-defined", "user-define-text" : "definedtext" } ] }, "option82-insert-setting" : { "insert" : "", "rebuild" : "" }, "dhcp-relay" : { "enable" : true, "information" : true, "information-strategy" : "drop", "option82" : { "link-selection-enable" : false, "link-selection-address" : "10.1.1.4" }, "relay-source-address" : { "source-address" : "10.1.1.1" }, "server-addresses" : [ { "server-address" : "10.1.1.1" } ], "gateway-addresses" : [ { "gateway-address" : "10.1.1.1" } ] }, "dhcp-server" : { "gateway-list" : [ { "gateway-ip" : "10.1.1.1", "mask" : 16 } ], "dns-list" : [ { "dns-ip" : "10.1.1.1" } ], "excluded-ip-address" : [ { "start-ip-address" : "10.1.1.1", "end-ip-address" : "10.1.1.1" } ], "static-bind" : [ { "static-bind-ip" : "10.1.1.1", "static-bind-mac" : "xxxx-xxxx-xxxx" } ], "option" : [ { "option-code" : 56, "ip-addresses" : [ "10.1.1.1" ], "ascii-string" : "wevweq", "hex-string" : "4", "cipher-string" : "********", "sub-options" : { "sub-option" : [ { "sub-option-code" : 233, "ip-addresses" : [ "10.1.1.1" ], "ascii-string" : "asciistring" } ] } } ], "ip-range" : { "start-ip-address" : "10.1.1.1", "end-ip-address" : "10.1.1.1" }, "server-enable" : false, "domain-name" : "domainname", "masklen" : 24 } } ] }
  • 响应示例 返回状态码为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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:dhcpv4-if/{if-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" if-name 是 string 1~63个字符。 - interface name "GE0/0/2"
  • 请求示例 HTTP的示例 PUT /v1/networkconfig/wlan/ap/vlanpools/bind 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" : "00000000-0000-0000-0000-0000000", "templateIds" : ["00000000-0000-0000-0000-0000000"] }
  • 响应示例 返回状态码为200:站点绑定AP VLAN POOL成功,响应体参考ApVlanPoolResponse。 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" : "", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "data" : [ { "id" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "VLANPOOLTemplate1", "range" : "3001", "type" : "even" } ] } 返回状态码为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:站点绑定AP VLAN POOL成功,响应体参考ApVlanPoolResponse。 表3 ApVlanPoolResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~32个字符。 0 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" siteId string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" data ARRAY_REFERENCE 0-100个列表项,详细请参见表3。 创建、更新或者删除成功的IP Subnet信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为201:创建成功,响应体参考DeviceAuthenResponse。 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" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationSchema" : "name", "authenticationModel" : { "primaryModel" : "hwtacacs", "backupModel" : "local" }, "deviceAuthenId" : "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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/aaa/authentication 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" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationSchema" : "name", "authenticationModel" : { "primaryModel" : "hwtacacs", "backupModel" : "local" } }
  • 响应参数 返回状态码为201:创建成功,响应体参考DeviceAuthenResponse。 表4 DeviceAuthenResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 - - 表5 DeviceAuthen对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" authenticationSchema string 1~32个字符。 - 认证方案名称,创建后不允许修改。 "name" authenticationModel REFERENCE 详细请参见表6。 - - deviceAuthenId uuid - - 认证方案ID。 "00000000-0000-0000-0000-000000000000" 表6 AuthenticationModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 primaryModel string hwtacacs radius local none local 1:设备主认证方案; 2:主备认证方案都为空时,主认证方案默认值为local; 3:当主认证方案为none或空时,不支持备认证方案; 4:当备认证方案不为空时,主方案必须设置为hwtacacs或local; 5:主备认证方案不能配置相同的值; 6:新增和修改都是以上规则。 "hwtacacs" backupModel string hwtacacs radius local - 设备备认证方案。 "local" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 authenticationList 是 REFERENCE 详细请参见表2。 设备认证方案信息。 - 表2 DeviceAuthenInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" authenticationSchema 是 string 1~32个字符。 - 认证方案名称,创建后不允许修改。 "name" authenticationModel 否 REFERENCE 详细请参见表3。 - - 表3 AuthenticationModel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 primaryModel 否 string hwtacacs radius local none local 1:设备主认证方案; 2:主备认证方案都为空时,主认证方案默认值为local; 3:当主认证方案为none或空时,不支持备认证方案; 4:当备认证方案不为空时,主方案必须设置为hwtacacs或local; 5:主备认证方案不能配置相同的值; 6:新增和修改都是以上规则。 "hwtacacs" backupModel 否 string hwtacacs radius local - 设备备认证方案。 "local"
  • 请求示例 HTTP的示例 PUT /controller/campus/api/v1/organization/id 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 { "names" : [ { "org" : "/org1/org2", "name" : "org22" } ] }
  • 响应示例 返回状态码为200:批量修改组织成功,响应体参考BatchOperOrgOut。 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" : "", "successList" : ["/org1/org2","/org11/org22"], "failList" : [ { "org" : "/org1/org2", "errcode" : "0", "errmsg" : "" } ] }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考NetworkOrchestrationResourcesResponse。 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" : { "vpnType" : "bgp-evpn", "networkOrchestrationResources" : { "bgpAsNum" : 65001, "communityPool" : [1,2], "interlinkProtocolType" : "ospf", "communityPoolStatus" : 1, "siteScale" : "1000+", "dsvpnIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "evpnIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "innerTunnelIPpool" : ["10.1.0.0/16","10.2.0.0/16"], "interConnectIPpool" : "192.168.1.0/26", "evpnIpv6Pool" : ["2100::/96","2200::/96"], "innerTunnelIpv6Pool" : ["fd00::/96","fd10::/96"], "interConnectIpv6Pool" : "fd01::/96", "linkLocalIPV6pool" : "fe80::/96", "enableDelayTime" : false, "delayTime" : 50, "unsecurePktDiscardEnable" : false, "enableBgpKeepaliveTime" : false, "bgpKeepaliveTime" : 720, "transportNetworks" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "mpls1", "routingDomain" : "mpls", "description" : "a mpls link", "priority" : 1 } ], "routingDomain" : [ { "name" : "mpls1", "ipsecEncryption" : true, "isMspRD" : true } ], "ipsecEncryptionParameter" : { "authenticationAlgorithm" : "SHA2_256", "encrptionAlgorithm" : "AES128", "lifeTime" : 1440, "preSharedKey" : "", "dhGroup" : "group19", "antiReplayEnable" : false, "antiReplayWindow" : 1024 }, "defaultMngInterfaceConfig" : { "cleanDefaultMngInterfaceConfig" : false }, "linkQualityDetectionParameter" : { "enable" : true, "interval" : 100, "retryTimes" : 6, "priority" : 5 }, "trafficSteeringPolicyPeriodConfig" : { "enable" : true, "switchingPeriod" : 100, "statisticsPeriod" : 100, "flappingSuppression" : 100, "enableFlappingSuppressionEnhanced" : false, "symmetricForward" : true, "bandwidthUtilizationEnable" : true, "maxBandwidthUtilization" : 95, "sameTnFirst" : false, "siteIdSmallerFirst" : false, "basedRulesVo" : { "tnpPriorityEnable" : true, "basedTnpPriorityVo" : { "mode" : "larger", "priority" : 1 }, "tnpRoleEnable" : true, "basedRoleVo" : { "mode" : "hub", "priority" : 2 }, "tnpBandwidthEnable" : true, "basedBandwidthVo" : { "mode" : "smaller", "priority" : 3 } } }, "provisionUrlParameter" : { "encryptUrlEnable" : false, "encryptSensitiveParameters" : false, "oldDevceiVersionEnable" : false, "encryptionKey" : "12345abc", "validityPeriod" : 7, "urlWebInfoEnable" : false, "urlWebInfo" : { "webUser" : "abcd1234", "webPassword" : "Example@123" } }, "portConfiguration" : { "cusPortConfigEnable" : true, "dtlsServerPort" : 55100, "stunServerPort" : 3478, "connectionDefaultPort" : { "connectPortEnable" : true, "srcPort" : 4501, "portNum" : 0, "portStep" : 10 } }, "dataPackageFormat" : { "extFormatSign" : false, "extUdpHeaderSign" : false, "srcPort" : 4755, "destPort" : 4755 }, "linkDetectIntervalConfig" : { "enable" : false, "interval" : "" } } } } 返回状态码为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
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全