华为云用户手册

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 topologyInfo 是 REFERENCE 详细请参见表3。 需创建的拓扑。 - 表3 TopologyInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 areas 否 ARRAY_REFERENCE 1个列表项，详细请参见表4。 按区域指定站点拓扑。当前仅支持一次操作一个Area。 - 表4 AreaInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 区域ID，UUID格式，创建区域时不填，更新时必填。仅在bgp-evpn模式下使用。 "00000000-0000-0000-0000-000000000000" name 否 string 1~32个字符。 - 区 域名 称，创建时必填。“default”、“backbone”为预留名称，不允许使用。 "area_1" areaType 否 string 1~32个字符。 backbone 区域类型。取值范围：leaf、backbone。leaf：叶子区域，backbone：骨干区域。用户调用API创建的区域只能是leaf类型，backbone区域是由开启互联的区域的border站点自动形成的。创建时必填。 "leaf" topologyType 否 string - full-mesh 区域拓扑类型。取值范围：full-mesh、hub-spoke。full-mesh：全网类型，hub-spoke：枢纽类型。创建时必填。 "hub-spoke" enableDynamicTunnel 否 boolean true false false full-mesh模式下是否使能spoke站点间动态隧道功能。 - gatewayIPv6Enable 否 boolean true false false gateway角色是否使能IPv6协议，只对加入站点中的gateway角色生效。只有区域所在VPN使能IPv6后才能开启。区域中如果存在gateway角色的站点，不能去使能gatewayIPv6Enable开关。 false hubWorkMode 否 string 1~32个字符。 with-interconnection 工作模式。取值范围：with-interconnection、without-interconnection。with-interconnection：互联，without-interconnection：无互联。 "with-interconnection" isFullReplaceSite 否 boolean true false false 是否全量替换站点，仅在更新接口有效。true表示将以siteAttachments为准，全量更新区域内站点。为空或者false兼容之前规则，表示仅更新siteAttachments指定站点，区域内其他站点不变。 - siteAttachments 否 ARRAY_REFERENCE 1-3000个列表项，详细请参见表5。 区域下的站点列表。 - 表5 SiteAttachmentInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" siteName 否 string - - 站点名称。 "Site Name" siteRoles 是 ARRAY_REFERENCE 1-4个列表项，详细请参见表6。 站点承担的角色。一个站点可以同时承担多个角色，每个角色可以单独设置主备。 在EVPN场景下，站点角色可能存在如下组合： 1、当topologyType为full-mesh时，站点必须承担spoke角色，除了spoke角色，站点还可以同时是逃生站点intermediate，也可以同时是边缘站点border； 2、当topologyType为hub-spoke时，如果一个站点是hub站点，那么这个站点还可以同时是边缘站点border；如果一个站点是spoke角色，那么这个站点不可以同时承担其他角色。 [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}] accessServiceHubs 否 ARRAY_REFERENCE 0-16个列表项，详细请参见表7。 分支站点接入的业务HUB列表，分支互访时必须接入hub角色站点；原hub-spoke场景不可配置，多HUB场景必配。 - borderRelationShip 否 REFERENCE 详细请参见表8。 设置分支站点的主备边缘站点，在full-mesh模式下开启区域互连时有效 - enableHubLanConnect 否 boolean true false false 是否开启HUB站点的LAN侧互通。 - 表6 siteRole对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 role 否 string 1~32个字符。 - 一个区域中的站点角色。取值范围为：hub、spoke、intermediate、border、gateway、serviceHub。 hub：主节点，spoke：子节点，intermediate：逃生节点，border：边缘节点，gateway：互访网关节点，serviceHub：业务HUB。 hub-spoke模式的拓扑中，当主备hub角色的两个站点同时存在时，必须同时配置或不配置serviceHub的角色。 同时配置serviceHub角色时，主hub的优先级要小于备hub。优先级为active或standby的hub站点只能各配置一个。 gateway角色的站点只能为单网关站点。V600系列设备不支持配置gateway角色。 "hub" sitePriority 否 string 1~32个字符。 active 站点优先级。原hub-spoke场景，无serviceHub角色，hub优先级取值active/standby。 多HUB场景，serviceHub角色站点优先级取值范围1-16，hub角色站点优先级active/standby。 spoke角色的站点的优先级为active。 "active" 表7 AccessHubInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteName 否 string - - 站点名称 - siteId 否 uuid - - 站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" accessPriority 否 uint8 [1-16] 1 优先级 2 表8 BorderRelationShip对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 activeBorderSiteId 是 uuid - - 主边缘站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" activeBorderSiteName 否 string - - 主边缘站点名称。 "Site Name" standbyBorderSiteId 否 uuid - - 备边缘站点ID，UUID格式。 "00000000-0000-0000-0000-000000000000" standbyBorderSiteName 否 string - - 备边缘站点名称。 "Site Name"

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

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dns:dns 表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：操作成功。 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

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

