华为云用户手册

  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv6OspfRouteInfos 是 REFERENCE 详细请参见表2。 IPv6 OSPF路由信息。 - 表2 IPv6OspfRouteInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 routes 否 ARRAY_REFERENCE 1-8个列表项,详细请参见表3。 IPv6 OSPF路由信息。 - 表3 IPv6OspfRouteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 对应站点ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 是 uuid - - 设备ID。格式是uuid,创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 uuid - - 所在VPN ID。格式是uuid,创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId 否 uuid - - 所在TNP ID。格式是uuid,创建underlay ospf路由时必填。当前不支持。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" routerId 否 string - - 用于用户自定义配置RouterId,创建时选填,不可修改,不能配置127.0网段。 "192.168.1.1" processId 是 int32 [1-65535] - 进程号。创建时必填。EVPN隧道模式下,Underlay场景,当前不支持;Overlay场景,取值范围:1-20000。 501 defaultRouteAdvertisement 否 boolean true false false 是否开启通告默认路由。创建时必填。 false defaultRouteCost 否 int32 [1-16777214] 1 默认路由开销。开启通告默认路由时必填。 1 internalPreference 否 int32 [1-255] 10 内部优先级。创建时必填。 10 asePreference 否 int32 [1-255] 150 ASE优先级。创建时必填。 150 routeRedistribute 否 ARRAY_REFERENCE 0-64个列表项,详细请参见表4。 路由引入。 - exportRoutePolicy 否 REFERENCE 详细请参见表5。 IPV6发布路由策略。 - importRoutePolicy 否 REFERENCE 详细请参见表5。 IPV6接收路由策略。 - ipSubnets 否 ARRAY_REFERENCE 0-64个列表项,详细请参见表12。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts 否 ARRAY_REFERENCE 0-64个列表项,详细请参见表12。 TNP接口参数。创建underlay ospf时必填。当前不支持。 - configSource 否 string 0~32个字符。 - 配置源信息,用于区分是WAN业务还是LanWan互联业务,仅查询接口使用,不能修改,取值范围:Wan、LanWan。 "Wan" 表4 IPv6RouteRedistributeInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 type 是 string 0~16个字符。 - 取值范围:OSPFv3、DIRECT、STATIC、BGP。 "DIRECT" processId 否 int32 [1-65535] - 引用的OSPFv3进程号,引入路由类型为OSPFv3时必填。EVPN隧道模式下,Underlay场景,当前不支持;Overlay场景,取值范围:1-20000。 501 cost 否 int32 [1-16777214] 1 开销。 1 表5 IPv6OspfRoutePolicy对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nodes 否 ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 export方向permit节点支持多个,import方向最多只有一个。更新ospf时,如果node长度为0,则代表删除对应的路由策略。 - 表6 IPv6OspfPolicyNode对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 是 string 0~16个字符。 - 节点匹配模式,取值为permit或deny。 "permit" matchCondition 否 REFERENCE 详细请参见表7。 路由策略匹配条件,至少填写一个匹配条件。 - applyAction 否 REFERENCE 详细请参见表10。 路由策略应用的行为。 - 表7 IPv6OspfPolicyNodeMatchCondition对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipPrefix 否 REFERENCE 详细请参见表8。 IP前缀。 - tag 否 int64 [0-4294967295] - 指定路由信息标记值。 100 表8 IPv6OspfIpPrefixList对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 prefixFilters 是 ARRAY_REFERENCE 0-100个列表项,详细请参见表9。 前缀过滤器。 - 表9 IPv6OspfPrefixFilter对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv6Address 是 string - - IP地址。必填。 "FC00:3::1" maskLength 是 int8 [0-128] - 掩码。必填。 24 greaterEqual 否 int8 [0-128] - 掩码范围下限。 24 lessEqual 否 int8 [0-128] - 掩码范围上限。 24 表10 IPv6OspfPolicyNodeApplyAction对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 applyMetric 否 REFERENCE 详细请参见表11。 路由策略应用Metric值。 - localPreference 否 int64 [0-4294967295] - 本地优先级。 100 preferredValue 否 int64 [0-65535] - 首选值。 100 applyTag 否 int64 [0-4294967295] - 指定路由信息标记值。 100 表11 IPv6OspfApplyMetric对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 cost 否 string - - 路由开销值,取值范围0-4294967295。只在underlay ospf发布策略的白名单生效。 "24" sign 否 string - - add表示增加开销值,sub表示减小开销值。该字段暂未实现。 "add" 表12 IPv6InterfaceParameterInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaceType 否 string 0~64个字符。 - 接口类型,非必填,默认IPSUBNET口 "tunnel" interfaceId 是 uuid - - IP Subnet ID。格式是uuid。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" areaId 是 string - - 区域ID,取值范围0-4294967295。 "0" areaType 否 string 0~10个字符。 - 区域类型。取值:normal(缺省情况下,OSPF区域被定义为普通区域)、stub(不允许发布自治系统外部路由,只允许发布区域内路由和区域间的路由)、nssa(NSSA区域能够将自治域外部路由引入并传播到整个OSPF自治域中)。 "normal" authMode 是 string 0~16个字符。 none 认证方式。取值:none、cryptographic。 "none" cryptographicSuit 否 string 0~16个字符。 hmac-sha256 加密算法。取值:hmac-sha256。认证方式为cryptographic时必填。 "hmac-sha256" key 否 int32 [1-255] 1 key。认证方式为cryptographic时必填。 1 cryptographicPwd 否 string 1~255个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 密码必须包含如下规则:密码长度必须在1~255位。密码只支持特殊字符("`!@#$%^&()_+=-[]{},.;)、英文大写字母(A~Z)、英文小写字母(a~z)和数字(0~9)。为提高安全性,建议密码至少包含小写字母、大写字母、数字、特殊字符这四种形式中的两种,同时密码长度不小于6个字符。 "1" helloTimer 是 int32 [1-65535] 10 Hello报文时间间隔。建议Hello报文时间间隔取值不小于5,否则可能会造成邻接关系的中断。缺省情况下,P2P、Broadcast类型接口发送Hello报文的时间间隔的值为10秒;P2MP、NBMA类型接口发送Hello报文的时间间隔的值为30秒。 1 timerDead 否 int32 [1-65535] - OSPFv3的邻居失效时间,必须大于Hello报文的时间间隔。 1 networkType 否 string 0~16个字符。 - 网络类型。取值:broadcast(将接口的网络类型更改为广播)、nbma(将接口的网络类型更改为NBMA)、p2mp(将接口的网络类型更改为点到多点)、p2p(将接口的网络类型更改为点到点)。 "broadcast" cost 否 int32 [1-65535] - 开销。 1 drPriority 是 int32 [0-255] 1 DR优先级。 1
  • 响应示例 返回状态码为200:删除成功,响应体参考NatServerResponse。 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" : [ { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "test name", "globalStartAddress" : "192.168.1.1", "globalEndAddress" : "192.168.1.2", "insideStartAddress" : "192.168.1.1", "insideEndAddress" : "192.168.1.2", "globalSourcePort" : "1", "globalEndPort" : "2", "insideSourcePort" : "1", "insideEndPort" : "2", "protocol" : "6", "reverse" : true, "interfaceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "errparam" : "["policyName"]", "data" : { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "test name", "globalStartAddress" : "192.168.1.1", "globalEndAddress" : "192.168.1.2", "insideStartAddress" : "192.168.1.1", "insideEndAddress" : "192.168.1.2", "globalSourcePort" : "1", "globalEndPort" : "2", "insideSourcePort" : "1", "insideEndPort" : "2", "protocol" : "6", "reverse" : true, "interfaceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0" } } ] } 返回状态码为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/nat/natserver/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 { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "policyIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"] }
  • 请求示例 HTTP的示例 PUT /controller/campus/v2/accountservice/accessuser/users/51cdcbe3-5e14-492b-ab27-86950b661d19 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 { "userName" : "test", "roleIds" : [ "" ], "email" : "xxx@example.com", "telephone" : "1xxxxxxxxxx", "vaildPeriod" : "1571710215000", "maxAccessNum" : 1, "accessType" : "deny", "description" : "0", "nextUpdateUserpass" : true, "deviceManagerFlag" : true, "name" : "", "bindInfo" : { "bindDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "20", "vlan" : "3377" } ], "bindAccDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "20", "vlan" : "3377" } ], "bindEsn" : "21500829352SH1903955,21500829352SH1903977", "bindIP" : "10.1.1.1,10.1.1.2", "bindImsi" : "12312,668", "bindMac" : "11-11-11-11-11-11,22-22-22-22-22-22" }, "fields" : [ { "customFieldId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359cb", "customFieldValue" : "aaa" } ], "accountStatus" : 0 }
  • 响应示例 返回状态码为200:修改成功,响应体参考ModifyUserOutputDto。 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" : "5b988058-e092-4310-a0ad-575e9b50e2db", "userGroupId" : "51cdcbe3-5e14-492b-ab27-86950b661d19", "modifyDate" : "1571710215000", "userName" : "test", "roleIds" : [ "" ], "email" : "xxx@example.com", "telephone" : "1xxxxxxxxxx", "vaildPeriod" : "1571710215000", "maxAccessNum" : 1, "accessType" : "deny", "description" : "0", "nextUpdateUserpass" : true, "deviceManagerFlag" : true, "name" : "", "bindInfo" : { "bindDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "20", "vlan" : "3377" } ], "bindAccDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "20", "vlan" : "3377" } ], "bindEsn" : "21500829352SH1903955,21500829352SH1903977", "bindIP" : "10.1.1.1,10.1.1.2", "bindImsi" : "12312,668", "bindMac" : "11-11-11-11-11-11,22-22-22-22-22-22" }, "fields" : [ { "customFieldId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359cb", "customFieldValue" : "aaa" } ], "accountStatus" : 0 } } 返回状态码为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:修改成功,响应体参考ModifyUserOutputDto。 表4 ModifyUserOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~20个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息描述。 "" data REFERENCE 详细请参见表7。 修改成功出参。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/upgrade/version?deviceModel=AP6050DN 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,05 Aug 2018 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "data" : { "pkgList" : [ { "id" : "9caf51b3-ed87-4d9f-8680-30ab932a4dfd", "version" : "V200R010C00SPC200", "fileName" : "Fat&CloudAP6050DN_V200R010C00SPC200B233", "displayName" : "B233", "depenedPkgVersion" : "V200R010C00SPC200" } ], "pkgPatchMap" : { "V200R010C00SPC200" : [ { "id" : "9caf51b3-ed87-4d9f-8680-30ab932a4dfd", "version" : "V200R010C00SPC200", "fileName" : "Fat&CloudAP6050DN_V200R010C00SPC200B233", "displayName" : "B233", "depenedPkgVersion" : "V200R010C00SPC200" } ] }, "featureMap" : { "V200R010C00SPC200" : [ { "id" : "b926785b-d489-4718-bed2-bae2e7d66b9c", "version" : "V200R010C00SPC200", "fileName" : "test_V200R010C00SPC200B233.ccx", "displayName" : "B233", "depenedPkgVersion" : "V200R010C00SPC200" } ] } } 返回状态码为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/application/sac-engine-settings 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 feature 否 String - - sac-engine开关特性。 取值范围:SAC Engine、FPI、IP Identify。 不填为SAC Engine。 "SAC Engine"
  • 响应示例 返回状态码为200:查询成功,响应体参考GetSacEngineSettingsResponse。 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" : "", "sacEngineSettings" : { "feature" : "SAC Engine", "settings" : true, "scope" : "all", "siteIds" : [ "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的示例 GET /controller/campus/v1/sdwan/application/sac-engine-settings?feature=SAC Engine 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
  • 请求示例 HTTP的示例 POST /v1/networkservice/hierarchy-template/template-groups/00000000-0000-0000-0000-000000000000/members/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 { "deleteIds" : ["00000000-0000-0000-0000-000000000000"], "delBindProperties" : false }
  • 响应示例 返回状态码为200:Success。 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" : "error", "data" : [ { "Id" : "" } ] } 返回状态码为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
  • URI /v1/networkservice/hierarchy-template/template-groups/{id}/members/action/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。 - 模板组ID,UUID格式。 "00000000-0000-0000-0000-000000000000"
  • 响应示例 返回状态码为200:成功响应,响应体参考TerminalAllResponse。 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" : [ { "srcIpOrMac" : "192.168.1.1", "srcPort" : 1, "name" : "terminal-exp" } ] } 返回状态码为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
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 queryOption 是 REFERENCE 详细请参见表2。 查询参数。 - 表2 TerminalQueryOption对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [0-100] 1 页索引。 1 pageSize 否 int32 [0-50] 10 页大小。 10 businessId 是 string 0~36个字符。 - 业务保障ID。 "00000000-0000-0000-0000-000000000000" filterValue 否 string 0~64个字符。 - 终端IP。 "192.168.1.1"
  • 响应参数 返回状态码为200:成功响应,响应体参考TerminalAllResponse。 表3 TerminalAllResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 状态码,0:请求成功。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "" pageIndex int32 [0-100] - 页索引。 1 pageSize int32 [0-50] - 页大小。 10 totalRecords int32 [0-65535] - 记录总数。 10 data ARRAY_REFERENCE 0-2000个列表项,详细请参见表10。 终端列表。 - 返回状态码为400:失败响应。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/assurance/terminal 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" : 10, "businessId" : "00000000-0000-0000-0000-000000000000", "filterValue" : "192.168.1.1" }
  • 响应示例 返回状态码为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", "total" : 10000, "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 } } ] } 返回状态码为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?pageNo=1&pageSize=10&keyword=五元组名称 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:查询识别流模板数据成功后的状态返回码。 表2 StreamProfileOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "Success" total int32 - - 总数。 10000 data ARRAY_REFERENCE 0-10000个列表项,详细请参见表3。 模板信息及配置数据 - 表3 StreamProfileInput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~256个字符。 - 模板名称 "test" description string 0~512个字符。 - 模板描述 "五元组模板" fiveTuple REFERENCE 详细请参见表4。 五元组信息 - 表4 FiveTupleProfileData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 protocol string 0~4个字符。 - 协议号, TCP/UDP,或者协议号7 "TCP" srcIp string 0~128个字符。 - 源IP "192.168.0.1/32" dstIp string 0~128个字符。 - 目的IP "192.168.0.1/32" srcPortRange string 0~11个字符。 - 源端口范围 "100-200" dstPortRange string 0~11个字符。 - 源端口范围 "200" fiveTupleType int32 - - 0-动态五元组 1-静态五元组 0 返回状态码为400:查询识别流模板数据失败后的状态返回码。 详细信息请参见实际响应消息体。 返回状态码为500:接口发生内部错误后的状态返回码。 详细信息请参见实际响应消息体。
  • URI /v1/performanceservice/identify/instances 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageNo 是 int32 [1-1000] - 页数 1 pageSize 是 int32 [5-100] - 当前页大小 10 keyword 否 string 0~256个字符。 - 五元组名称模糊查询 "五元组名称"
  • URI /controller/campus/v1/oamservice/resetchassis/devices/{deviceId}/frame/{frameNo} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID或堆叠ID, UUID格式。 "ea25fdbf-8dee-4823-bac2-5bfe8e3359cad" frameNo 是 integer 1 2 - 机框号。 1
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/oamservice/resetchassis/devices/ea25fdbf-8dee-4823-bac2-5bfe8e3359cad/frame/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:整框重启成功,响应体参考ResetChassisOutputDto。 表2 ResetChassisOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码:当没有错误时返回0。 "0" errmsg string 0~256个字符。 - 接口调用结果的描述信息。 "error" 返回状态码为400:校验异常,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:整框重启成功,响应体参考ResetChassisOutputDto。 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" : "error" } 返回状态码为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:接口调用成功,响应体参考StaticRouteResponse。返回的静态路由信息中仅包含对应的ID,siteId,vpnId。 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" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "10.1.0.0/16", "nextHopType" : "ip-address", "ipAddress" : "10.1.1.1", "track" : true, "target" : "10.1.0.0", "configSource" : "Wan", "isDefaultVpn" : false, "outBoundInterface" : "Tunnel0/0/400", "outBoundInterfaceDisplayName" : "GE0/0/2", "outBoundInterfaceType" : "IPSec" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "10.1.0.0/16", "nextHopType" : "ip-address", "ipAddress" : "10.1.1.1", "track" : true, "target" : "10.1.0.0", "configSource" : "Wan", "isDefaultVpn" : false, "outBoundInterface" : "Tunnel0/0/400", "outBoundInterfaceDisplayName" : "GE0/0/2", "outBoundInterfaceType" : "IPSec" } } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:内部错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/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 { "routes" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "vpnId" : "a99f794e-b510-438c-a75d-de59f02347eb", "siteId" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "tnpId" : "a99f794e-b510-438c-a75d-de59f02347eb", "priority" : 1, "destinationAddressMask" : "10.1.0.0/16", "nextHopType" : "ip-address", "ipAddress" : "10.1.1.1", "track" : true, "target" : "10.1.0.0", "configSource" : "Wan", "isDefaultVpn" : false, "outBoundInterface" : "Tunnel0/0/400", "outBoundInterfaceDisplayName" : "GE0/0/2", "outBoundInterfaceType" : "IPSec" } ] }
  • 响应示例 返回状态码为200:下发成功。 HTTPS 200 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0", "errmsg": "", "successList": [ "IC1-Huawei-AR502H-GW-0001" ], "failList": [ { "id": "5c37d9e8-cdf6-11e8-a4fc-286ed488d002", "serialNumber": "IC1-Huawei-AR502H-GW-0002", "errcode": "0x00c80049", "errmsg": "WAC is not online" } ] } 返回状态码为400:重下发失败。 HTTPS 400 Bad Requests Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode": "0x00c8000d", "errmsg": "The parameter ids is null." } 返回状态码为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/campusoamservice/v1/cpe/cli/reconfig HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "taskIds": [ "5c37d9e8-cdf6-11e8-a4fc-286ed488d001","5c37d9e8-cdf6-11e8-a4fc-286ed488d002" ] }
共100000条
提示

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