华为云用户手册

  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/nat/dynamicnat-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 { "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "policyIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"] }
  • 响应示例 返回状态码为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" : "", "totalRecords" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "name" : "vpn_1", "description" : "Default", "vpnNameInDevice" : "vpn_1", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ], "overlayHeadLength" : 36, "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "ipsecEncryption" : true, "enableIPv6" : true, "defaultVpn" : true, "vpnIndex" : 0, "deleteStatus" : true } ] } 返回状态码为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 QueryVpnResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 每页显示数量。 20 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-8个列表项,详细请参见表6。 VPN信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/vpn?pageIndex=0&pageSize=20&sort=name&vpnId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&includeDefaultVpn=false&includeSite=false&vpnName=vpn Name 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:删除AP VPN配置成功,响应体参考DeleteApVpnResponseDto。 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" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "name" : "apvpn", "description" : "The VPN policy not exists." } ], "fail" : [ { "id" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "name" : "apvpn", "description" : "The VPN policy not exists." } ] } 返回状态码为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:删除AP VPN配置成功,响应体参考DeleteApVpnResponseDto。 表3 DeleteApVpnResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 删除AP VPN成功列表。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 删除AP VPN失败列表。 - 表4 ApVpnBaseInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 32个字符。 - VPNid。 "e4d2b0e95bb94ef0a75b6a530d0b41be" name string 1~94个字符。 - VPN名称。 "apvpn" description string 1~256个字符。 - 删除结果描述信息。 "The VPN policy not exists." 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误 详细信息请参见实际响应消息体。
  • 功能说明 NetStream是一种基于网络流信息的统计技术,可以对网络中的业务流量情况进行统计和分析。通过网络流量的精细化分析,识别企业中异常流量,并上报到NCE-CampusInsight,进行选路和QoS优化,提升业务体验。 通过以下模板完成NetStream功能的配置,配置流程如下: 步骤 功能配置 使用模板 Step1 配置灵活流统计模板 ConfigNetFlowTemplate模板。 Step2 配置NetStream基本功能 ConfigNetstream模板或ConfigAdvanceNetstream模板。 Step3 基于接口的NetStream流量统计 ConfigInterfaceNetstream模板或ConfigAdvanceInterfaceNetstream模板。
  • 参数说明 表1 ConfigNetFlowTemplate模板参数解释 参数名称 类型 取值范围 参数解释 operation String merge、remove 操作类型。 merge:表示增加。 remove:表示删除。 recordName String 1~20 配置灵活流统计模板名称,不支持空格,区分大小写,记录的名称不能含有“@”、“%”、“*”等特殊字符。 matchFieldBits String protocol、tos、source-address、destination-address、source-port、destination-port,其中的一个或者多个,以空格隔开填入 配置记录的IPv4聚合关键字。 collectFieldBits String bytes、packets、input、output、app-name,其中的一个或者多个,以空格隔开填入 配置流统计信息。 下发到设备的命令行: ip netstream record recordName match ipv4 { protocol | tos | source-address | destination-address | source-port | destination-port } collect application name collect counter { bytes | packets } collect interface { input | output } 表2 ConfigNetstream模板参数解释 参数名称 类型 取值范围 参数解释 OperationOfTimeout String merge、remove 操作类型,增加或者删除。 merge:表示增加。 remove:表示删除。 inactiveTimeout Int 10~600 非活跃流的老化时间,单位为秒。 activeTimeout Int 1~60 活跃流的老化时间,单位为分钟。 tmafter boolean false、true 使能在队列调度后进行NetStream采样功能。 OperationOfHost String merge、remove 操作类型,增加或者删除。 merge:表示增加。 remove:表示删除。 exportHostIp String - 指定IPv4流统计输出报文的目的IPv4地址。 exportHostPort Int 0~65535 指定IPv4流统计输出报文的目的UDP端口号。 exportVpnInstance String 设备上已经创建的VPN实例 指定统计输出报文目的IP所属的VPN实例名。 OperationOfSource String merge、remove 操作类型,增加或者删除。 merge:表示增加。 remove:表示删除。 exportSourceIp String - 指定IPv4流统计信息输出报文的源IPv4地址。 exportVersion Int 5、9、10 指定IPv4流统计信息输出报文的版本号。 exportIndex Int 16、32 指定接口索引的位数。 表3 ConfigAdvanceNetstream模板参数解释 参数名称 类型 取值范围 参数解释 OperationOfTimeout String merge、remove 操作类型,增加或者删除。 merge:表示增加。 remove:表示删除。 inactiveTimeout Int 10~600 非活跃流的老化时间,单位为秒。 activeTimeout Int 1~60 活跃流的老化时间,单位为分钟。 tmafter boolean false、true 使能在队列调度后进行NetStream采样功能。 OperationOfHost String merge、remove 操作类型,增加或者删除。 merge:表示增加。 remove:表示删除。 exportHostIp1 String - 该参数为必填项,指定IPv4流统计输出报文的目的IPv4地址。 exportHostIp2 String - 该参数为可选项,指定IPv4流统计输出报文的目的IPv4地址。 exportHostPort1 Int 0~65535 该参数为必填项,指定IPv4流统计输出报文的目的UDP端口号。 exportHostPort2 Int 0~65535 该参数为可选项,指定IPv4流统计输出报文的目的UDP端口号。 exportVpnInstance1 String 设备上已经创建的VPN实例 指定统计输出报文目的IP所属的VPN实例名。 exportVpnInstance2 String 设备上已经创建的VPN实例 指定统计输出报文目的IP所属的VPN实例名。 OperationOfSource String merge、remove 操作类型,增加或者删除。 merge:表示增加。 remove:表示删除。 exportSourceIp String - 指定IPv4流统计信息输出报文的源IPv4地址。 exportVersion Int 5、9、10 指定IPv4流统计信息输出报文的版本号。 exportIndex Int 16、32 指定接口索引的位数。 选择ConfigNetstream模板下发到设备的命令行: ip netstream timeout inactive inactiveTimeout ip netstream timeout active activeTimeout ip netstream tm-after enable ip netstream export host exportHostIp exportHostPort vpn-instance exportVpnInstance ip netstream export source exportSourceIp ip netstream export version exportVersion ip netstream export index-switch exportIndex 选择ConfigAdvanceNetstream模板下发到设备的命令行: ip netstream timeout inactive inactiveTimeout ip netstream timeout active activeTimeout ip netstream tm-after enable ip netstream export host exportHostIp1 exportHostPort1 vpn-instance exportVpnInstance1 ip netstream export host exportHostIp2 exportHostPort2 vpn-instance exportVpnInstance2 //可选 ip netstream export source exportSourceIp ip netstream export version exportVersion ip netstream export index-switch exportIndex 表4 ConfigInterfaceNetstream模板参数解释 参数名称 类型 取值范围 参数解释 interfaceName String - Lan侧接口名称,支持如下接口类型: Ethernet:例如:Ethernet0/0/1。 GigabitEthernet,例如:GigabitEthernet0/0/1。 XGigabitEthernet,例如:XGigabitEthernet0/0/1。 Eth-Trunk,例如Eth-Trunk10。 Ethernet子接口:例如:Ethernet0/0/1.10。 GigabitEthernet子接口,例如:GigabitEthernet0/0/1.10。 XGigabitEthernet子接口,例如:XGigabitEthernet0/0/1.10。 Eth-Trunk子接口,例如Eth-Trunk10.10。 VLANIF接口:例如Vlanif10。 operation String merge、remove 对IPv4流量统计功能的操作类型: merge:表示增加IPv4流量统计方向。 remove:表示删除IPv4流量统计方向。 direction String inbound、outbound 配置IPv4流量统计功能的方向。 fixPackets Int 1~65535 固定报文间隔采样的间隔报文的数量。 OperationOfRule String merge、remove 在接口下配置NetStream流量策略的操作类型: merge:表示在接口下增加NetStream策略。 remove:表示删除接口下的NetStream流量策略。 recordName String 1~20 设备上已经创建的灵活流统计模板名称。 表5 ConfigAdvanceInterfaceNetstream模板参数解释 参数名称 类型 取值范围 参数解释 interfaceName String - Lan侧接口名称, 支持如下接口类型: Ethernet:例如:Ethernet0/0/1。 GigabitEthernet,例如:GigabitEthernet0/0/1。 XGigabitEthernet,例如:XGigabitEthernet0/0/1。 Eth-Trunk,例如Eth-Trunk10。 Ethernet子接口:例如:Ethernet0/0/1.10。 GigabitEthernet子接口,例如:GigabitEthernet0/0/1.10。 XGigabitEthernet子接口,例如:XGigabitEthernet0/0/1.10。 Eth-Trunk子接口,例如Eth-Trunk10.10。 VLANIF接口:例如Vlanif10。 operation String merge、remove 对IPv4流量统计功能的操作类型: merge:表示增加IPv4流量统计方向。 remove:表示删除IPv4流量统计方向。 direction1 String inbound、outbound 该参数为必填项,配置IPv4流量统计功能的方向。 direction2 String inbound、outbound 该参数为可选项,配置IPv4流量统计功能的方向。 fixPackets1 Int 1~65535 该参数为必填项,固定报文间隔采样的间隔报文的数量。 fixPackets2 Int 1~65535 该参数为可选项,固定报文间隔采样的间隔报文的数量。 OperationOfRule String merge、remove 在接口下配置NetStream流量策略的操作类型: merge:表示在接口下增加NetStream策略。 remove:表示删除接口下的NetStream流量策略。 recordName String 1~20 该参数为可选项,设备上已经创建的灵活流统计模板名称。 选择ConfigInterfaceNetstream模板下发到设备的命令行: interface interface-type interface-number ip netstream sampler fix-packets fixPackets direction ip netstream direction port ip netstream record recordName 选择ConfigAdvanceInterfaceNetstream模板下发到设备的命令行: interface interface-type interface-number ip netstream sampler fix-packets fixPackets1 direction1 ip netstream sampler fix-packets fixPackets2 direction2 //可选 ip netstream direction1 ip netstream direction2 //可选 port ip netstream record recordName
  • 配置NAT功能缺省模板(仅V600版本AR设备) 表1 ConfigInterfaceNatEnable模板参数解释 参数名称 类型 取值范围 参数解释 name String 接口名称。仅GE口、10GE口和Cellular口支持该配置且必须为L3层口。 在接口上配置NAT功能。 此字段创建后不可修改,修改此参数将导致配置下发失败。 nat_enable Boolean 布尔型,具体取值如下: true。 false。 使能/去使能NAT功能。 下发到设备的命令: interface name nat enable 父主题: iMaster NCE-Campus内置缺省模板参数介绍
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/overlay-network/iwg-interworking 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 { "iwgPolicyInfos" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 1 } ] }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考IwgPolicyResponse。 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 1 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 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的示例 POST /restconf/operations/huawei-nce-aoc-config-template:copy-template 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-nce-aoc-config-template:input" : { "template-name" : "test", "template-description" : "test", "source-template-id" : "26559bd3-a00e-4c6d-a573-e6b711a897b3" } }
  • 响应参数 返回状态码为200:Successful operation 表4 copy-template-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:output REFERENCE 详细请参见表5。 - - 表5 copy-template-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 template-id string 1~128个字节。 - 模板ID "26559bd3-a00e-4c6d-a573-e6b711a897b3" 返回状态码为400:Bad Request 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为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:output": { "template-id": "0a498390-b8c8-4141-9e94-f3de9553ebe2" } } 返回状态码为400:Bad Request HTTP/1.1 400 Bad Request Date: Thu,05 Jan 2023 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 copy-template 是 REFERENCE 详细请参见表2。 复制模板 - 表2 copy-template-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-aoc-config-template:input REFERENCE 详细请参见表3。 - - 表3 copy-template-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 template-name 是 string 0~128个字节。 - 模板名称 "test" template-description 否 string 0~1024个字节。 - 模板描述 "test" source-template-id 否 string 1~128个字节。 - 源模板 "26559bd3-a00e-4c6d-a573-e6b711a897b3"
  • 响应示例 返回状态码为200:正常响应返回体,返回的设备QoS带宽统计开销设置信息中仅包含对应的deviceId。 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" : [ { "deviceId" : "00000000-0000-0000-0000-00000000000", "qosOverHead" : "link" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid", "data" : { "deviceId" : "00000000-0000-0000-0000-00000000000", "qosOverHead" : "link" } } ], "processInstanceId" : "" } 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考QosDeviceResponse。 HTTP/1.1 202 Accepted 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 返回状态码为204:删除成功,响应体参考QosDeviceResponse。 HTTP/1.1 204 No Content 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:正常响应返回体,返回的设备QoS带宽统计开销设置信息中仅包含对应的deviceId。 QosDeviceResponse对象的参数列表,详细请参见表4。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考QosDeviceResponse。 返回状态码为204:删除成功,响应体参考QosDeviceResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/device/qos/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 { "deviceIds" : [ "00000000-0000-0000-0000-00000000000" ] }
  • 响应示例 返回状态码为200:修改成功,返回信息,结构体参见deleteLocalUserInfoResponse。 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" : "" }
  • 请求示例 HTTP的示例 DELETE /controller/campus/v1/networkservice/networkconfig/net/localuser/site-templates/fbb684c8-0d37-496f-bafa-4b06d5151e2e/users/test 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/localuser/site-templates/{siteTemplateId}/users/{username} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string - - 站点模板ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" username 是 string 0~64个字符。 - 本地用户名,在URL中拼接用户名时,要对特殊字符转义。 "test"
  • 响应示例 返回状态码为200:成功修改RADIUS服务器模板信息。 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" : { "name" : "radius1", "description" : "radius1", "multipleBackupServerConfig" : true, "radiusServerType" : "thirdPartyServer", "iaeDtoList" : [ { "iaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "iaeName" : "iae12", "iaeIp" : "192.168.1.1", "iaeAd" : "example.com", "iaeIpv6" : "FC00::0", "weight" : 80, "slaveIaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "slaveIaeName" : "iae12", "slaveIaeIp" : "192.168.1.1", "slaveIaeAd" : "example.com", "slaveIaeIpv6" : "FC00::0" } ], "authServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "accountServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "masterAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "masterAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "realtimeAccounting" : { "realtimeEnable" : true, "realtimeInterval" : 10 }, "serverSelectionPolicy" : "master-backup", "serverSelectionAlgorithm" : "packets", "dpskConfig" : { "supportDpsk" : true, "dpskEncryptionMode" : "aes256gcm" }, "prohibitAttribute" : { "enable" : true, "attributes" : [ { "attributeName" : "HW-Input-Peak-Information-Rate", "prohibitReceive" : true, "prohibitSend" : true } ] }, "radiusAttributeConfig" : { "enable" : true, "attributes" : [ { "attributeName" : "Service-Type", "attributeValue" : "241", "optionValue" : "auth-type-mac", "macValue" : "10", "dot1xValue" : "2", "portalValue" : "4" } ] }, "calledStationId" : { "enable" : true, "attributeValue" : "ap-mac", "includeSsid" : true, "delimiter" : "+" }, "macFormatSetting" : { "macFormat" : true, "letter" : "uppercase", "connector" : "hyphen-split", "mode" : "XX" }, "enableAutomaticServerStatusDetection" : true, "automaticServerStatusDetection" : { "name" : "test", "password" : "null", "upServerInterval" : "" }, "enableAuthRequestRetransmitConfig" : true, "authRequestRetransmitConfig" : { "timeoutRetransmissionTimes" : 3, "timeoutInterval" : 5, "serverDownDuration" : 5 }, "sourceIpEnable" : true, "nassPortIdFormat" : "new", "translateExtendList" : [ { "accessAccept" : true, "accountResponse" : false, "srcVendorId" : 9, "srcSubId" : 2, "destAttributeName" : "HW-Input-Committed-Burst-Size" } ], "startAccountingFail" : true, "configName" : "abc", "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e" } } 返回状态码为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:成功修改RADIUS服务器模板信息。 表4 UpdateRadiusTempResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表22。 RADIUS模板返回结构体 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/profile/radius/fbb684c8-0d37-496f-bafa-4b06db151e2e 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" : "radius1", "description" : "radius1", "multipleBackupServerConfig" : true, "radiusServerType" : "thirdPartyServer", "iaeDtoList" : [ { "iaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "iaeName" : "iae12", "iaeIp" : "192.168.1.1", "iaeAd" : "example.com", "iaeIpv6" : "FC00::0", "weight" : 80, "slaveIaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "slaveIaeName" : "iae12", "slaveIaeIp" : "192.168.1.1", "slaveIaeAd" : "example.com", "slaveIaeIpv6" : "FC00::0" } ], "authServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "accountServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "masterAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "masterAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "realtimeAccounting" : { "realtimeEnable" : true, "realtimeInterval" : 10 }, "serverSelectionPolicy" : "master-backup", "serverSelectionAlgorithm" : "packets", "dpskConfig" : { "supportDpsk" : true, "dpskEncryptionMode" : "aes256gcm" }, "prohibitAttribute" : { "enable" : true, "attributes" : [ { "attributeName" : "HW-Input-Peak-Information-Rate", "prohibitReceive" : true, "prohibitSend" : true } ] }, "radiusAttributeConfig" : { "enable" : true, "attributes" : [ { "attributeName" : "Service-Type", "attributeValue" : "241", "optionValue" : "auth-type-mac", "macValue" : "10", "dot1xValue" : "2", "portalValue" : "4" } ] }, "calledStationId" : { "enable" : true, "attributeValue" : "ap-mac", "includeSsid" : true, "delimiter" : "+" }, "macFormatSetting" : { "macFormat" : true, "letter" : "uppercase", "connector" : "hyphen-split", "mode" : "XX" }, "enableAutomaticServerStatusDetection" : true, "automaticServerStatusDetection" : { "name" : "test", "password" : "null", "upServerInterval" : "" }, "enableAuthRequestRetransmitConfig" : true, "authRequestRetransmitConfig" : { "timeoutRetransmissionTimes" : 3, "timeoutInterval" : 5, "serverDownDuration" : 5 }, "sourceIpEnable" : true, "nassPortIdFormat" : "new", "translateExtendList" : [ { "accessAccept" : true, "accountResponse" : false, "srcVendorId" : 9, "srcSubId" : 2, "destAttributeName" : "HW-Input-Committed-Burst-Size" } ], "startAccountingFail" : true, "configName" : "abc", "shareKey" : "null" }
  • 请求示例 HTTP的示例 DELETE /controller/campus/api/v1/devices/lldp/scan/task/ee4d21b7-27cf-4b2e-af7a-8231a31152c0 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:删除发现任务响应成功,响应体参考DeleteLldpCollectTaskResp。 表2 DeleteLldpCollectTaskResp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码 - errmsg string - - 错误信息 - 返回状态码为400:接口参数校验异常,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:删除发现任务响应成功,响应体参考DeleteLldpCollectTaskResp。 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" : "", "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
  • 响应示例 返回状态码为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
  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-static-routing-ipv4:static-routing-ipv4 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-static-routing-ipv4:static-routing-ipv4" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "destination-prefix" : "10.1.1.0/24", "vpn-instance" : "vpn1", "next-hop-type" : "Ip", "next-hop-addresses" : [ { "address" : "10.1.1.1", "preference" : 10, "track-setting" : "nqa", "nqa" : "test", "bfd-enable" : true } ], "next-hop-interfaces" : [ { "interface" : "GE0/0/1", "preference" : 10, "dhcp-enable" : true, "track-setting" : "nqa", "nqa" : "test" } ], "next-hop-interface-addresses" : [ { "address" : "10.1.1.1", "interface" : "GE0/0/1", "preference" : 10, "track-setting" : "nqa", "nqa" : "test", "bfd-enable" : true } ] } ] }
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-static-routing-ipv4:static-routing-ipv4 表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"
共99354条