华为云用户手册

  • 响应示例 返回状态码为200:切换注册WAN链路成功,响应体参考SiteManagerLinkChangeResponse。 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", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347aa", "wanLinkId" : "a99f794e-b510-438c-a75d-de59f02347bb", "protocol" : "IPv4", "southAccessRole" : 1, "accessIpMode" : 0 } } 返回状态码为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
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteManagerLinkUpdateRequest 是 REFERENCE 详细请参见表2。 入参 - 表2 SiteManagerLinkChange对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 UUID - - 站点ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 UUID - - 设备ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347aa" wanLinkId 否 string 0~64个字符。 - 链路ID,格式为uuid,更新时必填。 "a99f794e-b510-438c-a75d-de59f02347bb" protocol 否 string 0~32个字符。 - 注册AC链路的协议:IPv4、IPv6,默认值IPv4。 "IPv4" southAccessRole 否 integer [1-2] 1 南向接入服务,1表示南向接入服务1、2表示南向接入服务2,默认值为1。IPv6不支持使用南向接入服务2。 1 accessIpMode 否 integer [0-1] 0 南向接入IP模式,0表示主用南向IP、1表示备用南向IP,默认值为0。 0
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/net/site-manage-link 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" : "a99f794e-b510-438c-a75d-de59f02347eb", "deviceId" : "a99f794e-b510-438c-a75d-de59f02347aa", "wanLinkId" : "a99f794e-b510-438c-a75d-de59f02347bb", "protocol" : "IPv4", "southAccessRole" : 1, "accessIpMode" : 0 }
  • 响应示例 返回状态码为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 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nqa:nqa/TestName 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-nqa:nqa" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "test-name" : "TestName", "type" : "ipv4", "ipv4-dest-address" : "192.168.1.1", "ipv4-next-hop" : "192.168.1.2", "ipv6-dest-address" : "FC00::1101", "ipv6-next-hop" : "FC00::1102", "out-if-name" : "GE0/0/1", "vpn-instance" : "_public_", "probe-count" : 5, "interval" : 4, "timeout" : 3, "frequency" : 22, "data-size" : 0, "ttl" : 30, "tos" : 0, "send-trap-bits" : "resultchange", "execution-switch" : true } ] }
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nqa:nqa 是 REFERENCE 详细请参见表4。 NQA配置参数。 -
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 站点模板AP隧道全局配置参数体 - 表3 ApTunnelGlobalDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 networkOffPeriod 否 int64 [0-120] 0 主备隧道倒换用户接入间隔时间(单位:秒) 100
  • 请求示例 HTTP的示例 PUT /controller/campus/v3/networkconfig/site-templates/fbb684c8-0d37-496f-bafa-4b06d5151e2e/aptunnel-config 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 { "networkOffPeriod" : 100 }
  • URI /controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/aptunnel-config 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应示例 返回状态码为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" : "", "data" : { "networkOffPeriod" : 100 } } 返回状态码为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:查询单板配置信息成功。 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" : [ { "slot" : "slot2", "model" : "ET1D2S04SX1E", "status" : "0" } ] } 返回状态码为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
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkservice/networkconfig/net/board/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/boards 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/board/devices/{deviceId}/boards 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid 36个字符。 - 设备标识,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应参数 返回状态码为200:查询单板配置信息成功。 表2 GetBoardResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-20个列表项,详细请参见表5。 查询到的单板配置信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:配置成功,响应体参考SimpleResponse。 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" : "", "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SimpleResponse。 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 返回状态码为207:部分失败,响应体参考BindSyslogRsp。 HTTP/1.1 207 Multi-Status 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 { "successList" : [ { "errmsg" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "sourceIp" : "192.168.0.1", "sourceInterface" : "loopback601" } ], "failList" : [ { "errmsg" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "linkId" : "00000000-0000-0000-0000-000000000000", "linkName" : "link1", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnName" : "vpn1", "sourceIp" : "192.168.0.1", "sourceInterface" : "loopback601" } ] } 返回状态码为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:配置成功,响应体参考SimpleResponse。 SimpleResponse对象的参数列表,详细请参见表3。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考SimpleResponse。 返回状态码为207:部分失败,响应体参考BindSyslogRsp。 表6 BindSyslogRsp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 successList ARRAY_REFERENCE 详细请参见表7。 成功列表。 - failList ARRAY_REFERENCE 详细请参见表7。 失败列表。 - 表7 SuccessFailData对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errmsg string - - 失败原因,成功时则为空。 "" siteId string - - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName string - - 站点名称。 "site1" deviceId string - - 设备ID。 "00000000-0000-0000-0000-000000000000" deviceName string - - 设备名称。 "device1" linkId string - - 链路ID。 "00000000-0000-0000-0000-000000000000" linkName string - - 链路名称。 "link1" vpnId string - - VPN ID。 "00000000-0000-0000-0000-000000000000" vpnName string - - VPN名称。 "vpn1" sourceIp string - - 设备日志源Ip。 "192.168.0.1" sourceInterface string - - 设备日志源接口。 "loopback601" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/v2/sdwansyslog/syslog/00000000-0000-0000-0000-000000000000/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 { "bindSites" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "devices" : [ { "deviceId" : "00000000-0000-0000-0000-000000000000", "linkId" : "00000000-0000-0000-0000-000000000000", "sourceIp" : "192.168.0.1", "sourcePort" : 10245, "sourceInterface" : "601" } ] } ], "unbindSites" : [ "00000000-0000-0000-0000-000000000000" ] }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考OverlayWanBgpPolicyResponse。 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" : { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515a7e6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7e6", "importRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] }, "exportRoutePolicy" : { "nodes" : [ { "nodeIndex" : 20060, "mode" : "permit", "matchCondition" : { "ipPrefix" : { "name" : "", "prefixFilters" : [ { "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 25, "lessEqual" : 28 } ], "ipv6PrefixFilters" : [ { "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "communityFilters" : [ { "name" : "bgpCommunityFilterTest", "communityNodes" : [ { "matchMode" : "permit", "communityMembers" : [ "65520:4555" ] } ], "wholeMatch" : "" } ] }, "applyAction" : { "applyCommunity" : { "communityNumbers" : [ "1000" ], "additive" : "", "none" : "" }, "applyExtCommunity" : { "rtFilters" : [ "65520:4552" ], "additive" : true }, "applyCommunityDelete" : { "communityFilterName" : "communityTest" }, "applyAsPath" : { "asNumbers" : [ "1000" ], "additive" : "", "overwrite" : "", "none" : "" }, "applyMetric" : { "cost" : "24", "sign" : "add" }, "localPreference" : 100, "preferredValue" : 100 }, "nextNode" : { "nextNodeIndex" : 20080 } } ] } } } 返回状态码为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的示例 GET /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy?vpnId=a99f794e-b510-438c-a75d-de59f02347eb&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
  • URI /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb"
  • 响应示例 返回状态码为200:查询成功,响应体参考QuerySiteQosPolicyResponse。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "vpnGroupId" : "00000000-0000-0000-0000-000000000000", "name" : "qos1", "direction" : "", "qosRules" : [ { "qosRuleId" : "00000000-0000-0000-0000-000000000000", "qosClassificationId" : "00000000-0000-0000-0000-000000000000", "qosClassificationName" : "qosClassificationName", "qosProfileId" : "00000000-0000-0000-0000-000000000000", "qosProfileName" : "templateName", "lanQosProfileId" : "00000000-0000-0000-0000-000000000000", "lanQosProfileName" : "templateName", "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "qosPriority" : 1 } ], "status" : 1, "isActive" : true, "bindMode" : "siteMode" } ] } 返回状态码为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
  • URI /controller/campus/v1/sdwan/policy/traffic/sites/{siteId}/qos-policy 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 qosPolicyId 否 uuid - - 策略ID。 "00000000-0000-0000-0000-000000000000"
  • 响应参数 返回状态码为200:查询成功,响应体参考QuerySiteQosPolicyResponse。 表3 QuerySiteQosPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-100个列表项,详细请参见表6。 QoS策略信息。 - 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/sites/00000000-0000-0000-0000-000000000000/qos-policy?qosPolicyId=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
  • 响应示例 返回状态码为201:创建成功返回。 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" : { "name" : "vn1", "vpnInstanceName" : "vpn1", "siteInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteName" : "site", "isWanServiceNeeded" : true, "routeDistinguisher" : "101:3", "status" : "SUCCESS", "errMsg" : "" } ], "ipsecEncryption" : true, "overlayHeadLength" : 36, "enableIPv6" : true, "description" : "vn", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6" } } 返回状态码为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/v1/lanwan/vn 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 { "name" : "vn1", "ipsecEncryption" : true, "vpnInstanceName" : "vpn1", "overlayHeadLength" : 36, "enableIPv6" : true, "ipType" : "IPv4", "description" : "vn" }
  • 响应参数 返回状态码为201:创建成功返回。 表3 VnResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表4。 VN详细信息。 - 表4 VnInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 0~32个字符。 - VN名称。 "vn1" vpnInstanceName string 0~31个字符。 - 下发到设备的VPN实例名称,无需填充,查询返回。 "vpn1" siteInfos ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 站点ID列表,最大100个。 - ipsecEncryption boolean true false true 当链路未开启IPSEC加密功能时,可基于VPN配置是否开启IPSEC加密。 true overlayHeadLength int32 [1-512] - VPN隧道长度扣除字节数。当VPN隧道长度扣除字节数为空时,表示不配置VPN隧道长度扣除字节数。tunnel建议的扣除长度为36;开启Ipsec时,建议扣除94;开启Ipsec、NAT时,建议扣除102,V600版本设备从V600R022C00版本开始支持此功能,AR6700V-LITE从V600R023C00版本开始支持此功能。 36 enableIPv6 boolean true false false 是否使能IPv6能力 true description string 0~200个字符。 - VN业务描述。 "vn" id string 0~36个字符。 - VN标识。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" 表5 SiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 36个字符。 - 站点标识,uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" siteName string 0~64个字符。 - 站点名称,不需要填充。 "site" isWanServiceNeeded boolean true false true 该参数已经废弃,无需设置。 true routeDistinguisher string 0~21个字符。 - 路由标识RD,填写后不支持修改。支持的格式如下:2字节自治系统号:4字节用户自定义数,其中自治系统号的取值范围是0~65535,用户自定义数的取值范围是0~4294967295,例如101:3。自治系统号和用户自定义数不能同时为0,即RD的值不能是0:0;整数形式4字节自治系统号:2字节用户自定义数,自治系统号的取值范围是65536~4294967295,用户自定义数的取值范围是0~65535,例如0:3或者65537:3。其中,自治系统号和用户自定义数不能同时为0,即RD的值不能是0:0;点分形式4字节自治系统号:2字节用户自定义数,点分形式自治系统号通常写成x.y的形式,x和y的取值范围都是0~65535,用户自定义数的取值范围是0~65535,例如0.0:3或者0.1:0。其中,自治系统号和用户自定义数不能同时为0,即RD的值不能是0.0:0;IPv4地址:2字节用户自定义数,例如:192.168.122.15:1。IP地址的取值范围是0.0.0.0~255.255.255.255;用户自定义数的取值范围是0~65535。不可配置5500:5500因预留给增强模式下的vlanif使用。 "101:3" status string SUCCESS CONFIGURING FAIL - 下发状态,不需要填充。 "SUCCESS" errMsg string 0~256个字符。 - 错误信息,不需要填充。 "" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnBaseInfo 是 REFERENCE 详细请参见表2。 VN信息。 - 表2 CreateVnInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 是 string 1~32个字符。 - VN名称。 "vn1" ipsecEncryption 否 boolean true false false 当链路未开启IPSEC加密功能时,可基于VPN配置是否开启IPSEC加密。 true vpnInstanceName 否 string 0~31个字符。 - 自定义下发到设备的VPN实例名称,可不填。如不填充,由系统自动生成。 "vpn1" overlayHeadLength 否 int32 [1-255] - VPN隧道长度扣除字节数。当VPN隧道长度扣除字节数为空时,表示不配置VPN隧道长度扣除字节数。tunnel建议的扣除长度为36;开启Ipsec时,建议扣除94;开启Ipsec、NAT时,建议扣除102,V600版本设备从V600R022C00版本开始支持此功能,AR6700V-L从V600R023C00版本开始支持此功能。 36 enableIPv6 否 boolean true false false 是否使能IPv6能力,兼容字段,后续使用ipType字段,enableIPv6为false时,相当于ipType取值IPv4,enableIPv6为true时,相当于ipType取值IPv4IPv6。V300版本的设备当前IPv6只支持本地开局,不支持站点间互访、overlay Qos、智能选路,集中上网功能。V600版本的设备需要升级到R022C10及后续版本才能支持以上功能,AR6700V-L从V600R023C10版本开始支持此功能。 true ipType 否 string 0~200个字符。 - IP类型。GRE隧道模式支持的字段:IPv4、IPv4IPv6。enableIPv6与ipType都配置的情况下,优先使用ipType。 "IPv4" description 否 string 0~200个字符。 - VN业务描述。 "vn"
  • URI /controller/campus/v1/sdwan/vty/acl 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-10000] 1 起始页。默认值为1。 1 pageSize 否 int32 [1-1000] 10 页行记录数。默认值为10。 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" aclNum 否 int32 [2000-2999] - VTY ACL的acl编号。 2100
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/vty/acl?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&aclNum=2100 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
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全