华为云用户手册

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/nat/dynamicnat 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 { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "natMode" : "EASY_IP", "startAddress" : "192.168.1.1", "endAddress" : "192.168.1.2", "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] }

响应示例 返回状态码为200：更新成功，响应体参考NatResponse。 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" : { "dynamicNatInfo" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "natMode" : "EASY_IP", "startAddress" : "192.168.1.1", "endAddress" : "192.168.1.2", "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ], "staticNatInfo" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "isOverlay" : true, "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policyName", "linkId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/8", "isUserDefined" : true, "externalIp" : "10.2.0.1", "internalIp" : "10.1.0.1", "translationType" : 1, "protocol" : "1", "externalPort" : 90, "internalPort" : 90, "addressMask" : 30, "advanceSetEnable" : false, "direction" : 1, "natRuleInfos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocol" : 6, "sourceIp" : "10.1.0.1/16", "destinationIp" : "10.2.0.1/16", "sourcePort" : 1, "destinationPort" : 1 } ] } ] } }

请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:community-filter 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:community-filter" : { "name" : "filter1", "filter-type" : "basic", "basic-node" : [ { "sequence" : 1, "match-mode" : "permit", "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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:community-filter 是 REFERENCE 详细请参见表4。 团体属性过滤器配置参数。 - 表4 nes-ne-community-filter-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:community-filter 否 REFERENCE 详细请参见表5。 团体属性过滤器配置参数。 - 表5 community-filter-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string - - 名称，整数形式时范围1-99，字符串形式时1-51个字符且不能都是数字，单一主键字段。 "filter1" filter-type 否 string basic advanced - 过滤类型。 "basic" basic-node 否 ARRAY_REFERENCE 1-65535个列表项，详细请参见表6。 节点。 - 表6 nes-ne-community-filter-basic-node-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sequence 否 int64 [1-4294967295] - 序号，单一主键字段。 1 match-mode 否 string permit deny - 匹配类型。 "permit" community-member 否 ARRAY_REFERENCE 0-20个列表项，详细请参见表7。 团体属性。 - 表7 nes-ne-community-filter-basic-node-community-member-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 value 否 string - - 团体值，取值范围为0-65535:0-65535 或 1-4294967040 或 4294967044-4294967295，单一主键字段。 "1:1"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:community-filter 表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"

响应参数 返回状态码为200：操作成功。 表3 server-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-syslog:server ARRAY_REFERENCE 详细请参见表4。 服务 - 表4 syslog-config-exactProperties-server对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipaddress string - - IP地址 "E2:1:1:1:1:1:1:1" vrf-name string 1~31个字符。 _public_ VPN名称，默认为__public__ "_public_" port int64 [1-65535] - 端口 453 transport-mode string udp tcp udp 传输模式 "tcp" channel-id int64 [0-9] - 通道ID 5 facility string local0 local1 local2 local3 local4 local5 local6 local7 local7 设施，枚举值，默认为local7 "local7" ssl-policy-name string 1~23个字符。满足正则表达[a-z0-9_]*。 - ssl策略名称 "default" 返回状态码为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 { "huawei-nce-e-syslog:server" : [ { "ipaddress" : "E2:1:1:1:1:1:1:1", "vrf-name" : "_public_", "port" : 453, "transport-mode" : "tcp", "channel-id" : 5, "facility" : "local7", "ssl-policy-name" : "default" } ] } 返回状态码为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-syslog:syslog-config/server 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"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-syslog:syslog-config/server 表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"

响应参数 返回状态码为200：查询成功。 表2 LswGlobalVlanAllRespDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-512个列表项，详细请参见表5。 - - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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" : "", "data" : [ { "vlanId" : "10", "vlanName" : "vlan10", "vlanDesc" : "vlan10", "ipSubnetVlan" : ["10.100.100.100/24","10.101.100.100/24","10.102.100.100/24","10.103.100.100/24","10.104.100.100/24","10.105.100.100/24","10.106.100.100/24","10.107.100.100/24","10.108.100.100/24","10.109.100.100/24","10.110.100.100/24","10.111.100.100/24"], "unknownFlowDrop" : false, "arpSnoopingEnable" : false, "igmpSnoopingEnable" : false, "igmpSnoopingQuerierEnable" : false, "id" : "813a76d4-6eec-4264-ae45-a6f261482b60" } ] } 返回状态码为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

请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/lswglobalvlan/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/globalvlan 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

