华为云用户手册

响应示例 返回状态码为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：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考Dot1xTemplateDeleteResponse。 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

响应示例 返回状态码为201：接口调用成功，响应体参考OspfRouteInterfaceParamResponse，返回的OSPF路由信息中仅包含对应的ID。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "processId" : 501, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "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, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ] } ], "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", "processId" : 501, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "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, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ] } } ] } 返回状态码为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参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ospfRouteInterfaceParamInfos 是 REFERENCE 详细请参见表2。 OSPF路由接口信息。 - 表2 OspfRouteInterfaceParamInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 interfaceParams 否 ARRAY_REFERENCE 1-8个列表项，详细请参见表3。 Ospf路由接口参数信息。 - 表3 OspfRouteInterfaceParamInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 对应站点ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId 是 uuid - - 设备ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId 否 uuid - - 所在VPN ID。格式是uuid，创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId 否 uuid - - 所在TNP ID。格式是uuid，创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" processId 是 int32 [1-65535] - 接口需要绑定的ospf进程id 501 ipSubnets 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表13。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts 否 ARRAY_REFERENCE 0-64个列表项，详细请参见表13。 TNP接口参数。创建underlay ospf时必填。 -

响应参数 返回状态码为201：接口调用成功，响应体参考OspfRouteInterfaceParamResponse，返回的OSPF路由信息中仅包含对应的ID。 表4 OspfRouteInterfaceParamResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-8个列表项，详细请参见表5。 创建或者更新成功的OSPF路由全局进程信息。 - fail ARRAY_REFERENCE 0-8个列表项，详细请参见表6。 创建或者更新失败的OSPF路由全局进程信息。 - 表5 OspfRouteInterfaceParamInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 对应站点ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceId uuid - - 设备ID。格式是uuid，创建时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" vpnId uuid - - 所在VPN ID。格式是uuid，创建overlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" tnpId uuid - - 所在TNP ID。格式是uuid，创建underlay ospf路由时必填。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" processId int32 [1-65535] - 接口需要绑定的ospf进程id 501 ipSubnets ARRAY_REFERENCE 0-64个列表项，详细请参见表25。 三层接口参数。创建overlay ospf时必填。 - transportNetworkPorts ARRAY_REFERENCE 0-64个列表项，详细请参见表25。 TNP接口参数。创建underlay ospf时必填。 - 表6 FailOspfRouteInterfaceParamInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 OSPF路由接口信息 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/routing-protocol/ospf/interface-param 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 { "interfaceParams" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "processId" : 501, "ipSubnets" : [ { "interfaceType" : "tunnel", "interfaceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "areaId" : "0", "areaType" : "normal", "authMode" : "none", "cryptographicSuit" : "hmac-sha256", "key" : 1, "cryptographicPwd" : "1", "helloTimer" : 1, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "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, "timerPoll" : 1, "timerRetransmit" : 1, "timerDead" : 1, "mtuEnable" : false, "networkType" : "broadcast", "cost" : 1, "drPriority" : 1 } ] } ] }

请求示例 HTTP的示例 POST /controller/campus/v1/accountservice/mac/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 { "ids" : ["fb9317cf-fdb6-40fe-821f-3c20fc6a63eb"] }

