华为云用户手册

URI /controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/aptunnel 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板标识，UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c"

请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/site-templates/fbde1c5d-5b94-49e3-a912-48641015e45c/aptunnel 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

响应示例 返回状态码为200：查询成功，返回结构体参见SiteTemplateAptunnelResponseDto。 HTTPS/1.1 200 OK Date: Thu,13 MAY 2023 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "00000000000000000000000000000000", "tunnelName" : "tunnel1", "masterTunnelIp" : "192.168.0.1", "slaveTunnelIp" : "192.168.0.2", "autoRestoreEnable" : true, "autoRestoreDelay" : 100, "vlanRanges" : "20,30-200,500", "dtlsType" : "disable", "backUpDtlsType" : "disable" } ] } 返回状态码为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：操作成功。 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-dns:dns" : { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "enable-dns" : false, "dnsv4" : [ { "dnsv4-ip" : "192.168.1.1", "vpn-instance" : "vpn1" } ], "ipv4-source" : [ { "ipv4-source-addr" : "192.168.1.1", "vpn-instance" : "vpn1" } ], "hostv4" : [ { "host" : "example.com", "address" : "192.168.1.1", "vpn-instance" : "vpn1" } ], "dns-relay" : { "enable-relay" : false, "local-ip" : [ { "ip-address" : "10.1.0.0", "vpn-name" : "vpn1" } ] }, "dns-proxy" : { "enable-proxy" : false, "forward-any-response" : false }, "proxy-client-src-ip" : [ { "address" : "192.168.1.1", "vpn-instance" : "vpn1" } ], "dnsv6" : [ { "dnsv6-ip" : "fc00::/7", "vpn-instance" : "vpn1", "if-name" : "GE0/0/0" } ], "ipv6-source" : [ { "ipv6-source-addr" : "fc00::/7", "vpn-instance" : "vpn1" } ] } } 返回状态码为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：操作成功。 表3 dns-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-dns:dns REFERENCE 详细请参见表4。 DNS配置。 - 表4 dns对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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" enable-dns boolean true false false 使能DNS。AR6700V子设备不支持。 false dnsv4 ARRAY_REFERENCE 0-6个列表项，详细请参见表5。 DNS服务器。AR6700V主设备不支持。 - ipv4-source ARRAY_REFERENCE 详细请参见表6。 服务器互通IPv4源地址。AR6700V主设备不支持。 - hostv4 ARRAY_REFERENCE 详细请参见表7。 IPv4主机。AR6700V主设备不支持。 - dns-relay REFERENCE 详细请参见表8。 DNS中继。AR6700V主设备和AR6700V子设备不支持。 - dns-proxy REFERENCE 详细请参见表10。 DNS代理。AR6700V子设备不支持。 - proxy-client-src-ip ARRAY_REFERENCE 详细请参见表11。 客户端互通IPv4源地址。AR6700V主设备不支持。 - dnsv6 ARRAY_REFERENCE 0-6个列表项，详细请参见表12。 DNSv6服务器。AR6700V主设备，AR6700V子设备和AR6700V-L设备不支持。 - ipv6-source ARRAY_REFERENCE 详细请参见表13。 服务器互通IPv6源地址。AR6700V主设备，AR6700V子设备和AR6700V-L设备不支持。 - 表5 dns-dnsv4对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dnsv4-ip 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}]+)?。 - DNS服务器IP（最多6个），联合主键字段。 "192.168.1.1" vpn-instance string 1~31个字符。 _public_ 绑定VPN实例，联合主键字段。 "vpn1" 表6 dns-ipv4-source对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipv4-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}]+)?。 - 互通IPv4源地址，单一主键字段。 "192.168.1.1" vpn-instance string 1~31个字符。 _public_ 绑定VPN实例。 "vpn1" 表7 dns-hostv4对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 host string 1~255个字符。 - 主机名，联合主键字段。 "example.com" address 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}]+)?。 - 主机地址。 "192.168.1.1" vpn-instance string 1~31个字符。 _public_ 绑定VPN实例，联合主键字段。 "vpn1" 表8 dns-relay对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable-relay boolean true false false 使能DNS中继。 false local-ip ARRAY_REFERENCE 0-10个列表项，详细请参见表9。 配置IPv4本地地址。 - 表9 dns-relay-local-ip对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ip-address 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.0.0" vpn-name string 1~31个字符。 - VPN实例，联合主键字段。 "vpn1" 表10 dns-proxy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable-proxy boolean true false false 使能DNS代理。 false forward-any-response boolean true false false 使能转发所有响应。AR6700V主设备不支持。 false 表11 dns-proxy-client-src-ip对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 address 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源地址，联合主键字段。 "192.168.1.1" vpn-instance string 1~31个字符。 _public_ VPN实例，联合主键字段。 "vpn1" 表12 dns-dnsv6对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 dnsv6-ip string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - DNSv6服务器IP（最多6个），联合主键字段。 "fc00::/7" vpn-instance string 1~31个字符。 _public_ 绑定VPN实例，联合主键字段。 "vpn1" if-name string 1~63个字符。 - 绑定源接口，联合主键字段。 "GE0/0/0" 表13 dns-ipv6-source对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ipv6-source-addr string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 互通IPv6源地址，单一主键字段。 "fc00::/7" vpn-instance string 1~31个字符。 _public_ 绑定VPN实例。 "vpn1" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /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-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-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：接口调用成功，响应体参考BridgeDomainResponse，返回的Bridge Domain信息中仅包含对应的ID。 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" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } } ] } 返回状态码为204：执行成功，没有数据。 HTTP/1.1 204 No Content 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的示例 POST /controller/campus/v1/sdwan/overlay-network/bridge-domains/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 { "bridgeDomains" : [ { "id" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "ports" : [ { "id" : "00000000-0000-0000-0000-000000000000", "interfaceName" : "GE0/0/0", "tagMode" : "tag", "portLagFlag" : false, "isAutoNegotiation" : false } ], "vlanId" : 2, "description" : "description", "configSource" : "Wan" } ], "fullReplace" : false }

