华为云用户手册

请求示例 HTTP的示例 POST /controller/campus/v1/assurance/business/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 { "businessIdList" : [ "00000000-0000-0000-0000-000000000000" ] }

响应示例 返回状态码为200：成功响应，响应体参考BusinessSuccessRsp。 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" : { "businessBase" : { "name" : "business-exp", "id" : "00000000-0000-0000-0000-000000000000", "label" : "label-exp", "description" : "description-exp", "startTime" : 4102415940000, "endTime" : 4102415940000, "extBusinessId" : "00000000-0000-0000-0000-000000000000" }, "terminalList" : [ { "srcIpOrMac" : "192.168.1.1", "srcPort" : 1, "name" : "terminal-exp" } ], "appList" : [ { "dstIp" : "192.168.1.1", "dstPort" : 1, "protocol" : "ANY" } ], "smartAppInfo" : { "appType" : "Custom", "appId" : "12305", "appName" : "腾讯会议" } } } 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:route-policy/policy1/nodes/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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "huawei-nce-e-route-policy:nodes" : [ { "sequence" : 1, "match-mode" : "permit", "condition" : { "match-tag" : 1, "match-ipv4-type" : "ipv4-prefix", "match-ipv4-prefix" : "prefix1", "match-ipv6-type" : "ipv6-prefix", "match-ipv6-prefix" : "prefix1", "community-filter" : [ { "community-filter-name" : "communityFilterName1" } ], "ext-community-filter" : [ { "ext-community-filter-name" : "extCommunityFilterName1" } ] }, "action" : { "apply-tag" : 10, "apply-cost" : 10, "apply-local-preference" : 10, "apply-ext-community-color" : "100", "apply-community" : { "operation" : "replace", "set-community-type" : "inline", "communities" : [ "1:1" ] }, "apply-ext-community" : { "operation" : "replace", "ext-community-member" : [ { "value" : "1:1" } ] } } } ] }

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

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nodes 是 REFERENCE 详细请参见表4。 节点。 -

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:route-policy/{name}/nodes/{sequence} 表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~200个字符。 - 名称，单一主键字段。 "policy1" sequence 是 int64 [0-65535] - 序号，单一主键字段。 "1"

响应参数 返回状态码为200：操作成功 表4 dry-run-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-ac-restconf-transactions:output REFERENCE 详细请参见表5。 - - 表5 dry-run-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 result boolean - - 结果 true reason string 0~1024个字符。 - 失败原因 "error" 返回状态码为400：请求错误 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：操作成功 HTTP/1.1 200 OK Date: Tue,17 May 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "huawei-ac-restconf-transactions:output" : { "result" : true, "reason" : "error" } } 返回状态码为400：请求错误 HTTP/1.1 400 Bad Request Date: Tue,17 May 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 dry-run 是 REFERENCE 详细请参见表2。 试运行 - 表2 dry-run-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-ac-restconf-transactions:input REFERENCE 详细请参见表3。 - - 表3 dry-run-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 by-user 否 boolean - false by-user模式 false trans-id 是 string 1~255个字符。 - 事务id "d2f853ed-325e-39dc-aa6b-6cf7782c5300" service-parallel 否 boolean - false 并行执行业务 true async-execution 否 boolean - false 异步执行业务 true time-out 否 int64 [0-4294967295] - 超时时间 50

请求示例 HTTP的示例 POST /restconf/operations/huawei-ac-restconf-transactions:dry-run HTTP/1.1 Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-ac-restconf-transactions:input" : { "by-user" : false, "trans-id" : "d2f853ed-325e-39dc-aa6b-6cf7782c5300", "service-parallel" : true, "async-execution" : true, "time-out" : 50 } }

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/effective-times 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 { "effectiveTimes" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "Weekly", "weeklyDay" : "1111100", "startTime" : "00:00:00Z", "endTime" : "23:01:40Z" } ] }

响应示例 返回状态码为200：修改成功，响应体参考EffectiveTimeResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "Weekly", "weeklyDay" : "1111100", "startTime" : "00:00:00Z", "endTime" : "23:01:40Z" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "Weekly", "weeklyDay" : "1111100", "startTime" : "00:00:00Z", "endTime" : "23:01:40Z" } } ] } 返回状态码为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/policy/security/ips-policies?policyName=qos policy 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：查询成功，响应体参考QueryIPSPolicyResponse。 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" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "IPSPolicy", "status" : 1, "isActive" : true, "ipsProfileName" : "strict", "avEnable" : true, "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_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：查询成功，响应体参考QueryIPSPolicyResponse。 表2 QueryIPSPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表7。 IPS策略信息。 - 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：成功 HTTP/1.1 200 OK Content-Type: application/json { "huawei-nce-aoc-gnd-config-state:output": { "device": [ { "device-id": "8d394835-cb84-38f3-a4d5-36a7f2075084", "device-name": "test1", "esn": "", "device-type": "ROUTER", "model": "NE40E-X3A(V8)", "config-state": "success" } ], "count": 1 } }

请求示例 HTTP的示例 POST /restconf/operations/huawei-nce-aoc-gnd-config-state:query-gnd-config-state-by-devices HTTP/1.1 Host: 192.168.1.125:26335 Content-Type: application/json X-ACCESS-TOKEN: x-yyyyyy { "input": { "offset": 1, "limit": 10, "device-id": [ "8d394835-cb84-38f3-a4d5-36a7f2075081" ] } }