响应示例 返回状态码为200：删除成功，响应体参考DeleteMacsOutput。 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 { "errorCode" : "", "errorMessage" : "", "deleteNameList" : ["name"], "failList" : [ { "errcode" : "0308000221", "errmsg" : "The selected user does not exist", "id" : "51cdcbe3-5e14-492b-ab27-86950b661d19", "name" : "mac1" } ] } 返回状态码为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：修改成功，响应体参考CustomApplicationResponse。 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" : "", "success" : [ { "id" : "00000000-0000-0000-0000-000000000000", "appName" : "app", "description" : "", "extendApp" : false, "appType" : "", "appGroups" : [ "00000000-0000-0000-0000-000000000000" ], "applicationGroups" : [ { "applicationGroupName" : "", "applicationGroupId" : "" } ], "applicationRules" : [ { "ruleName" : "rule", "ruleId" : "00000000-0000-0000-0000-000000000000", "description" : "tcpRule", "destinationIP" : "10.1.1.1/32", "port" : "1,2,3-20", "protocolType" : "tcp", "signatureEnable" : false, "context" : "flow", "direction" : "request", "plainString" : "abcde", "dscp" : 20, "domain" : "www.example.com", "sourceIp" : "192.168.10.5/32", "sourcePortRange" : "30-50" } ], "configId" : "00000000-0000-0000-0000-000000000000" } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "appName" : "app", "description" : "", "extendApp" : false, "appType" : "", "appGroups" : [ "00000000-0000-0000-0000-000000000000" ], "applicationGroups" : [ { "applicationGroupName" : "", "applicationGroupId" : "" } ], "applicationRules" : [ { "ruleName" : "rule", "ruleId" : "00000000-0000-0000-0000-000000000000", "description" : "tcpRule", "destinationIP" : "10.1.1.1/32", "port" : "1,2,3-20", "protocolType" : "tcp", "signatureEnable" : false, "context" : "flow", "direction" : "request", "plainString" : "abcde", "dscp" : 20, "domain" : "www.example.com", "sourceIp" : "192.168.10.5/32", "sourcePortRange" : "30-50" } ], "configId" : "00000000-0000-0000-0000-000000000000" } } ] } 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考CustomApplicationResponse。 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：修改成功，响应体参考CustomApplicationResponse。 CustomApplicationResponse对象的参数列表，详细请参见表6。 返回状态码为202：请求正在处理中，请求处理详情请通过“查询业务编排结果”接口，确认是否处理成功。响应体参考CustomApplicationResponse。 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/application/custom-applications 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 { "customApplications" : [ { "id" : "00000000-0000-0000-0000-000000000000", "appName" : "app", "description" : "", "extendApp" : false, "appType" : "", "appGroups" : [ "00000000-0000-0000-0000-000000000000" ], "applicationGroups" : [ { "applicationGroupName" : "", "applicationGroupId" : "" } ], "applicationRules" : [ { "ruleName" : "rule", "ruleId" : "00000000-0000-0000-0000-000000000000", "description" : "tcpRule", "destinationIP" : "10.1.1.1/32", "port" : "1,2,3-20", "protocolType" : "tcp", "signatureEnable" : false, "context" : "flow", "direction" : "request", "plainString" : "abcde", "dscp" : 20, "domain" : "www.example.com", "sourceIp" : "192.168.10.5/32", "sourcePortRange" : "30-50" } ], "configId" : "00000000-0000-0000-0000-000000000000" } ] }

响应示例 返回状态码为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 { "huawei-nce-e-arp:arp" : { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "static-arp" : [ { "ip-addr" : "10.1.1.1", "vpn-instance" : "_public_", "mac-addr" : "xxxx-xxxx-xxxx", "vxlan-id" : 233, "source-addr" : "10.1.1.2", "peer-addr" : "10.1.1.3" } ], "speed-limit" : [ { "slot-id" : "23", "suppress-type" : "arp", "ip-type" : "dest-ip", "suppress-value" : 2333 } ] } } 返回状态码为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 /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-arp:arp 表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 arp-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-arp:arp REFERENCE 详细请参见表4。 ARP配置。 - 表4 arp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 config-status string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态，对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态；不支持编辑，仅查询返回。 "configured-database-success" last-committed-time string 0~255个字符。 - 最后提交时间，该特性最后提交时间；不支持编辑，仅查询返回。 "2022-01-01 00:00:00" related-pkg-version string 0~255个字符。 - 包版本，插件包版本；不支持编辑，仅查询返回。 "1.0.1" edit-state string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态，对应运行状态、候选状态、取消部署状态、未部署状态；不支持编辑，仅查询返回。 "RUNNING" static-arp ARRAY_REFERENCE 详细请参见表5。 静态ARP。 - speed-limit ARRAY_REFERENCE 详细请参见表6。 配置接口板抑制ARP消息的时间戳抑制速率。 - 表5 arp-static-arp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ip-addr string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - IPv4地址，联合主键字段。 "10.1.1.1" vpn-instance string 1~31个字符。 _public_ VPN实例，联合主键字段。 "_public_" mac-addr string 0~255个字符。满足正则表达[0-9a-f]{4}(-[0-9a-f]{4}){2}。 - MAC地址。 "xxxx-xxxx-xxxx" vxlan-id int64 [1-16777215] - VxLAN ID。 233 source-addr string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 本端地址。 "10.1.1.2" peer-addr string 满足正则表达(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\p{N}\p{L}]+)?。 - 对端地址。 "10.1.1.3" 表6 arp-speed-limit对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 slot-id string 1~24个字符。 - 槽位号，联合主键字段。 "23" suppress-type string arp arp-miss - 抑制类型，联合主键字段。 "arp" ip-type string dest-ip src-ip - IP类型，联合主键字段。 "dest-ip" suppress-value int64 [0-65536] - 限速值。 2333 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-arp:arp 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"

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/globalparam/tenant/1d27faea37f3410992e98c9761b25b9d/cliauth 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 { "cliAuthEnable" : "true" }

