华为云用户手册

响应示例 返回状态码为200：修改Loopback配置成功，响应体参考LoopbackResponseDto。 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" : { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "id" : "fbb684c80d37496fbafa4b06d5151e2e", "deviceName" : "device1", "esn" : "1019A063325", "nameAllocMode" : "manual", "loopBackName" : "LoopBack1", "ipAddress" : "192.168.0.1", "mask" : 24, "description" : "description" } } 返回状态码为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：调用查询堆叠成功，响应体参考QueryStackIdsOutDtoData。 表3 QueryStackIdsOutDtoData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。当没有错误时返回0。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-1000个列表项，详细请参见表4。 设备ID和堆叠ID对应列表。 - 表4 StackIdsOutDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 1~64个字符。 - 设备ID，UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359cb" stackId string 0~64个字符。 - 堆叠ID，UUID格式。 "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" 返回状态码为400：调用查询堆叠接口入参非法，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：调用查询堆叠内部异常，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：调用查询堆叠成功，响应体参考QueryStackIdsOutDtoData。 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" : [ { "deviceId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359cb", "stackId" : "as25fdbf-8dee-4823-bac2-5bfe8e3359ca" } ] } 返回状态码为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/v3/stack/ids/list 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 { "deviceIdList" : ["as25fdbf-8dee-4823-bac2-5bfe8e3359ca","as25fdbf-8dee-4823-bac2-5bfe8e3359cb"] }

响应参数 返回状态码为200：成功 表4 query-temporary-change-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:output REFERENCE 详细请参见表5。 - - 表5 query-temporary-change-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 change-template-infos ARRAY_REFERENCE 详细请参见表6。 template info - process int32 [0-65535] - 完成进度 50 total int32 [0-65535] - 总模板数量 10 表6 change-template-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-id string 0~128个字符。 - configure template id - template-name string 1~128个字符。 - template name - change-template-content string 0~1048576个字符。 - configure template content - error-message string 0~256个字符。 - error message - 返回状态码为400：失败 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：成功 HTTP/1.1 200 OK Date: Thu,21 Dec 2023 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "huawei-nce-aoc-config-template:output" : { "change-template-infos" : [ { "template-id" : "58f9035e-ce63-4c6c-b588-7998c7c9168b", "template-name" : "test", "change-template-content": "---\nhuawei-nce-e-ifm:interface:\n- name: \"GE1/1/1\"\n ifm-class: \"main-interface\"\n type: \"GE\"\n number: \"1/1/1\"\n level: \"L2\"\n link-up-down-trap-enable: true\n admin-status: \"down\"\n description: \"description\"\n" } ], "process" : 50, "total" : 10 } } 返回状态码为400：失败 HTTP/1.1 400 Bad Request Date: Thu,21 Dec 2023 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-config-template:query-temporary-change HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-nce-aoc-config-template:input": { "job-id": "5c261eb5-2f4a-4acc-a747-c77ee1d18083", "content-type":"yaml" } }