请求示例 HTTP的示例 PUT /controller/campus/v1/networkservice/networkconfig/net/time/sites/fbb684c8-0d37-496f-bafa-4b06db151e2e/times 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 { "timezoneId" : "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845", "enableDaylight" : false, "ntpList" : ["10.0.0.2","10.0.0.5"], "enableTimeSync" : 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" : { "timezoneId" : "d3dcf87e-8c14-4ba8-bb23-2ccc4451b845", "enableDaylight" : false, "ntpList" : ["10.0.0.2","10.0.0.5"], "enableTimeSync" : true } }

URI /controller/campus/v1/networkservice/networkconfig/net/time/sites/{siteId}/times 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string - - 站点ID，格式为UUID格式。 "fbb684c8-0d37-496f-bafa-4b06db151e2e"

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 boardConfigDto 是 REFERENCE 详细请参见表3。 单板配置信息。 - 表3 BoardConfigDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 slot 否 string 0~10个字符。 - 单板槽位。 "slot2" model 否 string 0~20个字符。 - 单板对外型号。 "ET1D2S04SX1E"

响应示例 返回状态码为201：单板配置返回信息。 HTTP/1.1 201 Created Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "errcode" : "0", "errmsg" : "", "data" : { "slot" : "slot2", "model" : "ET1D2S04SX1E", "status" : "0" } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

响应参数 返回状态码为201：单板配置返回信息。 表4 ConfigResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data REFERENCE 详细请参见表5。 - - 表5 BoardInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 slot string 0~10个字符。 - 单板槽位。 "slot2" model string 0~20个字符。 - 单板对外型号。 "ET1D2S04SX1E" status string 0~10个字符。 - 单板状态，0---未知、1---不在位、2---在位、3---正常、4---故障、5---已删除、6---冲突。 "0" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/board/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/boards HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "slot" : "slot2", "model" : "ET1D2S04SX1E" }

URI /controller/campus/v1/networkservice/networkconfig/net/board/devices/{deviceId}/boards 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid 36个字符。 - 设备标识，UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"