URI /controller/campus/v1/networkservice/networkconfig/net/lswglobalvlan/devices/{deviceId}/globalvlan 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string - - 设备ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应参数 返回状态码为200：查询成功，响应体参考TagList。 表2 TagList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~64个字符。 - 错误码 "0" errmsg string 1~64个字符。 - 错误信息 "" data ARRAY_REFERENCE 0-1000个列表项，详细请参见表3。 tag列表 - 表3 TagDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 1~64个字符。 - 标签ID "d25de9be-1d9a-4d06-a519-09ff92fee050" name string 1~64个字符。 - 标签名称 "tag123" deviceGroupId string 1~64个字符。 - 设备组ID "d25de9be-1d9a-4d06-a519-09ff92fee050" tenantId string 1~64个字符。 - 租户ID "125de9be-1d9a-4d06-a519-09ff92fee050" tagShortId string 1~64个字符。 - 标签短ID "123"

响应示例 返回状态码为200：查询成功，响应体参考TagList。 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" : [ { "id" : "d25de9be-1d9a-4d06-a519-09ff92fee050", "name" : "tag123", "deviceGroupId" : "d25de9be-1d9a-4d06-a519-09ff92fee050", "tenantId" : "125de9be-1d9a-4d06-a519-09ff92fee050", "tagShortId" : "123" } ] }

请求示例 HTTP的示例 GET /controller/campus/baseservice/api/v1/devicemgr/tags?siteId=d25de9be-1d9a-4d06-a519-09ff92fee050&deviceId=d25de9be-1d9a-4d06-a519-09ff92fee050 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

URI /controller/campus/baseservice/api/v1/devicemgr/tags 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string 1~64个字符。 - 站点id "d25de9be-1d9a-4d06-a519-09ff92fee050" deviceId 否 string 1~64个字符。 - 设备id "d25de9be-1d9a-4d06-a519-09ff92fee050"

URI /controller/campus/v1/networkservice/networkconfig/net/lswstpprotection/sites/{siteId}/stpprotection 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应示例 返回状态码为200：修改交换机STP保护配置成功，返回交换机STP保护配置信息。 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" : { "success" : [ { "deviceId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "edgedPortEnable" : false, "bpduProtection" : true, "autoRecoveryInterval" : 3000, "upstreamEnable" : false } ], "fail" : { "errcode" : "0", "errmsg" : "", "data" : [ { "deviceId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "edgedPortEnable" : false, "bpduProtection" : true, "autoRecoveryInterval" : 3000, "upstreamEnable" : false } ] } } } 返回状态码为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/networkservice/networkconfig/net/lswstpprotection/sites/fbb684c8-0d37-496f-bafa-4b06d5151e2e/stpprotection 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 { "stpProtectionConfigs" : [ { "deviceId" : "fbb684c8-0d37-406f-bafa-4b06d6151e2e", "edgedPortEnable" : false, "bpduProtection" : true, "autoRecoveryInterval" : 3000, "upstreamEnable" : false } ] }

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ssl-policy:ssl-policies 表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的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ssl-policy:ssl-policies 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

响应示例 返回状态码为200：接口调用成功，响应体参考OverlayWanBgpPolicyTemplateBindSiteResponse。 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" : "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

响应参数 返回状态码为200：接口调用成功，响应体参考OverlayWanBgpPolicyTemplateBindSiteResponse。 表3 OverlayWanBgpPolicyTemplateBindSiteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data string 0~256个字符。 - 模板ID。 "00000000-0000-0000-0000-000000000000" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy/template/site 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 { "vpnId" : "310473a6-8006-48a3-9558-543d32ea1757", "templateId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteIds" : ["00000000-0000-0000-0000-000000000000"] }

响应示例 返回状态码为200：Successful operation HTTP/1.1 200 OK Date: Fri,03 Dec 2021 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-application:output": { "template-application-id": "9a0f86c9-ff4e-43d5-b3ba-6f088ba4e4c2" } } 返回状态码为400：Bad Request HTTP/1.1 400 Bad Request Date: Fri,30 Dec 2022 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-application:create-template-application Host: 192.168.1.125:26335 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-nce-aoc-config-template-application:input": { "template":[ { "template-id":"a926f75d-ccff-4ea3-afb4-8d04ac3100c1" } ], "device": [ { "device-id": "8d394835-cb84-38f3-a4d5-36a7f2074b48" } ] } }

响应参数 返回状态码为200：Successful operation 表7 create-template-application-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template-application:output REFERENCE 详细请参见表8。 - - 表8 create-template-application-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-application-id string 0~128个字节。 - the identifier of the template application. "a945675d-ccff-4ea3-afb4-8d04ac3100c2" 返回状态码为400：Bad Request 详细信息请参见实际响应消息体。