响应示例 返回状态码为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 { "errcode" : "0", "errmsg" : "", "networkVMsInfo" : [ { "vmId" : "00000000-0000-0000-0000-000000000000", "hostUnitId" : "00000000-0000-0000-0000-000000000000", "vmName" : "Forwarder", "vmStatus" : "active", "reason" : "", "vmCpuNumber" : "5", "vmCpuUsage" : "10%", "vmMemory" : "100", "vmMemoryUsage" : "10%", "cntrs" : [ { "cntrId" : "00000000-0000-0000-0000-000000000000", "cntrName" : "forward-ip-1", "cntrStatus" : "active", "cntrCpuUsage" : "IP", "cntrMemoryUsage" : "IP", "cntrInterfaces" : [ { "cnicId" : "00000000-0000-0000-0000-000000000000", "cnicName" : "GE0/0/1", "portPlane" : "outer-link", "dirverType" : "veth", "nfiName" : "GE0/0/1", "cnicIp" : "127.0.0.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/sdwan/v1/naas/device/details?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-ACCESS-TOKEN: x-yyyyyy

响应参数 返回状态码为200：查询成功返回。 表2 NaasNetworkDeviceDetailsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 状态码，0：请求成功。 "0" errmsg string - - 接口调用的错误信息。 "" networkVMsInfo ARRAY_REFERENCE 详细请参见表3。 虚机资源 - 表3 NetworkFunctionVMInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 vmId string 0~128个字符。 - vm ID。 "00000000-0000-0000-0000-000000000000" hostUnitId string 0~128个字符。 - hostUnitId ID。 "00000000-0000-0000-0000-000000000000" vmName string 0~128个字符。 - vm 名称。 "Forwarder" vmStatus string 0~32个字符。 - vm运行状态。unknown：未知, active：激活, stopped：停止, building：构建中, error：故障, timeout：超时。 "active" reason string 0~10000个字符。 - 状态异常原因。 - vmCpuNumber string 0~32个字符。 - CPU 个数。 "5" vmCpuUsage string 0~32个字符。 - CPU利用率。 "10%" vmMemory string 0~32个字符。 - 内存。 "100" vmMemoryUsage string 0~32个字符。 - 内存利用率。 "10%" cntrs ARRAY_REFERENCE 1-1000个列表项，详细请参见表4。 服务容器。 - 表4 NetworkFunctionCntr对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 cntrId string 0~128个字符。 - 容器ID。 "00000000-0000-0000-0000-000000000000" cntrName string 0~128个字符。 - 容器名称。 "forward-ip-1" cntrStatus string 0~32个字符。 - 容器运行状态。unknown：未知, created：创建中, running：运行中, paused：暂停, restarting：重启中, removing：移除中, exited：退出, dead：终止。 "active" cntrCpuUsage string 0~32个字符。 - 容器CPU利用率。 "IP" cntrMemoryUsage string 0~32个字符。 - 容器内存利用率。 "IP" cntrInterfaces ARRAY_REFERENCE 1-1000个列表项，详细请参见表5。 容器接口。 - 表5 CntrInterface对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 cnicId string 0~128个字符。 - 接口ID。 "00000000-0000-0000-0000-000000000000" cnicName string 0~128个字符。 - 接口名称。 "GE0/0/1" portPlane string 0~32个字符。 - 端口业务面。 "outer-link" dirverType string 0~32个字符。 - 驱动类型。 "veth" nfiName string 0~32个字符。 - 接口名称。 "GE0/0/1" cnicIp string 0~128个字符。 - 接口IP地址。 "127.0.0.1" 返回状态码为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 { "errcode" : "0", "errmsg" : "", "naasNetworkId" : "" } 返回状态码为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/sdwan/v1/naas/template 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 { "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "naasNetworkName" : "Template1", "naasNetworkPlatformType" : "", "networkInfrastructure" : { "subnet" : [ { "subnetName" : "subnet", "subnetId" : "00000000-0000-0000-0000-000000000000", "networkId" : "00000000-0000-0000-0000-000000000000", "portGroup" : "PortGroup-vmware", "segment" : "127.1.0.0/16", "reservedIps" : "127.1.1.1;127.1.1.2", "portGroupFc" : "PortGroup-fc" } ] }, "networkResources" : { "resources" : [ { "hostUnitType" : "director", "number" : 24 } ] }, "networkFunctions" : { "networkFunction" : [ { "interfaces" : [ { "nfiName" : "GE0/0/1", "subnetName" : "subnet" } ] } ] }, "initialLoadBalanceNumber" : "", "bandwidthRedundancy" : "", "nodeMaxDeviceNumber" : "" }

响应参数 返回状态码为201：创建成功，响应体参考DeviceRecordingResponse。 表3 DeviceRecordingResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表4。 - - 表4 DeviceRecording对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" recordingSchema string 1~32个字符。 - 记录方案名称，创建后不允许修改。 "name" tacacsTemplateId uuid - - 记录关联的TACA CS 服务器模板ID。 "00000000-0000-0000-0000-000000000000" cmdRecordEnable boolean true false false 使能记录用户操作命令行，默认false。 false deviceRecordingId uuid - - 记录方案ID。 "00000000-0000-0000-0000-000000000000" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为201：创建成功，响应体参考DeviceRecordingResponse。 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" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "recordingSchema" : "name", "tacacsTemplateId" : "00000000-0000-0000-0000-000000000000", "cmdRecordEnable" : false, "deviceRecordingId" : "00000000-0000-0000-0000-000000000000" } } 返回状态码为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/v1/sdwan/aaa/recording HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "recordingSchema" : "name", "tacacsTemplateId" : "00000000-0000-0000-0000-000000000000", "cmdRecordEnable" : false }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 recordinginfo 是 REFERENCE 详细请参见表2。 设备记录方案信息。 - 表2 DeviceRecordingInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" recordingSchema 是 string 1~32个字符。 - 记录方案名称，创建后不允许修改。 "name" tacacsTemplateId 是 uuid - - 记录关联的TACACS服务器模板ID。 "00000000-0000-0000-0000-000000000000" cmdRecordEnable 否 boolean true false false 使能记录用户操作命令行，默认false。 false

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/ospf/global/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 { "globalInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "routerId" : "192.168.1.1", "processId" : 501, "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "defaultRouteType" : 1, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "BGP", "processId" : 501, "cost" : 1, "externalRouteType" : 1 } ], "asbrSummarys" : [ { "ipAddress" : "10.1.0.0/16", "cost" : 0, "tag" : 1, "distributeDelay" : 1, "advertise" : true, "generateNull0Route" : false } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "importRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "configSource" : "Wan" } ] }

响应示例 返回状态码为200：接口调用成功，响应体参考OspfRouteGlobalResponse，返回的OSPF路由信息中仅包含对应的ID。 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" : "", "success" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "routerId" : "192.168.1.1", "processId" : 501, "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "defaultRouteType" : 1, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "BGP", "processId" : 501, "cost" : 1, "externalRouteType" : 1 } ], "asbrSummarys" : [ { "ipAddress" : "10.1.0.0/16", "cost" : 0, "tag" : 1, "distributeDelay" : 1, "advertise" : true, "generateNull0Route" : false } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "importRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "configSource" : "Wan" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "routerId" : "192.168.1.1", "processId" : 501, "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "defaultRouteType" : 1, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "BGP", "processId" : 501, "cost" : 1, "externalRouteType" : 1 } ], "asbrSummarys" : [ { "ipAddress" : "10.1.0.0/16", "cost" : 0, "tag" : 1, "distributeDelay" : 1, "advertise" : true, "generateNull0Route" : false } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "importRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "configSource" : "Wan" } } ] } 返回状态码为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：接口配置成功。 { "errcode": "0", "errmsg": "", "date": { "ftpType": "ftps", "serverIP": "1.0.0.0", "serverPort": "1", "username": "xxxxxx" } } 返回状态码为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：接口配置成功。 表2 ruleInfoResponseDTO对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表3。 - - 表3 ruleInfoDTO对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ftpType string 1~4个字符。满足正则表达^(ftp|ftps)$。 - ftp类型。 "ftps" serverIP string 1~32个字符。 - 服务器IP。 "1.0.0.0" serverPort string 1~10个字符。 - 服务器端口,范围为1-65535。 "1" username string 1~32个字符。 - 用户名。 "xxxxxx" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /v1/networkservice/sites/securityrules/midwareInfos 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 { "ftpType" : "ftps", "serverIP" : "1.0.0.0", "serverPort" : "1", "userPsw" : "xxxxxx", "username" : "xxxxxx" }

iMaster NCE-Campus内置缺省模板参数介绍 缺省情况下，iMaster NCE-Campus内置了以下模板，本章对缺省模板参数和下发命令进行详细介绍。 ACL缺省模板介绍（仅V300版本AR设备） SNMP缺省模板介绍（仅V300版本AR设备） WebSSHtimeout缺省模板介绍（仅V300版本AR设备） NetStream缺省模板介绍（仅V300版本AR设备） PBR缺省模板介绍（仅V300版本AR设备支持） 设备注册缺省模板介绍（仅V300版本AR设备） IPv6静态路由缺省模板介绍（仅V300版本AR设备） 配置Loopback接口缺省模板（仅V300版本AR设备） 配置Tunnel接口缺省模板（仅V300版本AR设备） 配置接口下绑定VPN缺省模板（仅V300版本AR设备） SNMPTemplate缺省模板（仅V600版本AR设备） KeychainTemplate缺省模板（仅V600版本AR设备） 在线升级IPS特征库和AV病毒库缺省模板介绍（仅V300版本AR设备） 开启URL远程查询功能缺省模板介绍（仅V300版本AR设备） 锁定/解锁huawei用户缺省模板（仅V600版本AR设备） 配置本地admin用户账号过期时间缺省模板（仅V300版本AR设备） 配置接口状态缺省模板（仅V600版本AR设备） 配置VTY优先级缺省模板（仅V600版本AR设备） 配置SSH服务端的IPv4源地址缺省模板（仅V600版本AR设备） 配置ACL规则缺省模板（仅V600版本AR设备） 配置密码策略缺省模板（仅V600版本AR设备） 配置地址集对象缺省模板（仅V600版本AR设备） 配置 域名 组缺省模板（仅V600版本AR设备） 配置安全区域缺省模板（仅V600版本AR设备） 配置NAT Server缺省模板（仅V600版本AR设备） 配置NAT功能缺省模板（仅V600版本AR设备） 配置安全策略缺省模板（仅V600版本AR设备） 父主题： 模板管理

响应示例 返回状态码为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 { "errcode" : "0", "errmsg" : "", "coreOspfInfoList" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN", "routerId" : "192.168.1.1", "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "internalPreference" : 10, "asePreference" : 150, "defaultRouteType" : 1, "routeRedistribute" : [ { "type" : "BGP", "cost" : 1, "processId" : 501, "externalRouteType" : 1 } ], "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "10.10.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "tag" : 100 }, "applyAction" : { "applyTag" : 100, "applyMetric" : { "cost" : 60 } } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "10.10.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "tag" : 100 }, "applyAction" : { "applyTag" : 100, "applyMetric" : { "cost" : 60 } } } ], "asbrSummarys" : [ { "ipAddress" : "10.1.0.0/16", "cost" : 0, "tag" : 1, "distributeDelay" : 1, "advertise" : false, "generateNull0Route" : false } ], "interfaces" : [ { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1 } ] } ], "gatewayOspfInfoList" : [ { "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "device", "processId" : 10, "configSource" : "LANWAN", "routerId" : "192.168.1.1", "defaultRouteAdvertisement" : false, "defaultRouteCost" : 1, "internalPreference" : 10, "asePreference" : 150, "defaultRouteType" : 1, "routeRedistribute" : [ { "type" : "BGP", "cost" : 1, "processId" : 501, "externalRouteType" : 1 } ], "exportRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "10.10.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "tag" : 100 }, "applyAction" : { "applyTag" : 100, "applyMetric" : { "cost" : 60 } } } ], "importRoutePolicy" : [ { "nodeMatchmode" : "PERMIT", "matchCondition" : { "ipPrefixList" : [ { "ipAddress" : "10.10.10.0", "maskLength" : 24, "maskUpperLimit" : 24, "maskLowerLimit" : 24 } ], "tag" : 100 }, "applyAction" : { "applyTag" : 100, "applyMetric" : { "cost" : 60 } } } ], "asbrSummarys" : [ { "ipAddress" : "10.1.0.0/16", "cost" : 0, "tag" : 1, "distributeDelay" : 1, "advertise" : false, "generateNull0Route" : false } ], "interfaces" : [ { "interfaceName" : "vlanif20", "subnetId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "cost" : 1, "drPriority" : 1, "mtuEnable" : false, "networkType" : "broadcast", "authMode" : "cryptographic", "algorithm" : "hmac-sha256", "key" : 1, "pwd" : "abc", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "areaId" : 10, "helloTimer" : 1, "areaType" : "normal", "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 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

响应参数 返回状态码为200：查询成功返回。 表2 QueryOspfProcessResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" coreOspfInfoList ARRAY_REFERENCE 0-8个列表项，详细请参见表3。 核心侧设备OSPF进程信息。 - gatewayOspfInfoList ARRAY_REFERENCE 0-8个列表项，详细请参见表3。 网关侧设备OSPF进程信息。 - 表3 OspfProcessDetailInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 0~64个字符。 - 设备标识。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceName string 0~64个字符。 - 设备名称，无需填充，查询返回。 "device" processId int32 [1-20000] - OSPF进程号。 10 configSource string 0~32个字符。 - 配置源 "LANWAN" routerId string 0~64个字符。 - 用于用户自定义配置RouterId,仅网关侧支持。 "192.168.1.1" defaultRouteAdvertisement boolean true false false 是否开启通告默认路由。仅网关侧生效，默认值为false。 false defaultRouteCost int32 [0-16777214] 1 默认路由开销。当defaultRouteAdvertisement为true时，defaultRouteCost生效。仅网关侧生效，默认值为1。 1 internalPreference int32 [1-255] 10 内部优先级。仅网关侧生效，默认值为10。 10 asePreference int32 [1-255] 150 ASE优先级。仅网关侧生效，默认值为150。 150 defaultRouteType int32 - - OSPF通告默认路由时的外部路由类型。 1 routeRedistribute ARRAY_REFERENCE 0-64个列表项，详细请参见表14。 引入其他路由协议学习到的路由信息。 - exportRoutePolicy ARRAY_REFERENCE 0-100个列表项，详细请参见表15。 向邻居发布路由的策略。匹配顺序信任输入顺序。仅网关侧支持。 - importRoutePolicy ARRAY_REFERENCE 0-100个列表项，详细请参见表15。 从邻居接收路由的策略。匹配顺序信任输入顺序。仅网关侧支持。 - asbrSummarys ARRAY_REFERENCE 0-64个列表项，详细请参见表20。 边界路由聚合列表。 - interfaces ARRAY_REFERENCE 0-16个列表项，详细请参见表14。 加入OSPF进程的接口信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/lanwan/interconnection/route/ospf/process 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnId 是 string 0~64个字符。 - VN标识。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 string 0~64个字符。 - 站点标识。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 string 36个字符。 - 设备标识。 "a99f794e-b510-438c-a75d-de59f02347eb" processId 否 int32 [1-65535] - 进程标识，查询进程时，必须要指定deviceId。 501

请求示例 HTTP的示例 GET /controller/campus/v1/lanwan/interconnection/route/ospf/process?vnId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&deviceId=a99f794e-b510-438c-a75d-de59f02347eb&processId=501 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：删除成功，响应体参考DeleteTaskRsp。 表3 DeleteTaskRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码，成功返回0 "0" errmsg string - - 错误信息 "" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：删除成功，响应体参考DeleteTaskRsp。 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" : "" } 返回状态码为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

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 DeleteTaskReq 是 REFERENCE 详细请参见表2。 请求体 - 表2 DeleteTaskReq对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 0~36个字符。 - 任务id "00000000-0000-0000-0000-000000000000"

请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/performance/spr-statistics/export-task 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" : "00000000-0000-0000-0000-000000000000" }