华为云用户手册

响应参数 返回状态码为200：提交成功。 表4 queryOutput对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 queryOutput REFERENCE 详细信息请参见表 huawei-ac-application-template-north:output对象的参数列表。 - 表5 huawei-ac-application-template-north:output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 templates list 详细信息请参见表 huawei-ac-application-template-north:output对象的参数列表。 - 应用模板中已添加的模板列表。 total int - - 应用模板中已添加的模板数量。 表6 huawei-ac-application-template-north:output:templates对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 template-name string - - 模板名称。 template-dad-id string - - 驱动标识。 description string - - 模板组描述 is-used boolean - - 是否被使用 返回状态码为400：参数不正确。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。 表7 错误码描述 Status Code Error Code Error Message Parameter 错误说明 400 0x006e004b 解析请求体发生错误。 错误的参数字段。 请求体body存在错误。 500 0x00c8000c 参数{0}不合法。 {0}：参数名称。 入参有错误。 500 0x00c80012 内部服务异常。 - 系统内部错误，内部服务间调用存在异常。 500 0x00c80006 操作数据库异常。 - 系统内部错误，操作数据库存在异常。 500 0x00c80029 操作异常。 - 系统内部错误。

请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 queryInput 是 REFERENCE 详细信息请参见表 queryInput对象的参数列表。 创建应用模板参数。 表2 queryInput对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 input 否 REFERENCE 详细信息请参见表 input对象的参数列表。 - 表3 input对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 app-id 是 string 1-128个字符 - 临时应用标识。 template-name 否 string 0-128个字符 - 过滤条件：根据模板名模糊查询。 snd-id 否 string 0-128个字符 - 过滤条件：根据驱动标识查询。 page-index 否 int int32 - 分页条件：分页索引。 page-size 否 int int32 - 分页条件：每页容量。 sort-mode 否 enumeration ASC;DESC - 排序条件：升序、降序。 sort-field 否 enumeration TEMPLATENAME;DRIVERID - 排序条件：根据模板名称或驱动标识排序。

响应示例 返回状态码为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 { "totalRecords" : 100, "data" : [ { "name" : "group1", "description" : "this is template group1", "id" : "00000000-0000-0000-0000-000000000000", "type" : "preset", "bindingSiteNum" : "", "createTime" : "1713880927744", "updateTime" : "1713880927744" } ] } 返回状态码为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 { "errcode" : "0", "errmsg" : "" } 返回状态码为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

URI /v1/networkservice/hierarchy-template/template-groups 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 keyWord 否 string 0~256个字符。 - 模糊搜索关键字。 - type 否 string 6~16个字符。 - 模板组类型。preset：预置，customize：自定义。可选preset，customize中一个或多个类型。 "preset,customize" templateId 否 string 36个字符。 - 模板组模板ID，uuid格式。 "00000000-0000-0000-0000-000000000000" pageIndex 是 int32 [1-1000] 1 页码。 1 pageSize 是 int32 [1-100] 10 每页大小，最大值为100。 10

响应参数 返回状态码为200：操作成功。 表2 TemplateGroupsQueryResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 totalRecords int32 [0-1000] - 总记录数量。 100 data ARRAY_REFERENCE 0-100个列表项，详细请参见表3。 模板组列表。 - 返回状态码为400：校验异常。 CommonDto对象的参数列表，详细请参见表4。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /v1/networkservice/hierarchy-template/template-groups?type=preset,customize&templateId=00000000-0000-0000-0000-000000000000&pageIndex=1&pageSize=10 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

请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nqa:nqa/TestName 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-nqa:nqa" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "test-name" : "TestName", "type" : "ipv4", "ipv4-dest-address" : "192.168.1.1", "ipv4-next-hop" : "192.168.1.2", "ipv6-dest-address" : "FC00::1101", "ipv6-next-hop" : "FC00::1102", "out-if-name" : "GE0/0/1", "vpn-instance" : "_public_", "probe-count" : 5, "interval" : 4, "timeout" : 3, "frequency" : 22, "data-size" : 0, "ttl" : 30, "tos" : 0, "send-trap-bits" : "resultchange", "execution-switch" : true } ] }

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

请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nqa:nqa 是 REFERENCE 详细请参见表4。 NQA配置参数。 -

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

响应参数 返回状态码为200：查询单板配置信息成功。 表2 GetBoardResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-20个列表项，详细请参见表5。 查询到的单板配置信息。 - 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为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" : "", "data" : [ { "slot" : "slot2", "model" : "ET1D2S04SX1E", "status" : "0" } ] } 返回状态码为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

请求示例 HTTP的示例 GET /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

URI /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID，UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb"

