华为云用户手册

  • 响应示例 返回状态码为200:修改成功,响应体参考CommonRestResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] } } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/vty/acl 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 { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] }
  • 响应示例 返回状态码为200:操作成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 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,16 Feb 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-mpls:mpls 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-mpls:mpls" : { "enable" : true, "lsr-id" : "10.1.1.1" } }
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls:mpls 是 REFERENCE 详细请参见表4。 全局MPLS配置参数。 - 表4 mpls-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls:mpls 否 REFERENCE 详细请参见表5。 全局MPLS配置参数。 - 表5 mpls-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 enable 否 boolean true false - 使能。 true lsr-id 否 string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - LSR ID,IPv4地址格式。 "10.1.1.1"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-mpls:mpls 表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"
  • 请求示例 HTTP的示例 PUT /controller/campus/api/v1/networkconfig/lswospf/fbb684c8-0d37-496f-bafa-4b06d5151e2e/a63b91f86bbe415a92a4a5af437c858f 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 { "routerId" : "10.0.0.1", "processUUID" : "", "processId" : "auto", "opaqueLsa" : "", "gracefulRestart" : "", "staticProtocol" : { "enable" : true, "cost" : "1" }, "directProtocol" : { "enable" : true, "cost" : "1" }, "bgpProtocol" : { "enable" : true, "cost" : "1" }, "bandwidthReference" : "23", "preference" : "10", "silentInterfaceList" : { "all" : true, "interfaceNameList" : [ "" ] } }
  • URI /controller/campus/api/v1/networkconfig/lswospf/{deviceId}/{ospfId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" ospfId 是 string 32个字符。 - ospf Id "a63b91f86bbe415a92a4a5af437c858f"
  • 响应示例 返回状态码为200:LswOspfInfo Information HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "data" : { "routerId" : "10.0.0.1", "processUUID" : "", "processId" : "auto", "opaqueLsa" : "", "gracefulRestart" : "", "staticProtocol" : { "enable" : true, "cost" : "1" }, "directProtocol" : { "enable" : true, "cost" : "1" }, "bgpProtocol" : { "enable" : true, "cost" : "1" }, "bandwidthReference" : "23", "preference" : "10", "silentInterfaceList" : { "all" : true, "interfaceNameList" : [ "" ] } }, "errcode" : "0", "errmsg" : "" } 返回状态码为400:Error response HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errorCode" : "", "errorMsg" : "" }
  • 响应示例 返回状态码为200:批量查询容灾用的南向接入服务成功,响应体参考SouthAccessQueryOutput。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "OK", "totalRecords" : 1, "data" : [ { "id" : "00000000-0000-0000-000000000000", "name" : "运营商A", "description" : "运营商A的南向ip", "enable" : "false", "mainIp" : "192.168.10.10", "backupIp" : "192.168.10.11", "ipType" : "IPv4", "priority" : 1 } ] } 返回状态码为400:校验异常。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/v2/south/access/southaccs 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的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:community-filter/filter1 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,16 Feb 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,16 Feb 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,16 Feb 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-route-policy:community-filter/{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-99,字符串形式时1-51个字符且不能都是数字,单一主键字段。 "filter1"
  • 响应参数 返回状态码为200:校验成功。 表2 ValidationDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 [0-20000] - code 1000 message string 0~1000个字符。 - message "user is locked" 返回状态码为400:异常数据。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:校验成功。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "code" : 1000, "message" : "user is locked" } 返回状态码为400:异常数据。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求示例 HTTP的示例 POST /v1/runbook/external-systems/action/validate 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 { "id" : "3814d9aa-8d46-42ee-9194-dc17d0c21888", "account" : "support_e@huawei.com", "pwd" : "Example@123" }
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/snmp/user/00000000-0000-0000-0000-000000000000 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "config-status" : "reserved", "errorInfo" : "", "agentEnable" : true, "allIpv4Interface" : false, "passwordMinLength" : 8, "usmUserCmplxCheck" : false, "sysContact" : "R&D Beijing, Huawei Technologies co.,Ltd.", "sysLocation" : "Beijing China", "mibViews" : { "mibView" : [ { "viewName" : "view1", "whiteList" : [ "iso" ], "blackList" : [ "internet" ] } ] }, "v3Groups" : { "group" : [ { "groupName" : "group", "securityLevel" : "privacy", "acl" : 2000, "readView" : "view1", "writeView" : "view1", "notifyView" : "view1" } ] }, "usmUsers" : { "usmUser" : [ { "name" : "user", "groupName" : "group", "authProtocol" : "sha2-512", "authKey" : "Example@123", "privProtocol" : "aes256", "privKey" : "Example@234" } ] } }
  • 响应示例 返回状态码为200:配置成功,响应体参考SnmpUserResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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" : { "config-status" : "reserved", "errorInfo" : "", "agentEnable" : true, "allIpv4Interface" : false, "passwordMinLength" : 8, "usmUserCmplxCheck" : false, "sysContact" : "R&D Beijing, Huawei Technologies co.,Ltd.", "sysLocation" : "Beijing China", "mibViews" : { "mibView" : [ { "viewName" : "view1", "whiteList" : [ "iso" ], "blackList" : [ "internet" ] } ] }, "v3Groups" : { "group" : [ { "groupName" : "group", "securityLevel" : "privacy", "acl" : 2000, "readView" : "view1", "writeView" : "view1", "notifyView" : "view1" } ] }, "usmUsers" : { "usmUser" : [ { "name" : "user", "groupName" : "group", "authProtocol" : "sha2-512", "authKey" : "Example@123", "privProtocol" : "aes256", "privKey" : "Example@234" } ] } } } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:创建成功,响应体参考PeriodRebootDeviceResp。 表4 PeriodRebootDeviceResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "error" 返回状态码为400:校验异常,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:创建成功,响应体参考PeriodRebootDeviceResp。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 taskParam 是 REFERENCE 详细请参见表3。 参数。 - 表3 ReriodRebootDeviceParam对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mode 是 integer 0 1 2 3 - 设备重启类型,该字段可以设置为以下几种: a) 0:取消重启任务。 b) 1:立即重启。 c) 2:延时重启。 d) 3:定时重启。 1 rebootIn 否 string - - 延时重启时间,格式为DD:HH:MM 当mode字段是2时,必须设置该字段 该字段的取值范围是0天-30天。 "00:02:10" rebootAt 否 integer - - 定时重启时间,时间戳格式,单位为秒 当mode字段是3时,必须设置该字段 该字段的取值范围必须大于当前时间,且与当前时间间隔小于等于30天。 1526558552
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/oamservice/device-reboot/ea25fdbf-8dee-4823-bac2-5bfe8e3359cad 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 { "mode" : 1, "rebootIn" : "00:02:10", "rebootAt" : 1526558552 }
  • 接口约束 1、该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。 2、TNP激活后,communityPool,bgpAsNum无法修改,如需修改,请先清空站点;其中地址池参数(evpnIPpool,innerTunnelIPpool,interConnectIPpool,evpnIpv6Pool,innerTunnelIpv6Pool,interConnectIpv6Pool,linkLocalIPV6pool),可以扩充地址段,但已被站点使用的地址段不能修改或删除。
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/network-orchestration-resources 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 { "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" : "" } }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考NetworkOrchestrationResourcesResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 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,16 Feb 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,16 Feb 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/v2/sdwansyslog/syslog 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 { "enableHec" : true, "hecToken" : "00000000-0000-0000-0000-000000000000", "domainName" : "www.example.org", "address" : "10.136.108.65", "port" : 514, "hostname" : "sysname", "time" : "utc", "level" : "error", "logFormat" : "SYS LOG ", "syslogType" : ["IPS","AV"], "binarylogType" : ["SESSION_LOG"], "enableSsl" : true }
  • 响应示例 返回状态码为201:创建成功,响应体参考SyslogResponse。 HTTP/1.1 201 Created Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "syslog" : { "enableHec" : true, "hecToken" : "00000000-0000-0000-0000-000000000000", "domainName" : "www.example.org", "address" : "10.136.108.65", "port" : 514, "hostname" : "sysname", "time" : "utc", "level" : "error", "logFormat" : "SYSLOG", "syslogType" : ["IPS","AV"], "binarylogType" : ["SESSION_LOG"], "enableSsl" : true } }, "processInstanceId" : "" } 返回状态码为400:请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,16 Feb 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,16 Feb 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/routing-protocol/static?pageIndex=0&pageSize=20&sort=id&vpnId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&isDefaultVpn=false&deviceId=a99f794e-b510-438c-a75d-de59f02347eb&keyword=10.1.0.0/24 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:接口调用成功,响应体参考QueryStaticRouteResponse。 HTTP/1.1 200 OK Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "totalRecords" : 10, "pageSize" : 20, "pageIndex" : 1, "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,16 Feb 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,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
共100000条