华为云用户手册

响应示例 返回状态码为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 { "code" : 1000, "message" : "user is locked" } 返回状态码为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 ValidationDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 code int32 [0-20000] - code 1000 message string 0~1000个字符。 - message "user is locked" 返回状态码为400：异常数据。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/vpn-qosgroup 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 { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN-Group1", "description" : "**********", "vpnList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN1" } ] }

响应示例 返回状态码为200：修改成功，响应体参考VpnQosGroupInfoResponse。 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" : "VPN-Group1", "description" : "**********", "vpnList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN1" } ] } ], "fail" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN-Group1", "description" : "**********", "vpnList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN1" } ] } ], "processInstanceId" : "00000000-0000-0000-0000-000000000000" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考VpnQosGroupInfoResponse。 HTTP/1.1 202 Accepted Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误，无响应体。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误，无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为200：修改成功，响应体参考VpnQosGroupInfoResponse。 VpnQosGroupInfoResponse对象的参数列表，详细请参见表4。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考VpnQosGroupInfoResponse。 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：配置成功，响应体参考SnmpUserResponse。 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" : { "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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/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" } ] } }

响应示例 返回状态码为201：创建AP VPN配置成功，响应体参考ApVpnResponseDto。 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" : { "id" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "ipsecConnectionName" : "vpn1", "deviceName" : "AirEngine6760R-51_FBF792C3", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "peerAddress" : "192.168.1.1" , "localIdType" : "ip", "localIdValue" : "myhost.example.com", "refinedAcl" : [ { "priority" : 1, "action" : true, "protocol" : "tcp", "sourceIp" : "192.168.1.0/24", "sourceIpPort" : "1000", "desIp" : "192.168.1.0/24", "port" : "1000", "description" : "acl信息" } ], "filterAcl" : [ { "priority" : 1, "action" : true, "protocol" : "tcp", "sourceIp" : "192.168.1.0/24", "sourceIpPort" : "1000", "desIp" : "192.168.1.0/24", "port" : "1000", "description" : "acl信息" } ], "ipsecTemplateId" : "f285e423-492a-41ef-a4b8-5a687fc6832a", "preSharedKey" : "IAm@example" } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部服务错误。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /controller/campus/api/v1/networkconfig/apvpn 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" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "ipsecConnectionName" : "vpn1", "deviceName" : "AirEngine6760R-51_FBF792C3", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "peerAddress" : "192.168.1.1" , "localIdType" : "ip", "localIdValue" : "myhost.example.com", "refinedAcl" : [ { "priority" : 1, "action" : true, "protocol" : "tcp", "sourceIp" : "192.168.1.0/24", "sourceIpPort" : "1000", "desIp" : "192.168.1.0/24", "port" : "1000", "description" : "acl信息" } ], "filterAcl" : [ { "priority" : 1, "action" : true, "protocol" : "tcp", "sourceIp" : "192.168.1.0/24", "sourceIpPort" : "1000", "desIp" : "192.168.1.0/24", "port" : "1000", "description" : "acl信息" } ], "ipsecTemplateId" : "f285e423-492a-41ef-a4b8-5a687fc6832a", "preSharedKey" : "IAm@example" }

请求示例 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 }

响应参数 返回状态码为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,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

请求参数 表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