响应参数 返回状态码为200：查询成功，响应体参考QuerySecurityPolicyResponse。 表2 QuerySecurityPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~256个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" totalRecords int32 [0-65535] - 总的数据条数。 10 pageSize int32 [0-65535] - 每页显示数量。 10 pageIndex int32 [0-65535] - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项，详细请参见表10。 安全策略信息。 - 返回状态码为400：请求参数错误，无响应体。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误，无响应体。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QuerySecurityPolicyResponse。 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" : "", "totalRecords" : 10, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "name" : "test_1", "status" : 1, "isActive" : true, "internetToUserRules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "endSourcePort" : 6, "targetPort" : 6, "endTargetPort" : 6, "ipsProfile" : "strict", "avProfile" : "default", "urlProfile" : "default", "sourceIpAddressSets" : [ "sourceIpAddressSet" ], "targetIpAddressSets" : [ "targetIpAddressSet" ], "sourceGeoLocationSets" : [ { "key" : "", "name" : "" } ], "targetGeoLocationSets" : [ { "key" : "", "name" : "" } ], "sourceDomainSets" : [ "sourceDomainSet" ], "targetDomainSets" : [ "targetDomainSet" ], "sourceFeeds" : "ipFeed01", "ipFeed02" , "targetFeeds" : "ipFeed01", "ipFeed02" , "appGroups" : [ "appGroup" ], "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "fileProfile" : "fileProfile01" } ], "userToInternetRules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "deny", "protocolNum" : 6, "sourceIp" : "192.168.0.0/24", "targetIp" : "192.168.0.0/24", "sourcePort" : 6, "endSourcePort" : 6, "targetPort" : 6, "endTargetPort" : 6, "ipsProfile" : "strict", "avProfile" : "default", "urlProfile" : "default", "sourceIpAddressSets" : [ "sourceIpAddressSet" ], "targetIpAddressSets" : [ "targetIpAddressSet" ], "sourceGeoLocationSets" : [ { "key" : "", "name" : "" } ], "targetGeoLocationSets" : [ { "key" : "", "name" : "" } ], "sourceDomainSets" : [ "sourceDomainSet" ], "targetDomainSets" : [ "targetDomainSet" ], "sourceFeeds" : "ipFeed01", "ipFeed02" , "targetFeeds" : "ipFeed01", "ipFeed02" , "appGroups" : [ "appGroup" ], "effectiveTimeId" : "00000000-0000-0000-0000-000000000000", "effectiveTimeName" : "effectiveTimeName", "fileProfile" : "fileProfile01" } ], "policyType" : false, "securityZone" : { "securityInterZones" : [ [ "test_1" ] ] }, "enableSecurityZones" : true, "securityZones" : { "sourceZones" : [ "test_1" ], "destZones" : [ "test_2" ] } } ] } 返回状态码为400：请求参数错误，无响应体。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500：内部错误，无响应体。 HTTP/1.1 500 Internal Server Error Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/security/security-policies?pageIndex=0&pageSize=20&vpnId=00000000-0000-0000-0000-000000000000&sort=desc&id=00000000-0000-0000-0000-000000000000&policyName=site1 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：闪灯增强成功，响应体参考ResultDto。 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" }

请求示例 HTTP的示例 PUT /controller/campus/v2/oamservice/devoam/device/blink/ea25fdbf-8dee-4823-bac2-5bfe8e3359ca 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 { "takeover" : true, "timeout" : 10, "leds" : [ { "ledName" : "sys-led", "status" : 0 } ] }