响应示例 返回状态码为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" : { "cliAuthEnable" : "true" } }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 body 是 REFERENCE 详细请参见表3。 设备本地CLI配置授权信息。 - 表3 CliAuthInfoDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 cliAuthEnable 是 boolean true false true 设备本地CLI配置授权开关。默认值为true。 "true"

URI /controller/campus/v1/networkservice/networkconfig/net/globalparam/tenant/{tenantId}/cliauth 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tenantId 是 string - - 租户ID。 "1d27faea37f3410992e98c9761b25b9d"

响应参数 返回状态码为200：查询成功，响应体参考QueryDeviceVTYResponse。 表2 QueryDeviceVTYResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2000个列表项，详细请参见表4。 - - pageIndex int32 [1-10000] - 当前页。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400：请求参数错误，响应体参考CommonResponse。 CommonResponse对象的参数列表，详细请参见表5。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/vty/global?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=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：查询成功，响应体参考QueryDeviceVTYResponse。 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 { "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationModel" : "aaa", "idleTimeOutMinutes" : "", "idleTimeOutSeconds" : "", "inboundACLNum" : 2100, "outboundACLNum" : 2100, "inboundACL6Num" : 2100, "outboundACL6Num" : 2100 } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100 } 返回状态码为400：请求参数错误，响应体参考CommonResponse。 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 { "errCode" : "0", "errMsg" : "" } 返回状态码为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/vty/global 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-10000] 1 起始页。默认值为1。 1 pageSize 否 int32 [1-100] 10 页行记录数。默认值为10。 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备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-ifm:interface/10GE0%2F0%2F0 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"

接口约束 该接口支持msp视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V和AR6700V子设备； 或者支持租户视图或msp代维视图下，角色为“Open Api Operator”的用户访问，必须在用户会话建立后使用，且仅支持AR6700V-L款型和V600系列设备。 该API可能会直接或间接影响现网业务运行，导致业务中断、关键数据丢失等，请谨慎操作！

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-ifm:interface/{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" name 是 string 1~63个字符。 - 接口名称。名称规则：接口类别为主接口时，由物理类型、接口号拼接而成，如GE0/0/0、LoopBack1，接口类别为子接口时，由父接口名称、英文点、接口号拼接而成，如GE0/0/0.1、LoopBack1.1，单一主键字段。 "10GE0/0/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

响应示例 返回状态码为200：接口调用成功，响应体参考BgpRoutePublicPeerResponse。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "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 } } ] }, "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 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ], "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "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 } } ] }, "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 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ], "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } } ] } 返回状态码为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/v1/sdwan/routing-protocol/bgp-public-info 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 { "peerInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "peers" : [ { "peerIp" : "10.0.0.1", "localIp" : "10.0.0.1", "peerAs" : "10", "localAs" : "10", "allowAsLoop" : 1, "ebgpMaxHop" : 1, "peerIgnore" : false, "keepAliveTime" : 0, "holdTime" : 0, "md5Encrypt" : false, "md5Key" : "", "keyChainEnable" : false, "keyChainName" : "keyChainName", "bfdEnable" : false, "bfdInfo" : { "minTxInterval" : 1000, "minRxInterval" : 1000, "detectMultiplier" : 3 }, "vpnv4Enable" : true, "addressFamilys" : [ { "familyType" : "ipv4-unicast", "advertiseCommunity" : false, "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 } } ] }, "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 } } ] } } ], "vpnv6Enable" : true, "configSource" : "Wan", "nextHopInvariable" : true } ], "addressFamilyGlobals" : [ { "familyType" : "ipv4-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : true, "routeRedistribution" : [ "direct" ], "aggregationRoute" : [ "192.168.10.0/24" ] } ] } ] }

响应参数 返回状态码为200： 表3 DeleteResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~128个字符。 - 错误码 "0" errmsg string 1~512个字符。 - 错误信息 - data ARRAY_REFERENCE 详细请参见表4。 删除成功列表。 - 表4 DeleteResultInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 32~36个字符。 - 删除ID。 "60e2e8a3cdf3470ea4d4f468c8b74095"

响应示例 返回状态码为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" : [ { "id" : "60e2e8a3cdf3470ea4d4f468c8b74095" } ] }