华为云用户手册

  • URI /controller/campus/v1/networkservice/networkconfig/net/globalparam/tenant/{tenantId}/cliauth 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tenantId 是 string - - 租户ID。 "1d27faea37f3410992e98c9761b25b9d"
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryDeviceVTYResponse。 表2 QueryDeviceVTYResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2000个列表项,详细请参见表4。 - - pageIndex int32 [1-10000] - 当前页。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400:请求参数错误,响应体参考CommonResponse。 CommonResponse对象的参数列表,详细请参见表5。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/vty/global?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=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-AC CES S-TOKEN: x-yyyyyy
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryDeviceVTYResponse。 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 { "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationModel" : "aaa", "idleTimeOutMinutes" : "", "idleTimeOutSeconds" : "", "inboundACLNum" : 2100, "outboundACLNum" : 2100, "inboundACL6Num" : 2100, "outboundACL6Num" : 2100 } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100 } 返回状态码为400:请求参数错误,响应体参考CommonResponse。 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
  • URI /controller/campus/v1/sdwan/vty/global 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-10000] 1 起始页。默认值为1。 1 pageSize 否 int32 [1-100] 10 页行记录数。默认值为10。 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备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的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ifm:interface/10GE0%2F0%2F0 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"
  • 接口约束 该接口支持msp视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V和AR6700V子设备; 或者支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V-L款型和V600系列设备。 该API可能会直接或间接影响现网业务运行,导致业务中断、关键数据丢失等,请谨慎操作!
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ifm:interface/{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个字符。 - 接口名称。名称规则:接口类别为主接口时,由物理类型、接口号拼接而成,如GE0/0/0、LoopBack1,接口类别为子接口时,由父接口名称、英文点、接口号拼接而成,如GE0/0/0.1、LoopBack1.1,单一主键字段。 "10GE0/0/0"
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/routing-protocol/bgp-public-info 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", "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 } ], "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } ] }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考BgpRoutePublicPeerResponse。 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", "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 } ], "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "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 } ], "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } } ] } 返回状态码为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: 表3 DeleteResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~128个字符。 - 错误码 "0" errmsg string 1~512个字符。 - 错误信息 - data ARRAY_REFERENCE 详细请参见表4。 删除成功列表。 - 表4 DeleteResultInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 32~36个字符。 - 删除ID。 "60e2e8a3cdf3470ea4d4f468c8b74095"
  • 响应示例 返回状态码为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" : "60e2e8a3cdf3470ea4d4f468c8b74095" } ] }
  • 请求示例 HTTP的示例 DELETE /controller/campus/api/v1/networkconfig/lswospf/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:接口调用成功,响应体参考SiteHealthOutputDto。 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" : [ { "siteId" : "5cd2d350-b530-4469-8df6-4e5b6c70ff6d", "deviceHealth" : 100, "radioHealth" : 100, "siteHealth" : 100, "linkHealth" : 100 } ] } 返回状态码为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
  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/siteshealth/5cd2d350-b530-4469-8df6-4e5b6c70ff6d 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:接口调用成功,响应体参考SiteHealthOutputDto。 表2 SiteHealthOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-1个列表项,详细请参见表3。 查询到的站点健康度输出。 - 表3 SiteHealthOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 0~256个字符。 - 站点ID。 "5cd2d350-b530-4469-8df6-4e5b6c70ff6d" deviceHealth int32 [0-100] - 设备健康度。 100 radioHealth int32 [0-100] - 射频健康度。 100 siteHealth int32 [0-100] - 站点健康度。 100 linkHealth int32 [0-100] - 链路健康度。 100 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为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-syslog:global-parameter" : { "interface-name" : "1", "buffer-size" : 1, "log-timestamp" : "date-boot", "log-timezone" : true, "debug-timestamp" : "date-boot", "debug-timezone" : true, "trap-timestamp" : "date-boot", "trap-timezone" : true, "statistic-suppress" : true } } 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-syslog:syslog-config/global-parameter 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"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-syslog:syslog-config/global-parameter 表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"
  • 响应参数 返回状态码为200:操作成功。 表3 global-parameter-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-syslog:global-parameter REFERENCE 详细请参见表5。 全局配置 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考HealingResetConfigResult。 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" : { "healingResetEnable" : true, "period" : 6 } } 返回状态码为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
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/devoam/config/aphealingreset/sites/4f350825-919c-47b7-b853-f51f15912396 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:查询成功,响应体参考HealingResetConfigResult。 表2 HealingResetConfigResult对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "查询失败" data REFERENCE 详细请参见表3。 接口返回的具体数据。 - 表3 HealingResetConfig对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 healingResetEnable boolean true false true AP设备逃生配置使能。默认值为true。 该字段对应UI页面上是:UI【设备逃生策略配置】 true period int32 [6-168] - 开始自动检测重启的时间,该字段的取值范围是6-168(单位:小时)。 当healingResetEnable字段是true时,必须设置该字段。 该字段对应UI页面上是:UI【断连超时时间(小时)】 6 返回状态码为400:校验异常,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为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" : { "stpMode" : 1, "mstpRegions" : [ { "regionId" : "fbb684c8-0d37-496f-bafa-4b06e5151e2e", "regionName" : "stp_region", "revisionLevel" : 0, "mstpRegionInstances" : [ { "instanceId" : 0, "mapVlan" : "1,3-10", "regionInstanceDevices" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : 15 } ] } ], "regionDeviceList" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "LSW" } ] } ], "rstpConfig" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : 15 } ] } }
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/lswstp/sites/fbb684c8-0d37-496f-bafa-4b06db151e2e/stp 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 { "stpMode" : 1, "mstpRegions" : [ { "regionId" : "fbb684c8-0d37-496f-bafa-4b06e5151e2e", "regionName" : "stp_region", "revisionLevel" : 0, "mstpRegionInstances" : [ { "instanceId" : 0, "mapVlan" : "1,3-10", "regionInstanceDevices" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : 15 } ] } ], "regionDeviceList" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "LSW" } ] } ], "rstpConfig" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : 15 } ] }
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 站点内交换机的STP配置参数体。 - 表3 StpDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 stpMode 是 integer [1-2] - STP模式。1表示MSTP,2表示RSTP。 1 mstpRegions 否 ARRAY_REFERENCE 1-8个列表项,详细请参见表4。 MST域集合。MSTP模式下需要配置。 - rstpConfig 否 ARRAY_REFERENCE 1-8个列表项,详细请参见表7。 RSTP优先级。RSTP模式下需要配置。 - 表4 MstpRegion对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 regionId 否 string - - 域ID,UUID格式。创建时自动生成。 "fbb684c8-0d37-496f-bafa-4b06e5151e2e" regionName 是 string 1~32个字符。 - 域名 。 "stp_region" revisionLevel 是 int64 [0-65535] - 修订级别。 0 mstpRegionInstances 是 ARRAY_REFERENCE 1-16个列表项,详细请参见表5。 生成树实例集合。 - regionDeviceList 否 ARRAY_REFERENCE 1-16个列表项,详细请参见表6。 设备ID实例集合。 - 表5 MstpRegionInstance对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 instanceId 是 integer [0-4094] - 生成树实例ID。 0 mapVlan 否 string 1~100个字符。 - 映射VLAN,instancdId不为0的生成树才生效。 "1,3-10" regionInstanceDevices 是 ARRAY_REFERENCE 1-100个列表项,详细请参见表7。 生成树实例下设备集合。 - 表6 RegionDeviceList对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID,字符串格式为UUID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceName 是 string - - 设备Name。 "LSW" 表7 RegionInstanceDevice对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID,字符串格式为UUID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" priority 否 integer [0-15] - 设备优先级。 15
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/security/firewall-policies HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "effectImmediate" : true, "firewallPolicies" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserDefaultAction" : "deny", "internetToUserFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "userToInternetDefaultAction" : "permit", "userToInternetFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "internetToUserSessionLogEnable" : false, "userToInternetSessionLogEnable" : false, "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] } } ] }
  • 响应示例 返回状态码为200:修改成功,响应体参考FirewallPolicyResponse。 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", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserDefaultAction" : "deny", "internetToUserFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "userToInternetDefaultAction" : "permit", "userToInternetFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "internetToUserSessionLogEnable" : false, "userToInternetSessionLogEnable" : false, "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] } } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserDefaultAction" : "deny", "internetToUserFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "userToInternetDefaultAction" : "permit", "userToInternetFwFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "targetPort" : 6, "description" : "app" } ], "internetToUserSessionLogEnable" : false, "userToInternetSessionLogEnable" : false, "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] } } } ] } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,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
  • 开通云管理网络服务 已注册华为乾坤租户账号,账号可以是自注册或者MSP代建。自注册步骤如下: 访问华为乾坤控制台,在登录页面单击“立即注册”。 根据页面提示设置用户名、 密码等信息,确认无误后勾选隐私声明和用户协议,并单击“注册并登录”。 已购买并开通了云管理网络,具体步骤请参见《服务开通》的“开通云管理网络套餐”。 LAN-WAN融合场景需要购买“SD-WAN增值套餐”两种套餐。 父主题: 配置前准备
共100000条