请求示例 HTTP的示例 PATCH /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" { "huawei-nce-e-arp:arp" : { "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 } ] } }

响应示例 返回状态码为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

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-arp:arp 是 REFERENCE 详细请参见表4。 ARP配置。 - 表4 arp-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-arp:arp 否 REFERENCE 详细请参见表5。 ARP配置。 - 表5 arp-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 static-arp 否 ARRAY_REFERENCE 详细请参见表6。 静态ARP。 - speed-limit 否 ARRAY_REFERENCE 详细请参见表7。 配置接口板抑制ARP消息的时间戳抑制速率。 - 表6 arp-static-arp-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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个字符。 - 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" 表7 arp-speed-limit-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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

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：删除成功，响应体参考DeleteNetstreamInterfaceRecordResponse。 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" : { "ifName" : "GE0/0/0", "recordName" : "record1" } } 返回状态码为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/ifName/applyFlexflowRecord/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 { "ifName" : "GE0/0/0", "recordName" : "record1" }

响应参数 返回状态码为200：删除成功，响应体参考DeleteNetstreamInterfaceRecordResponse。 表4 DeleteNetstreamInterfaceRecordResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 - - 表5 DelInterfaceRecordInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ifName string 1~63个字符。 - 接口名称。 "GE0/0/0" recordName string 1~32个字符。满足正则表达([^?"']{1,32})|("[^?"']{1,30}")|('[^?"']{1,30}')。 - 灵活流模板名。 "record1" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

URI /controller/campus/v1/sdwan/netstream/{deviceId}/interface/ifName/applyFlexflowRecord/delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 0~36个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000"

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 delInterfaceRecordInfo 是 REFERENCE 详细请参见表3。 删除接口采样使能信息 - 表3 DelInterfaceRecordInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ifName 是 string 1~63个字符。 - 接口名称。 "GE0/0/0" recordName 是 string 1~32个字符。满足正则表达([^?"']{1,32})|("[^?"']{1,30}")|('[^?"']{1,30}')。 - 灵活流模板名。 "record1"

响应示例 返回状态码为200：删除成功，响应体参考DeleteDeviceInterfaceResponse。 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" : { "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GigabitEthernet0/0/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

响应参数 返回状态码为200：删除成功，响应体参考DeleteDeviceInterfaceResponse。 表3 DeleteDeviceInterfaceResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码0表示成功，否则为失败。 "0" errmsg string 0~512个字符。 - 错误信息。 "" data REFERENCE 详细请参见表4。 删除设备接口返回实体。 - 表4 DeleteDeviceInterfaceResponseVo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 0~64个字符。 - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" interfaceName string 0~64个字符。 - 设备接口名称。 "GigabitEthernet0/0/0" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误。 详细信息请参见实际响应消息体。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deleteDeviceInterfaceRequestParam 是 REFERENCE 详细请参见表2。 执行删除操作的参数。 - 表2 DeleteDeviceInterfaceRequestParam对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 0~64个字符。 - 设备ID，UUID格式。 "00000000-0000-0000-0000-000000000000" interfaceName 是 string 0~128个字符。 - 设备接口名称。 "GigabitEthernet0/0/0"

请求示例 HTTP的示例 DELETE /controller/campus/v1/networkservice/networkconfig/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 { "deviceId" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GigabitEthernet0/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 { "errcode" : "0", "errmsg" : "" }

请求示例 HTTP的示例 POST /controller/campus/v1/networkconfigservice/deploy/devices/fbde1c5d-5b94-49e3-a912-48641015e45c/redeploy 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

请求示例 HTTP的示例 POST /v1/networkservice/hierarchy-template/template-groups/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 { "deleteIds" : ["00000000-0000-0000-0000-000000000000"], "delBindProperties" : false }

响应参数 返回状态码为200：Success。 表3 BatchOperateTemplateGroupResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码，0：请求成功。 "0" errmsg string 0~256个字符。 - 错误信息。 "error" data ARRAY_REFERENCE 0-20个列表项，详细请参见表4。 操作成功的Id集，结构体参见BatchOperateTemplateGroupItem。 - 表4 BatchOperateTemplateGroupItem对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 Id string 36个字符。 - Id，uuid格式。 - 返回状态码为400：校验异常。 CommonDto对象的参数列表，详细请参见表4。 返回状态码为500：内部服务错误。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：Success。 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" : "error", "data" : [ { "Id" : "" } ] } 返回状态码为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 { "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

响应示例 返回状态码为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的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:dhcpv4-if/GE0%2F0%2F2 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000"

URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:dhcpv4-if/{if-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" if-name 是 string 1~63个字符。 - interface name "GE0/0/2"

响应示例 返回状态码为200：配置成功，响应体参考DeviceVTYResponse。 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" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationModel" : "aaa", "idleTimeOutMinutes" : "", "idleTimeOutSeconds" : "", "inboundACLNum" : 2100, "outboundACLNum" : 2100, "inboundACL6Num" : 2100, "outboundACL6Num" : 2100 } } 返回状态码为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

响应参数 返回状态码为200：配置成功，响应体参考DeviceVTYResponse。 表3 DeviceVTYResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表4。 - - 表4 DeviceVTYInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid - - 站点的ID。 "00000000-0000-0000-0000-000000000000" deviceId uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" authenticationModel string aaa password - 认证模式，取值范围：aaa、password。 当前仅支持aaa认证模式。 "aaa" idleTimeOutMinutes int32 [0-35791] 5 登录会话超时时间，单位是分钟，超时时间是XX分钟XX秒。默认值为5。 - idleTimeOutSeconds int32 [0-59] 0 登录会话超时时间，单位是秒。默认值为0。 - inboundACLNum int32 [2000-2999] - 控制能登录进来的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 outboundACLNum int32 [2000-2999] - 控制从一个设备登录到另一个设备的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 inboundACL6Num int32 [2000-2999] - 对于IPv6的地址，控制能登录进来的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 outboundACL6Num int32 [2000-2999] - 对于IPv6的地址，控制从一个设备登录到另一个设备的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 返回状态码为400：请求参数错误，响应体参考CommonResponse。 表5 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/vty/global 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 { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "authenticationModel" : "aaa", "idleTimeOutMinutes" : "", "idleTimeOutSeconds" : "", "inboundACLNum" : 2100, "outboundACLNum" : 2100, "inboundACL6Num" : 2100, "outboundACL6Num" : 2100 }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceVTY 是 REFERENCE 详细请参见表2。 设备VTY信息。 - 表2 DeviceVTYInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点的ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" authenticationModel 是 string aaa password - 认证模式，取值范围：aaa、password。 当前仅支持aaa认证模式。 "aaa" idleTimeOutMinutes 否 int32 [0-35791] 5 登录会话超时时间，单位是分钟，超时时间是XX分钟XX秒。默认值为5。 - idleTimeOutSeconds 否 int32 [0-59] 0 登录会话超时时间，单位是秒。默认值为0。 - inboundACLNum 否 int32 [2000-2999] - 控制能登录进来的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 outboundACLNum 否 int32 [2000-2999] - 控制从一个设备登录到另一个设备的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 inboundACL6Num 否 int32 [2000-2999] - 对于IPv6的地址，控制能登录进来的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100 outboundACL6Num 否 int32 [2000-2999] - 对于IPv6的地址，控制从一个设备登录到另一个设备的ACL编号。可以通过第三方开放接口/controller/campus/v1/sdwan/vty/acl得到。 2100