响应示例 返回状态码为200：查询NTP成功，响应体参考QueryNtpResponse。 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" : "a99f794e-b510-438c-a75d-de59f02347eb", "enableServerAuthentication" : true, "authenKey" : "", "authKeyId" : "12", "enableAutoClient" : false, "ntps" : [ { "tnpId" : "b09a0266-f34e-125d-ce23-ad1278b6c590", "vpnId" : "b09a0266-f34e-125d-ce23-ad1278b6c590", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "sourceInterfaceId" : "LoopBack610", "ntpInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "ntpType" : "IPv6", "preferEn" : false, "serverIP" : "fc00:3::1", "authentication" : false, "mode" : "HMAC-SHA256", "authKey" : "******", "authId" : 10 } } ] } } 返回状态码为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：查询NTP成功，响应体参考QueryNtpResponse。 表2 QueryNtpResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 NtpInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" enableServerAuthentication boolean true false - 是否开启server认证。只有站点角色为边缘站点和控制站点合设时支持开启。默认为false。 true authenKey string 0~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 认证密码，enableServerAuthentication开启时必填。V300系列设备密码长度必须在6-255位,且必须满足复杂度，即必须包含特殊字符（"`!@#$%^&()_+=-[]{},.;）、英文大写字母（A~Z）、英文小写字母（a~z）、数字（0~9）中的任意两种组合及以上。V600系列设备仅V600R021C00及之后版本设备的密码必须包含12-255个字符，并且必须包含以下内容：大写字母，小写字母，数字和特殊字符（"`!@#$%^&()_+=-[]{},.;）。 - authKeyId string 0~32个字符。 - authenKeyId。enableServerAuthentication开启时必填。范围0~32，不能与客户端模式中手工配置下的认证ID重复。 "12" enableAutoClient boolean true false - 是否开启客户端跟随父站点。只有站点角色为边缘站点时支持开启，当开启开关后，无需再手工配置链路的TNP配置。默认为false。 false ntps ARRAY_REFERENCE 0-256个列表项，详细请参见表4。 手工配置ntp详情 - 表4 ManualNtpInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 tnpId string 0~64个字符。 - TNP ID，UUID格式。 "b09a0266-f34e-125d-ce23-ad1278b6c590" vpnId string 0~64个字符。 - overlay网络上的VPN ID，UUID格式。 "b09a0266-f34e-125d-ce23-ad1278b6c590" deviceId uuid - - 设备ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" sourceInterfaceId string 0~32个字符。 - NTP服务器部署在overlay网络时，client接入server的源接口 "LoopBack610" ntpInfo REFERENCE 详细请参见表5。 - - 表5 NtpInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - NTP ID，uuid格式。 "00000000-0000-0000-0000-000000000000" ntpType string 4个字符。 IPv4 NTP服务器地址类型，取值范围：IPv4、IPv6。 "IPv6" preferEn boolean true false false 是否指定该远程服务器为优先选择的服务器。 false serverIP string 0~39个字符。 - NTP服务器地址。当ntpType为IPv4，serverIp为IPv4地址，如：192.168.1.1；当ntpType为IPv6，serverIp为IPv6地址，如：fc00:3::1。 "fc00:3::1" authentication boolean true false false 是否认证。 false mode string 0~16个字符。 - 认证模式，取值范围：MD5、HMAC-SHA256。当authentication为true时，mode必填。V600版本设备不支持MD5。 "HMAC-SHA256" authKey string 6~255个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 认证密码，当authentication为true时，authKey必填。V300系列设备密码长度必须在6-255位,且必须满足复杂度，即必须包含特殊字符（"`!@#$%^&()_+=-[]{},.;）、英文大写字母（A~Z）、英文小写字母（a~z）、数字（0~9）中的任意两种组合及以上。V600系列设备仅V600R021C00及之后版本设备的密码必须包含12-255个字符，并且必须包含以下内容：大写字母，小写字母，数字和特殊字符（"`!@#$%^&()_+=-[]{},.;）。建议密码长度配置在12位以上。 "******" authId int64 - - 认证ID。取值范围：1-4294967295，其中V600版本设备在配置IPv6服务器时最大值为65535。当authentication为true时，authId必填。 10 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/net/ntp?siteId=a99f794e-b510-438c-a75d-de59f02347eb 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的示例 PUT /controller/campus/api/v1/networkconfig/apmesh/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/connectkey 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 { "meshPassword" : "examplepassword" }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 connectkey 是 REFERENCE 详细请参见表3。 Mesh密钥。 - 表3 ConnectkeyDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 meshPassword 是 password 8~63个字符。 - 该字段可能包含敏感信息和个人数据，请妥善做好保护。 Mesh密钥。密钥要求为8~63位数字、英文字母以及除问号与空格外的特殊字符的组合只能包含以下字符中的一种或者多种：小写字母、大写字母、数字、特殊字符，并且首尾不能是双引号不能含有全角字符，不能全为* "examplepassword"

响应示例 返回状态码为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" : "" } 返回状态码为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

响应示例 返回状态码为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

请求示例 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" : "" } }

接口约束 1、该接口仅支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用。 2、TNP激活后，communityPool，bgpAsNum无法修改，如需修改，请先清空站点；其中地址池参数（evpnIPpool，innerTunnelIPpool，interConnectIPpool，evpnIpv6Pool，innerTunnelIpv6Pool，interConnectIpv6Pool，linkLocalIPV6pool），可以扩充地址段，但已被站点使用的地址段不能修改或删除。

响应参数 返回状态码为200：配置成功，响应体参考RestResponse。 表4 RestResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~16个字符。 - 错误码。 "0" errmsg string 0~1024个字符。 - 错误信息。 "" fail ARRAY_REFERENCE 0-10000个列表项，详细请参见表5。 配置失败站点 - processInstanceId string 0~64个字符。 - 编排流程实例ID，UUID格式。当接口返回码为202时非空。 "00000000-0000-0000-0000-000000000000" 表5 ConfigFailed对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~16个字符。 - 错误码。 "0" errmsg string 0~1024个字符。 - 错误信息。 "" data REFERENCE 详细请参见表6。 站点信息。 - 表6 SiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 1~36个字符。 - UUID格式。 "fbb684c8-ddaa-3451-bafa-4b06d5158956" 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考RestResponse。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为403：接口无权限。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/sdwan/monitor/{metric}/switch 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 metric 是 string 0~64个字符。 - 采集项，该字段可以设置为以下几种： a) netstream：应用流量 b) tcpfpm：应用质量 c) wanlink：WAN链路流量 d) linkqualityEnhance：WAN链路质量增强 e) sourceip：LAN IP采集（源IP） f) wanSourceIp：WAN IP采集（源IP） g) wanDestIp：WAN IP采集（目的IP） h) wanSession：WAN IP采集（会话） i) thirdPartyNetstream：第三方Netstream sourceip，wanSourceIp，wanDestIp，wanSession只能使能其中一个，当已使能其中一个时，且再次使能剩下三个之一，须先去使能。 V600系列设备不支持linkqualityEnhance，sourceip，wanSourceIp，wanDestIp，wanSession。 "netstream"

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/monitor/netstream/switch 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 { "cfgSiteIds" : [ "fbb684c8-0d37-496f-bafa-4b06d515a7l6" ], "uncfgSiteIds" : [ "bab674c8-4d47-58d9-aaba-5b06d715f945" ], "fixPacketsNum" : 1 }

响应示例 返回状态码为200：配置成功，响应体参考RestResponse。 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" : "", "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-ddaa-3451-bafa-4b06d5158956" } } ], "processInstanceId" : "00000000-0000-0000-0000-000000000000" } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考RestResponse。 HTTP/1.1 202 Accepted Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为400：请求参数错误。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403：接口无权限。 HTTP/1.1 403 Forbidden 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/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,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" : "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,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部异常。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/localuser/users/accampus 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 { "password" : "Iam@example", "operationRange" : "new" }

响应示例 返回状态码为200：修改成功，返回信息，结构体参见initLocalUserInfoResponse。 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" : "" }