华为云用户手册

  • 响应示例 返回状态码为201:创建IPv4静态路由返回参数。 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" : "", "success" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreStaticInfoList" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "platform" : "platform", "priority" : 120, "destIp" : "192.168.10.0/24", "nextHopType" : "ip-address", "nextHopIpAddress" : "192.168.10.1", "isTracked" : false, "trackTargetIpAddress" : "192.168.10.1", "configSource" : "LANWAN" } ], "gatewayStaticInfoList" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "platform" : "platform", "priority" : 120, "destIp" : "192.168.10.0/24", "nextHopType" : "ip-address", "nextHopIpAddress" : "192.168.10.1", "isTracked" : false, "trackTargetIpAddress" : "192.168.10.1", "configSource" : "LANWAN" } ] }, "fail" : { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "failCoreRouteStaticList" : { "errcode" : "0", "errmsg" : "", "routeInfo" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "platform" : "platform", "priority" : 120, "destIp" : "192.168.10.0/24", "nextHopType" : "ip-address", "nextHopIpAddress" : "192.168.10.1", "isTracked" : false, "trackTargetIpAddress" : "192.168.10.1", "configSource" : "LANWAN" } ] }, "failGatewayRouteStaticList" : { "errcode" : "0", "errmsg" : "", "routeInfo" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "platform" : "platform", "priority" : 120, "destIp" : "192.168.10.0/24", "nextHopType" : "ip-address", "nextHopIpAddress" : "192.168.10.1", "isTracked" : false, "trackTargetIpAddress" : "192.168.10.1", "configSource" : "LANWAN" } ] } } } 返回状态码为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/interconnection/route/static 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 { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreStaticInfoList" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "platform" : "platform", "priority" : 120, "destIp" : "192.168.10.0/24", "nextHopType" : "ip-address", "nextHopIpAddress" : "192.168.10.1", "isTracked" : false, "trackTargetIpAddress" : "192.168.10.1", "configSource" : "LANWAN" } ], "gatewayStaticInfoList" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "platform" : "platform", "priority" : 120, "destIp" : "192.168.10.0/24", "nextHopType" : "ip-address", "nextHopIpAddress" : "192.168.10.1", "isTracked" : false, "trackTargetIpAddress" : "192.168.10.1", "configSource" : "LANWAN" } ] }
  • 响应参数 返回状态码为201:创建IPv4静态路由返回参数。 表4 RouteStaticResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success REFERENCE 详细请参见表5。 配置IPv4静态路由成功时的返回数据。 - fail REFERENCE 详细请参见表7。 配置IPv4静态路由失败时的返回数据。 - 表5 RouteLinkStaticInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkId string 36个字符。 - 互联接口标识,创建和更新时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" coreStaticInfoList ARRAY_REFERENCE 0-128个列表项,详细请参见表6。 核心侧设备IPv4静态路由详细信息。 - gatewayStaticInfoList ARRAY_REFERENCE 0-128个列表项,详细请参见表6。 网关侧设备IPv4静态路由详细信息。 - 表6 RouteStaticInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 36个字符。 - 单条IPv4静态路由标识。创建不填。查询返回。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" linkId string 36个字符。 - 互联标识,创建不填,查询返回。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" linkName string 0~64个字符。 - 互联接口名称, 创建、更新不填,查询返回。 "ConnectLink" deviceId string 36个字符。 - 设备标识。创建时必填。查询返回。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceName string 0~64个字符。 - 设备名称,创建、更新不填,查询返回。 "Core-1" deviceType string 0~10个字符。 - 设备类型,创建、更新不填,查询返回。 "LSW" platform string 0~10个字符。 - 是否是pnf设备的标识 "platform" priority int32 [1-255] 60 静态路由优先级。priority的值越小,优先级越高。 120 destIp string 0~64个字符。 - 静态路由目的地址。格式:IPV4/掩码。 "192.168.10.0/24" nextHopType string 0~64个字符。 ip-address 静态路由下一跳类型,取值范围:ip-address、black-hole。black-hole表示黑洞下一跳。仅网关侧设备支持。 "ip-address" nextHopIpAddress string 0~64个字符。 - 静态路由下一跳IP地址。当nextHopType为black-hole时,nextHopIpAddress无需填写。若linkId对应的核心侧和网关侧都存在,并且下一跳为对端主IP地址,则不需要填充此项,否则需要填充。 "192.168.10.1" isTracked boolean true false false 静态路由是否与NQA联动。仅网关侧设备支持。 false trackTargetIpAddress string 0~64个字符。 - NQA探测的目的IP地址。若isTracked为true,则trackTargetIpAddress必填,否则不需要填充。仅网关侧设备支持。 "192.168.10.1" configSource string 0~32个字符。 - 配置源 "LANWAN" 表7 FailRouteStaticInfos对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkId string 36个字符。 - 互联接口标识。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" failCoreRouteStaticList REFERENCE 详细请参见表8。 失败的核心侧IPv4静态路由集合。 - failGatewayRouteStaticList REFERENCE 详细请参见表8。 失败的网关侧IPv4静态路由集合。 - 表8 FailRouteStaticInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" routeInfo ARRAY_REFERENCE 0-128个列表项,详细请参见表6。 设备IPv4静态路由详细信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 routeLinkStaticInfo 是 REFERENCE 详细请参见表2。 创建LANWAN互联IPv4静态路由参数。一次操作只能创建基于一个互联口信息的路由。 - 表2 RouteLinkStaticInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 linkId 是 string 36个字符。 - 互联接口标识,创建和更新时必填。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" coreStaticInfoList 否 ARRAY_REFERENCE 0-128个列表项,详细请参见表3。 核心侧设备IPv4静态路由详细信息。 - gatewayStaticInfoList 否 ARRAY_REFERENCE 0-128个列表项,详细请参见表3。 网关侧设备IPv4静态路由详细信息。 - 表3 RouteStaticInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 string 36个字符。 - 单条IPv4静态路由标识。创建不填。查询返回。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" linkId 否 string 36个字符。 - 互联标识,创建不填,查询返回。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" linkName 否 string 0~64个字符。 - 互联接口名称, 创建、更新不填,查询返回。 "ConnectLink" deviceId 否 string 36个字符。 - 设备标识。创建时必填。查询返回。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceName 否 string 0~64个字符。 - 设备名称,创建、更新不填,查询返回。 "Core-1" deviceType 否 string 0~10个字符。 - 设备类型,创建、更新不填,查询返回。 "LSW" platform 否 string 0~10个字符。 - 是否是pnf设备的标识 "platform" priority 否 int32 [1-255] 60 静态路由优先级。priority的值越小,优先级越高。 120 destIp 是 string 0~64个字符。 - 静态路由目的地址。格式:IPV4/掩码。 "192.168.10.0/24" nextHopType 否 string 0~64个字符。 ip-address 静态路由下一跳类型,取值范围:ip-address、black-hole。black-hole表示黑洞下一跳。仅网关侧设备支持。 "ip-address" nextHopIpAddress 否 string 0~64个字符。 - 静态路由下一跳IP地址。当nextHopType为black-hole时,nextHopIpAddress无需填写。若linkId对应的核心侧和网关侧都存在,并且下一跳为对端主IP地址,则不需要填充此项,否则需要填充。 "192.168.10.1" isTracked 否 boolean true false false 静态路由是否与NQA联动。仅网关侧设备支持。 false trackTargetIpAddress 否 string 0~64个字符。 - NQA探测的目的IP地址。若isTracked为true,则trackTargetIpAddress必填,否则不需要填充。仅网关侧设备支持。 "192.168.10.1" configSource 否 string 0~32个字符。 - 配置源 "LANWAN"
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/internet/00000000-0000-0000-0000-000000000000/centralized-access/batch 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 { "centralizedAccessInfo" : [ { "areaId" : "00000000-0000-0000-0000-000000000000", "areaName" : "area_1", "description" : "centralized access", "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "priority" : "1" } ], "enableIpv6" : false } ] }
  • 响应参数 返回状态码为200:修改成功,响应体参考CentralizedAccessBatchResponse。 CentralizedAccessBatchResponse对象的参数列表,详细请参见表4。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考CentralizedAccessBatchResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:修改成功,响应体参考CentralizedAccessBatchResponse。 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" : [ { "areaId" : "00000000-0000-0000-0000-000000000000", "areaName" : "area_1", "description" : "centralized access", "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "priority" : "1" } ], "enableIpv6" : false } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "areaId" : "00000000-0000-0000-0000-000000000000", "areaName" : "area_1", "description" : "centralized access", "centralizedSiteInfos" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "priority" : "1" } ], "enableIpv6" : false } } ], "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考CentralizedAccessBatchResponse。 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:配置成功,响应体参考netstreamIfListResponse。 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" : { "netstreamIf" : [ { "ifName" : "GE0/0/0", "netstreamIf" : { "config-status" : "", "errorInfo" : "", "flowType" : "IPv4", "samplerRates" : [ { "direction" : "inbound", "fixPacketsValue" : 1 } ], "samplerEnables" : [ { "direction" : "inbound" } ], "applyFlexFlowRecordNames" : [ "record1" ], "exportTnpFlag" : false, "afterDecapFlag" : false } } ] } } 返回状态码为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/sdwan/netstream/00000000-0000-0000-0000-000000000000/interface 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 { "netstreamIf" : [ { "ifName" : "GE0/0/0", "netstreamIf" : { "config-status" : "", "errorInfo" : "", "flowType" : "IPv4", "samplerRates" : [ { "direction" : "inbound", "fixPacketsValue" : 1 } ], "samplerEnables" : [ { "direction" : "inbound" } ], "applyFlexFlowRecordNames" : [ "record1" ], "exportTnpFlag" : false, "afterDecapFlag" : false } } ] }
  • 响应示例 返回状态码为200:修改AP子网配置成功,响应体参考ApSubnetResponseDto。 { "errcode": "0", "errmsg": "", "data": { "id": "1f23369b44904d28aca2203df250d71f", "name": "subnet", "vlanId": 1, "getIpAddressMode": 1, "ipv4poolOrNot": null, "ipAddress": null, "maskAddress": null, "ipv4PoolId": null, "dhcpEnable": null, "dhcpConfig": { "dnsConfig": null, "dhcpServerOptions": null, "leasesConfig": null, "excludedAddresses": null, "staticBindings": null }, "natPolicys": [], "natEnable": false, "aclId": null, "dhcpMode": "server", "relayServerIps": null } } 返回状态码为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的示例 { "id":"1f23369b44904d28aca2203df250d71f", "name": "subnet", "ipAddress": "192.168.0.1", "getIpAddressMode": 1, "natEnable": false, "maskAddress": "255.255.255.0" }
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/switch/local-tnp-prefer?siteId=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:查询成功,响应体参考GetLocalTnpPreferSwitchStatusResponse。 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 { "enableLocalTnpPrefer" : "" }
  • 响应示例 返回状态码为200:查询单个设备上M-LAG配置以及Peer-Link、成员口信息 { "currentMLag": { "dfsGroupId": "1", "dfsGroupName": "MLAG01", "mode": "active-standby", "peerLink": [{ "deviceId": "cfff4933-39aa-cfaf-9833-bcaa13874933", "deviceName": "device1", "ifName": "Eth-Trunk1", "priority": 150, "peerDeviceId": "09ae4933-196e-cfef-9183-bcaa13874a3c", "peerDeviceName": "device2", "peerIfName": "Eth-Trunk1", "peerPriority": 100 }], "mLagMemberList": [ { "mLagId": "1", "mLagMemberlink": { "deviceId": "cfff4933-39aa-cfaf-9833-bcaa13874933", "deviceName": "device1", "ifName": "Eth-Trunk2", "peerDeviceId": "09ae4933-196e-cfef-9183-bcaa13874a3c", "peerDeviceName": "device2", "peerIfName": "Eth-Trunk2", } } ] }, "peerLinks": [ { "deviceId": "cfff4933-39aa-cfaf-9833-bcaa13874933", "deviceName": "device1", "ifName": "Eth-Trunk4", "peerDeviceId": "09ae4933-196e-cfef-9183-bcaa13874a3c", "peerDeviceName": "device2", "peerIfName": "Eth-Trunk4" },{ "deviceId": "cfff4933-39aa-cfaf-9833-bcaa13874933", "deviceName": "device1", "ifName": "Eth-Trunk5", "peerDeviceId": "09ae4933-196e-cfef-9183-bcaa13874a3c", "peerDeviceName": "device2", "peerIfName": "Eth-Trunk5" } ], "localPorts": [ { "ifName": "Eth-Trunk1" },{ "ifName": "Eth-Trunk2" },{ "ifName": "Eth-Trunk3" },{ "ifName": "Eth-Trunk4" },{ "ifName": "Eth-Trunk5" },{ "ifName": "Eth-Trunk6" },{ "ifName": "Eth-Trunk7" } ], "peerPorts": [ { "ifName": "Eth-Trunk1" },{ "ifName": "Eth-Trunk2" },{ "ifName": "Eth-Trunk3" },{ "ifName": "Eth-Trunk4" },{ "ifName": "Eth-Trunk5" },{ "ifName": "Eth-Trunk6" },{ "ifName": "Eth-Trunk7" } ] } 返回状态码为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:查询单个设备上M-LAG配置以及Peer-Link、成员口信息 表2 QueryMLagInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 currentMLag REFERENCE 详细请参见表3。 当前的M-LAG配置信息 - peerLinks ARRAY_REFERENCE 0-1个列表项,详细请参见表6。 成员设备间的Trunk链路列表 - localPorts ARRAY_REFERENCE 0-1024个列表项,详细请参见表7。 Eth-Trunk接口。 - localPortsForPeerLink ARRAY_REFERENCE 0-1024个列表项,详细请参见表7。 Eth-Trunk接口。 - peerPorts ARRAY_REFERENCE 0-1024个列表项,详细请参见表7。 Eth-Trunk接口。 - peerPortsForPeerLink ARRAY_REFERENCE 0-1024个列表项,详细请参见表7。 Eth-Trunk接口。 - 表3 MlagConfigration对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dfsGroupName string 0~64个字符。满足正则表达^[a-zA-Z0-9_.@-]+$。 - Dfs-Group组名称。 "dfsGroup1" mode string 0~14个字符。满足正则表达active-standby|active-active。 active-active Dfs-Group组级别的工作模式,可不填,默认双活模式, 可指定主备模式。 "active-active" dualActiveDetectLink REFERENCE 详细请参见表4。 配置双主检测链路。 - peerLink ARRAY_REFERENCE 0-1个列表项,详细请参见表6。 为Dfs-Group指定的Peer-Link链路,仅能指定一条 - mLagMemberList ARRAY_REFERENCE 0-1024个列表项,详细请参见表5。 成员列表。 - 表4 DualActiveDetectLink对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 0~36个字符。 - 设备ID,uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" deviceName string 0~64个字符。 - 本端设备名称。 "fw1" ifName string 0~64个字符。 - 双主检测本端接口名称,物理口,非Eth-Trunk口。 "10GE 1/0/7" peerDeviceId string 0~36个字符。 - 设备ID,uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45d" peerDeviceName string 0~64个字符。 - 对端设备名称。 "fw2" peerIfName string 0~64个字符。 - 双主检测对端接口名称,物理口,非Eth-Trunk口。 "10GE 1/0/7" ipPoolName string 0~32个字符。 - 为接口分配IP地址的资源池名称。 "CoreIpPool" 表5 MlagMembersDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 mLagId string 0~36个字符。 - M-LAG的组id。 "1" mLagMemberlink REFERENCE 详细请参见表6。 M-LAG的成员链路。 - 表6 MlagLinkDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 0~36个字符。 - 设备ID,uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" deviceName string 0~64个字符。 - 设备名称。 "fw1" ifName string 0~64个字符。 - 设备名称。 "fw1" priority int32 [1-254] 150 本端设备优先级。 100 peerDeviceId string 0~36个字符。 - 设备ID,uuid格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c" peerDeviceName string 0~64个字符。 - 设备名称。 "fw1" peerIfName string 0~64个字符。 - 设备名称。 "fw1" peerPriority int32 [1-254] 100 对端设备优先级。 100 表7 Eth-TrunkIf对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ifName string 0~64个字符。 - 接口名称。 "Eth-Trunk1" 返回状态码为400:参数校验异常 详细信息请参见实际响应消息体。 返回状态码为500:服务内部错误 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /v1/netcfg/sites/dfs-groups/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/m-lags 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:操作成功。 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的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-ifm:interface 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-ifm:interface" : { "name" : "10GE0/0/0", "ifm-class" : "main-interface", "type" : "10GE", "parent-if-name" : "10GE0/0/0", "number" : "0/0/0", "level" : "L3", "vpn-instance" : "vpn1", "admin-status" : "down", "description" : "the interface for underlay", "bandwidth" : { "bandwidth" : 20, "bandwidth-kbps" : 20 }, "trunk" : { "members" : [ { "interface-name" : "10GE0/0/0" } ] }, "ethernet" : { "negotiation-mode" : "enabled", "combo-mode" : "copper", "duplex" : "full", "speed" : "1000M" } } }
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ifm:interface 是 REFERENCE 详细请参见表4。 接口配置参数。 - 表4 nes-ne-interface-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-ifm:interface 否 REFERENCE 详细请参见表5。 接口配置参数。 - 表5 interface-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 1~63个字符。 - 接口名称。名称规则:接口类别为主接口时,由物理类型、接口号拼接而成,如GE0/0/0、LoopBack1,接口类别为子接口时,由父接口名称、英文点、接口号拼接而成,如GE0/0/0.1、LoopBack1.1,单一主键字段。 "10GE0/0/0" ifm-class 否 string main-interface sub-interface - 接口类别,主接口或子接口。 "main-interface" type 否 string GigabitEthernet GEBrief 10GE LoopBack Eth-Trunk Tunnel Vlanif 25GE 40GE 100GE 400GE Vbdif Nve - 物理类型,AR6700V支持范围:GE、Nve、Vbdif、LoopBack。 "10GE" parent-if-name 否 string 1~63个字符。 - 父接口名称,当接口类别为子接口时配置。 "10GE0/0/0" number 否 string 1~63个字符。 - 接口号。物理类型为GE时,格式为A/B/C,其他物理类型时格式为数字。 "0/0/0" level 否 string L3 L2 - 接口类型,L2或L3,AR6700V仅支持L3。 "L3" vpn-instance 否 string 1~31个字符。 - 接口所属的VPN,当接口类型为L3时配置。GE口、Vbdif绑定的VPN互斥,Nve口仅能绑定GE口已经绑定的VPN。 "vpn1" admin-status 否 string down up - 接口的管理状态。该节点支持的能力因接口类型而异。 "down" description 否 string 1~242个字符。 - 接口描述。 "the interface for underlay" bandwidth 否 REFERENCE 详细请参见表6。 带宽配置。 - trunk 否 REFERENCE 详细请参见表7。 Eth-Trunk成员,AR6700V不支持。 - ethernet 否 REFERENCE 详细请参见表9。 接口物理属性,AR6700V不支持。 - 表6 bandwidth-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bandwidth 否 int64 [1-1000000] - 带宽Mbps。 20 bandwidth-kbps 否 int64 [1-1000000] - 带宽Kbps。AR6700V-L款型不支持。 20 表7 trunk-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 members 否 ARRAY_REFERENCE 详细请参见表8。 Eth-Trunk成员。 - 表8 trunk-members-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interface-name 否 string 1~63个字符。 - 接口名称,单一主键字段。 "10GE0/0/0" 表9 ethernet-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 negotiation-mode 否 string enabled disabled - 协商模式。 "enabled" combo-mode 否 string copper fiber - 接口工作模式。 "copper" duplex 否 string full half - 双工模式。 "full" speed 否 string 10M 100M 1000M 10G 25G 40G 100G 400G - 速率。 "1000M"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ifm:interface 表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 /controller/campus/rest/sdwan/v1/device/radius/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 { "ids" : ["fbb684c8-0d37-496f-bafa-4b06d515j7l6","fbb684c8-0d37-496f-bafa-4b06d515j7l7"] }
  • 响应参数 返回状态码为200:删除成功,响应体参考CommonResponse。 表3 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考DeviceRadiusDeleteResponse。 表4 DeviceRadiusDeleteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~255个字符。 - 错误描述。 "" processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 - 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部异常。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:删除成功,响应体参考CommonResponse。 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" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考DeviceRadiusDeleteResponse。 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 { "errcode" : "0", "errmsg" : "", "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的示例 POST /controller/campus/v1/sdwan/policy/commit 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 { "policyType" : "qos", "time" : "1676008846", "policyIds" : ["00000000-0000-0000-0000-000000000000"] }
  • 响应示例 返回状态码为200:配置成功,响应体参考ApplyPolicyResponse。 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" : "", "errparam" : "["policyName"]", "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/v3/networkconfig/device/switchradiomode 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 { "radioMode" : "5G", "siteId" : "aade1c5d-5b94-49e3-a912-48641015e45d", "deviceIdList" : ["fbde1c5d-5b94-49e3-a912-48641015e45c"] }
  • 响应示例 返回状态码为200:AP设备射频配置信息。 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 { "successList" : [ "" ], "failedList" : [ { "deviceId" : "", "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
  • 响应示例 返回状态码为201:成功创建的VLAN POOL模板信息。 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" : "fbde1c5d-5b94-49e3-a912-48641015e45c", "name" : "VLANPOOLTemplate1", "range" : "2-10,3001", "type" : "even" } } 返回状态码为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的示例 POST /v1/networkconfig/policy/profiles/vlanpools 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" : "VLANPOOLTemplate1", "range" : "2-10,3001", "type" : "even" }
  • 响应示例 返回状态码为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
共100000条
提示

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