响应示例 返回状态码为200：接口调用成功，响应体参考OverlayWanBgpPolicyResponse。 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" : { "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515a7e6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515a7e6", "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 } } ] }, "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 } } ] } } } 返回状态码为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的示例 GET /controller/campus/v1/sdwan/routing-protocol/overlay-wan-bgp-policy?vpnId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb 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/sdwan/vty/acl 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-10000] 1 起始页。默认值为1。 1 pageSize 否 int32 [1-1000] 10 页行记录数。默认值为10。 10 siteId 否 uuid - - 站点ID。 "00000000-0000-0000-0000-000000000000" deviceId 否 uuid - - 设备ID。 "00000000-0000-0000-0000-000000000000" aclNum 否 int32 [2000-2999] - VTY ACL的acl编号。 2100

请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/vty/acl?pageIndex=1&pageSize=10&siteId=00000000-0000-0000-0000-000000000000&deviceId=00000000-0000-0000-0000-000000000000&aclNum=2100 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：查询成功，响应体参考QueryVtyACLPolicyResponse。 表2 QueryVtyACLPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data ARRAY_REFERENCE 0-2000个列表项，详细请参见表5。 - - pageIndex int32 [1-10000] - 当前页。 1 pageSize int32 [1-10000] - 页大小。 10 totalRecords int32 [1-100000] - 总记录数。 100 返回状态码为400：请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500：内部异常。 详细信息请参见实际响应消息体。

响应示例 返回状态码为200：查询成功，响应体参考QueryVtyACLPolicyResponse。 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 { "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" } ] } ], "pageIndex" : 1, "pageSize" : 10, "totalRecords" : 100 } 返回状态码为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：查询成功返回。 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" : "", "pageIndex" : "", "pageSize" : "", "totalRecords" : "", "data" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "siteRole" : "Interworking Gateway", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "Template1", "deviceModel" : "AR6700V", "naasNetworkId" : "00000000-0000-0000-0000-000000000000", "naasNetworkName" : "Template1", "deployStatus" : "ready", "deviceStatus" : "0" } ] } 返回状态码为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 NaasNetworkDeviceListResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" pageIndex int32 [1-100] - 分页索引 - pageSize int32 [1-100] - 分页大小。 - totalRecords int32 [0-1000] - 总数。 - data ARRAY_REFERENCE 0-2000个列表项，详细请参见表3。 NaasNetwork设备列表。 - 表3 NaasNetworkDeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 siteId string 0~64个字符。 - 站点ID。 "00000000-0000-0000-0000-000000000000" siteName string 0~64个字符。 - 服务链名称。 "site1" siteRole string 0~64个字符。 - 站点角色，仅支持Interworking Gateway。 "Interworking Gateway" deviceId string 0~64个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" deviceName string 0~64个字符。 - 设备名称。 "Template1" deviceModel string 0~64个字符。 - 设备类型。 "AR6700V" naasNetworkId string 0~64个字符。 - 服务链ID。 "00000000-0000-0000-0000-000000000000" naasNetworkName string 0~64个字符。 - 服务链名称。 "Template1" deployStatus string 0~21个字符。 - 部署状态。creating：创建中, ready：已就绪, unknown：未知, error：故障, configured：已配置。 "ready" deviceStatus string 0~64个字符。 - 设备状态 0 正常 1 告警 2 故障 3 离线 4 未注册。 "0" 返回状态码为400：校验异常。 详细信息请参见实际响应消息体。 返回状态码为500：内部错误。 详细信息请参见实际响应消息体。

请求示例 HTTP的示例 GET /controller/sdwan/v1/naas/device/all?deviceName=device&pageIndex=1&pageSize=10 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/sdwan/v1/naas/device/all 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceName 否 string 0~128个字符。 - 设备名称。 "device" pageIndex 否 int32 [1-100] - 页面索引，不填时默认值为1。 "1" pageSize 否 int32 [1-20] - 页面大小，不填时默认值是5。 "10"

响应示例 返回状态码为200：查询成功，响应体参考QueryVpnQosGroupInfoResponse。 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" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "VPN-Group1", "description" : "**********", "vpnNumbers" : 10, "policyNumbers" : 10 } ] } 返回状态码为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的示例 GET /controller/campus/v1/sdwan/policy/traffic/vpn-qosgroup/list?name=VPN-Group1 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 /controller/campus/v1/oamservice/upgrade/reupgrade 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" : [ "57f879c7-7f6a-4d3a-88af-bf2585cb61e0" ] }

响应示例 返回状态码为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" : "" } 返回状态码为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的示例 GET /controller/campus/v1/sdwan/policy/traffic/local-interworking?vpnId=000000-0000-0000-0000-000000000000&siteName=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：查询成功，响应体参考QueryLocalInterworkingPolicyResponse。 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" : 1, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "vpnId" : "00000000-0000-0000-0000-000000000000", "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "site1", "igwEnable" : true, "enableUnderlayFirst" : false, "transportNetworkconfigs" : [ { "transportNetworkPortId" : "00000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "ApSite", "priority" : 1, "bandwidth" : 10, "enableIpv6" : true, "mtu" : 1500 } ] } ] } 返回状态码为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