响应参数 返回状态码为200：成功 表4 query-gnd-config-state-by-devices-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-gnd-config-state:output REFERENCE 详细请参见表5。 - - 表5 query-gnd-config-state-by-devices-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 device ARRAY_REFERENCE 详细请参见表6。 设备信息 - count int32 [-2147483648-2147483647] - 查询结果数量 1 表6 query-gnd-config-state-by-devices-output-body-device对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 device-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 "deviceid" device-name string 0~255个字节。 - 设备名 "devicename" esn string 0~255个字节。 - 出厂号 "ens" device-type string 0~255个字节。 - 设备类型 "devicetype" model string 0~255个字节。 - 设备模型号 "model" config-state string success alarm pre-config fail sending - 0=成功; 1=告警 ; 2=预配置; 3=失败; 4=发送中 "success" error-info string 0~2048个字节。 - 报错信息 "errorinfo"

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/routing-protocol/ipv6ospf 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" : [ { "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, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "DIRECT", "processId" : 501, "cost" : 1 } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "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" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "configSource" : "Wan" } ] }

响应示例 返回状态码为200：接口调用成功，响应体参考IPv6OspfRouteResponse。 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, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "DIRECT", "processId" : 501, "cost" : 1 } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "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" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "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, "internalPreference" : 10, "asePreference" : 150, "routeRedistribute" : [ { "type" : "DIRECT", "processId" : 501, "cost" : 1 } ], "exportRoutePolicy" : { "nodes" : [ { "mode" : "permit", "matchCondition" : { "ipPrefix" : { "prefixFilters" : [ { "ipv6Address" : "FC00:3::1", "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" : [ { "ipv6Address" : "FC00:3::1", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ] }, "tag" : 100 }, "applyAction" : { "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100, "applyTag" : 100 } } ] }, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "transportNetworkPorts" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerDead" : 1, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ], "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

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:dhcpv4-if/{if-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" if-name 是 string 1~63个字符。 - interface name "GE0/0/2"

响应示例 返回状态码为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 { "huawei-nce-e-dhcpv4:dhcpv4-if" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "if-name" : "GE0/0/2", "dhcp-type" : "server", "encapsulation" : { "suboption" : "circuit-id remote-id subscriber-id vendor-specific-id" }, "option82-formats" : { "option82-format" : [ { "sub-option-type" : "remote-id", "option82-format" : "user-defined", "user-define-text" : "definedtext" } ] }, "option82-insert-setting" : { "insert" : "", "rebuild" : "" }, "dhcp-relay" : { "enable" : true, "information" : true, "information-strategy" : "drop", "option82" : { "link-selection-enable" : false, "link-selection-address" : "10.1.1.4" }, "relay-source-address" : { "source-address" : "10.1.1.1" }, "server-addresses" : [ { "server-address" : "10.1.1.1" } ], "gateway-addresses" : [ { "gateway-address" : "10.1.1.1" } ] }, "dhcp-server" : { "gateway-list" : [ { "gateway-ip" : "10.1.1.1", "mask" : 16 } ], "dns-list" : [ { "dns-ip" : "10.1.1.1" } ], "excluded-ip-address" : [ { "start-ip-address" : "10.1.1.1", "end-ip-address" : "10.1.1.1" } ], "static-bind" : [ { "static-bind-ip" : "10.1.1.1", "static-bind-mac" : "xxxx-xxxx-xxxx" } ], "option" : [ { "option-code" : 56, "ip-addresses" : [ "10.1.1.1" ], "ascii-string" : "wevweq", "hex-string" : "4", "cipher-string" : "********", "sub-options" : { "sub-option" : [ { "sub-option-code" : 233, "ip-addresses" : [ "10.1.1.1" ], "ascii-string" : "asciistring" } ] } } ], "ip-range" : { "start-ip-address" : "10.1.1.1", "end-ip-address" : "10.1.1.1" }, "server-enable" : false, "domain-name" : "domainname", "masklen" : 24 } } ] } 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-if/GE0%2F0%2F2 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：查询成功，响应体参考VpnInfoResponse。 表2 VpnInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 vpnList ARRAY_REFERENCE 0-1000个列表项，详细请参见表6。 VPN QoS组信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考VpnInfoResponse。 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" : 1, "pageSize" : 10, "pageIndex" : 1, "vpnList" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN1" } ] } 返回状态码为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/policy/traffic/vpn-qosgroup/vpn?id=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

请求示例 HTTP的示例 { "pluginType": "22", "pluginId": "c5d27901-d477-4a03-8a0c-11c5b4062484", "siteInfos": [ { "siteId": "ddbbd8fb-df45-4820-bd30-5127092174ff", "deviceType": "AP" } ] }

响应参数 返回状态码为200：创建部署插件任务成功返回体。 表4 PluginOperationRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" 返回状态码为400：创建部署插件任务失败返回体。 PluginOperationRsp对象的参数列表，详细请参见表4。

响应示例 返回状态码为200：创建部署插件任务成功返回体。 { "errcode": "0", "errmsg": null } 返回状态码为400：创建部署插件任务失败返回体。 { "errcode": "0307011027", "errmsg": "A plugin deployment task already exists at the current site, Uninstall it first." }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deployPluginReq 是 REFERENCE 详细请参见表2。 创建部署插件任务请求参数。 - 表2 DeployPluginReq对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pluginType 是 string 0~10个字符。 - 插件类型;22-无线非经/loT插卡;当前仅支持22类型插件。 "22" pluginId 是 string 0~36个字符。 - 插件Id。 "c5d27901-d477-4a03-8a0c-11c5b4062484" siteInfos 是 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 站点和款型信息。 - 表3 SiteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID。 "5301f062-7521-4fb8-a9ef-0be47ee0b697" deviceType 是 string 1~64个字符。 - 设备款型,当前仅支持AP设备。 "AP"