请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ledCtrlParam 是 REFERENCE 详细请参见表3。 LED灯控制参数。 - 表3 LedCtrlParam对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 takeover 是 boolean true false - 是否使能LED灯的控制，使能后，灯的状态将由下面的参数指定。当参数为False时，timeout和leds不生效。 true timeout 否 integer [10-600] - LED灯熄灭的时间，当时间到期后，LED灯将恢复原有的功能。单位：秒。当takeover参数为true时，该项为必填项。 10 leds 否 REFERENCE 1-4个列表项，详细请参见表4。 指定需要控制的灯的状态列表。当takeover参数为true时，该项为必填项。 - 表4 leds对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ledName 否 string - - 指定要进行控制的灯的名字。系统灯---sys-led，控制灯---ctrl-led，网络灯---inet-led，USB灯---usb-led。 "sys-led" status 否 integer 0 1 2 - 灯状态。0---常灭，1---常亮，2---闪烁。 0

响应示例 返回状态码为201：创建成功，响应体参考CommonRestResponse。 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" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] } } 返回状态码为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：创建成功，响应体参考CommonRestResponse。 表4 CommonRestResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errCode string 0~10个字符。 - 错误码。 "0" errMsg string 0~255个字符。 - 错误描述。 "" data REFERENCE 详细请参见表5。 - - 表5 VtyACLPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId uuid 1~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId uuid 1~64个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" aclNum int32 [2000-2999] - ACL编号，同一设备的IPv4和IPv6的ACL编号不能相同。 2100 type string 0~8个字符。 IPv4 VTY ACL类型，该字段可以设置为以下几种： a) IPv4 b) IPv6 默认为IPv4。 "IPv4" ruleList ARRAY_REFERENCE 1-100个列表项，详细请参见表6。 ACL规则列表。配置ACL必须配置规则。 - 表6 ACLRule对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 ruleId int64 [0-4294967294] - VTY ACL规则优先级。 10 operateType int32 - 1 操作类型，取值范围：1---允许、2---拒绝。默认值为1。 1 ipRange string - - IP地址范围，支持IPv4和IPv6，格式：IP地址/掩码或Any。其中IPv4的掩码范围为0-32，IPv6的掩码范围为1-128。若需要配置全地址（即IPv4掩码为0、IPv6前缀为0），可以输入“Any”（不区分大小写）。 IPv4地址如：192.168.1.1/16； IPv6地址如：fc22::1010/64。 "192.168.1.1/16" 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/vty/acl 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", "aclNum" : 2100, "type" : "IPv4", "ruleList" : [ { "ruleId" : 10, "operateType" : 1, "ipRange" : "192.168.1.1/16" } ] }

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 aclPolicy 是 REFERENCE 详细请参见表2。 设备VTY ACL规则信息。 - 表2 VtyACLPolicyInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid 1~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 是 uuid 1~64个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" aclNum 是 int32 [2000-2999] - ACL编号，同一设备的IPv4和IPv6的ACL编号不能相同。 2100 type 否 string 0~8个字符。 IPv4 VTY ACL类型，该字段可以设置为以下几种： a) IPv4 b) IPv6 默认为IPv4。 "IPv4" ruleList 是 ARRAY_REFERENCE 1-100个列表项，详细请参见表3。 ACL规则列表。配置ACL必须配置规则。 - 表3 ACLRule对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ruleId 是 int64 [0-4294967294] - VTY ACL规则优先级。 10 operateType 是 int32 - 1 操作类型，取值范围：1---允许、2---拒绝。默认值为1。 1 ipRange 是 string - - IP地址范围，支持IPv4和IPv6，格式：IP地址/掩码或Any。其中IPv4的掩码范围为0-32，IPv6的掩码范围为1-128。若需要配置全地址（即IPv4掩码为0、IPv6前缀为0），可以输入“Any”（不区分大小写）。 IPv4地址如：192.168.1.1/16； IPv6地址如：fc22::1010/64。 "192.168.1.1/16"

响应示例 返回状态码为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" : { "processStatus" : "running", "processProgress" : "100%" } } 返回状态码为400：校验异常。 HTTP/1.1 400 Bad Request Date: Sun,11 May 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为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：重编排结果 表1 ProgressResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表2。 拓扑编排进度信息。 - 表2 ProgressInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 processStatus string 0~8个字符。 - 编排process的状态：running、success、fail。 "running" processProgress string 0~8个字符。 - 进程进度，返回百分比数值。 "100%" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/topology/progress 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