华为云用户手册

  • 响应示例 HTTP/1.1 200 OK Server: product only Date: Tue, 19 Nov 2019 21:45:59 GMT Content-Type: application/yang.data+json Content-Length: 195 Connection: keep-alive Keep-Alive: timeout=60 X-Frame-Options: DENY Strict-Transport-Security: max-age=31536000;incodeSubDomains Cache-Control: no-cache, no-store, must-revalidate X-Content-Type-Options: nosniff Pragma: no-cache Expires: Thu, 01 Jan 1970 00:00:00 GMT X-XSS-Protection: 1; mode=block {"ietf-restconf-collection:collection":{"device-shell-group-northbound:device-group":[{"device-group-name":"A"},{"device-group-name":"B"},{"device-group-name":"C"},{"device-group-name":"cccc"}]}}
  • 响应参数 返回状态码为200:查询成功。 表1 body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 ietf-restconf-collection:collection REFERENCE 详细信息请参见表 ietf-restconf-collection:collection对象的参数列表 - 表2 ietf-restconf-collection:collection对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 device-shell-group-northbound:device-group list 详细信息请参见表 device-shell-group-northbound:device-group对象的参数列表 - 表3 device-shell-group-northbound:device-group对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 device-child-group-name string 1-128个字符 - 子设备组名,包括数字,字母,特殊字符-_@的一种或组合,且不能以数字开头。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。 表4 错误码描述 Status Code Error Code Error Message Parameter 错误说明 500 0x00c80006 操作数据库异常。 - 系统内部错误,操作数据库存在异常。
  • 请求示例 cURL示例 curl -k -s -L -i -X GET \ https://{ip:port}/restconf/data/device-shell-group-northbound:device-shell-group/device-group \ -H 'cache-control: no-cache' \ -H 'content-type: application/json' \ -H 'x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9' HTTP示例 GET /restconf/data/device-shell-group-northbound:device-shell-group/device-group HTTP/1.1 Host: {ip:port} Content-Type: application/json x-access-token: x-ntc9c745ryk9uohj7vpint3wsanwo9nvnuur4bg5ir08bt3woavsjvc46rurrx9djzfy84k8c988qqnw04ldjw5hlfuq6q5iqpsbqkvwc82rvx0bvxnsgbhg5doa7wg9 Cache-Control: no-cache
  • 响应示例 返回状态码为200:删除HACA模板成功,响应体参考BatchResponse。 HTTPS 200 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "fail": [], "success":["主拉远2"] } 返回状态码为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 /controller/campus/api/v1/lswauth/haca/20ab206c-5f5f-4cb6-9090-05cda5e9727b/batch-delete HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "ids":["ca3c4f3b-4f20-48c9-ab4c-28a281384795"] }
  • URI /controller/campus/api/campusaccesscfgservice/v1/lswauth/haca/{siteId}/batch-delete 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点标识,UUID格式。 "fbde1c5d-5b94-49e3-a912-48641015e45c"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-nvo3:nvo3 是 REFERENCE 详细请参见表4。 三层网络虚拟化配置参数。 -
  • 响应示例 返回状态码为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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nvo3:nvo3/{source-nve} 表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" source-nve 是 string 1~63个字符。 - 源端接口,仅支持NVE口,单一主键字段。 "Nve1"
  • 请求示例 HTTP的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nvo3:nvo3/Nve1 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-nvo3:nvo3" : { "source-nve" : "Nve1", "source-vtep-ip" : "10.1.1.1", "vni-instance" : [ { "vni" : 10, "static-peer" : [ { "address" : "10.1.2.1" } ] } ] } }
  • 请求示例 HTTP的示例 GET /controller/campus/v2/accountservice/accessuser/users?userGroupId=51cdcbe3-5e14-492b-ab27-86950b661d19&userName=user&email=xxx@example.com&name=yong hu&telephone=1xxxxxxxxxx&description=guest account&isContainSubGroup=false&pageIndex=1&pageSize=40&sortKey=&sortDir=DESC 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:查询用户成功,响应体参考AccessDataListDto。 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" : "1", "pageSize" : "10", "totalRecords" : "40", "data" : [ { "id" : "5b988058-e092-4310-a0ad-575e9b50e2db", "userGroupId" : "51cdcbe3-5e14-492b-ab27-86950b661d19", "userType" : "0", "roleIds" : [ "" ], "userName" : "test", "modifyDate" : "1571710215000", "vaildPeriod" : "1571710215000", "maxAccessNum" : 1, "accessType" : "deny", "email" : "xxx@example.com", "telephone" : "1xxxxxxxxxx", "nextUpdateUserpass" : true, "description" : "guest account", "deviceManagerFlag" : true, "name" : "", "bindInfo" : { "bindDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "20", "vlan" : "3377" } ], "bindAccDeviceInfo" : [ { "deviceIp" : "10.1.1.1", "port" : "20", "vlan" : "3377" } ], "bindEsn" : "21500829352SH1903955,21500829352SH1903977", "bindIP" : "10.1.1.1,10.1.1.2", "bindImsi" : "12312,668", "bindMac" : "11-11-11-11-11-11,22-22-22-22-22-22" }, "fields" : [ { "customFieldId" : "ea25fdbf-8dee-4823-bac2-5bfe8e3359cb", "customFieldValue" : "aaa" } ], "accountStatus" : 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
  • URI /controller/campus/v2/accountservice/accessuser/users 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 userGroupId 否 string - - 用户组ID。UUID格式 "51cdcbe3-5e14-492b-ab27-86950b661d19" userName 否 string 0~128个字符。 - 用户名称,支持模糊查询。 "user" email 否 string 0~100个字符。 - 用户邮箱。 "xxx@example.com" name 否 string 0~128个字符。 - 姓名,支持模糊查询 "yong hu" telephone 否 string 0~128个字符。 - 联系电话。 "1xxxxxxxxxx" description 否 string 0~256个字符。 - 用户描述。 "guest account" isContainSubGroup 否 string - - 填写用户组ID参数情况下,是否包含子用户组;true包含,false不包含,默认不包含。 "false" pageIndex 否 int32 [1-2000000] - 页面索引。 1 pageSize 否 int32 [5-1000] 1000 页面大小,不填时默认按照1000分页。 40 sortKey 否 string - - 排序字段,只支持userName排序。 "" sortDir 否 string - DESC 升降序字段,支持ASC-升序和DESC-降序,默认是DESC。 "DESC"
  • 响应示例 返回状态码为200:接口调用成功,响应体参考GreTunnelResponse,返回的除GRE Tunnel配置中仅包含对应的ID。 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" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "fc00:3::1/64", "srcIpAddress" : "192.168.1.1", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "destVpnId" : "00000000-0000-0000-0000-000000000000", "destWanLinkId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "key" : "123456", "checkSum" : "", "enableIpsec" : "", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "enableKeepAlive" : false, "period" : 5, "retryTimes" : 3, "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
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/net/site/inter/connect/gre/tunnel/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 { "greTunnelInfos" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "00000000-0000-0000-0000-000000000000", "ipAddress" : "fc00:3::1/64", "srcIpAddress" : "192.168.1.1", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "destVpnId" : "00000000-0000-0000-0000-000000000000", "destWanLinkId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "key" : "123456", "checkSum" : "", "enableIpsec" : "", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "enableKeepAlive" : false, "period" : 5, "retryTimes" : 3, "mtu" : 1500 } ] }
  • 响应示例 返回状态码为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 { "huawei-nce-e-cli:command-aliases" : { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "command-alias" : [ { "alias" : "test1", "command" : "test2", "parameter" : "$test3" } ] } } 返回状态码为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:操作成功。 表3 command-aliases-info对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-cli:command-aliases REFERENCE 详细请参见表4。 别名配置参数。 - 表4 command-aliases对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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" command-alias ARRAY_REFERENCE 0-200个列表项,详细请参见表5。 别名实例。 - 表5 command-aliases-command-alias对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 alias string 1~63个字符。满足正则表达[a-zA-Z][a-zA-Z0-9-]*。 - 指定别名。必填,支持大、小写字母,数字及连字符"-",字母开头,不区分大小写,字符间不能有空格。别名定义出现循环嵌套或嵌套层次超过16层时,该别名节点无效,不会用于进行字符串替换。单一主键字段。 "test1" command string 1~511个字符。满足正则表达[^?]+。 - 指定别名命令行。必填,不支持英文问号,如果字符之间有空格,则字符串外必须使用双引号。指定别名参数配置后,必须在指定别名命令行里面包含进去。例如参数包含$a,则命令行格式应该为$a,"$a","xxx $a","xxx $a $xx"这样的形式。多个$参数必须连续保持在最后。 "test2" parameter string 2~511个字符。 - 指定别名参数。支持大、小写字母,数字及连字符"-",必须以"$"符号开头,不区分大小写,取值范围是2~63,最多支持32个参数,参数之间以空格进行分隔。指定别名命令行配置后,必须在指定别名参数里面定义。例如命令行格式为$a,"$a","xxx $a","xxx $a $xx"这样的形式,则指定别名参数必须包含$a。 "$test3" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-cli:command-aliases 表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"
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-cli:command-aliases 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"
  • 响应示例 返回状态码为200:查询成功 HTTP/1.1 200 OK Date: Tue,17 May 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive { "huawei-ac-iui-hiscmd:output" : { "total-num" : 1, "fp-hiscmd-records" : [ { "uuid" : "0590d5f97dae31b4896971d07c0c9add", "device-id" : "0590d5f97dae31b4896971d07c0c9add", "device-ip" : "10.1.1.1", "config-time" : "2020-01-15 18:23:18", "feature-name" : "xxx", "operation" : "merge", "msg-body" : "xxx", "large-msg-status" : "none", "msg-south-body" : "xxx", "result" : "ok", "error-msg" : "xxx", "rollback" : true } ] } } 返回状态码为400:参数错误 HTTP/1.1 400 Bad Request Date: Tue,17 May 2022 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • 响应参数 返回状态码为200:查询成功 表4 get-fp-hiscmd-output对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-ac-iui-hiscmd:output REFERENCE 详细请参见表5。 - - 表5 get-fp-hiscmd-output-body对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 total-num int64 [0-4294967295] - 记录条数 1 fp-hiscmd-records ARRAY_REFERENCE 详细请参见表6。 - - 表6 get-fp-hiscmd-output-body-fp-hiscmd-records对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 uuid string 0~max个字符。 - 记录ID. "0590d5f97dae31b4896971d07c0c9add" device-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 "0590d5f97dae31b4896971d07c0c9add" device-ip string 0~256个字符。 - 设备IP地址 "10.1.1.1" config-time string 0~256个字符。 - 配置时间 "2020-01-15 18:23:18" feature-name string 1~1024个字符。 - 特性名称 "xxx" operation string merge replace create delete remove action copy-config edit-config - 操作类型:特有名词,对应下发操作 "merge" msg-body string 1~314572800个字符。 - =配置下发记录的详细报文信息 "xxx" large-msg-status string none large-msg obsolete-large-msg - 大报文状态:空/大报文/废弃大报文 "none" msg-south-body string 0~314572800个字符。 - =配置下发记录的详细报文信息 "xxx" result string ok failed processing - 处理结果:成功/失败/下发中 "ok" error-msg string 0~20480个字符。 - 配置下发失败,记录的错误信息 "xxx" rollback boolean true false - 是否回滚:回滚配置/正常配置 true 返回状态码为400:参数错误 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /restconf/operations/huawei-ac-iui-hiscmd:get-fp-hiscmd HTTP/1.1 Host: 192.168.1.125:2633518002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AUTH-TOKEN: x-yyyyyy { "huawei-ac-iui-hiscmd:input" : { "device-id" : "0590d5f9-7dae-31b4-8969-71d07c0c9add", "feature-name" : """", "message" : """", "start-time" : 1, "end-time" : 1, "result" : "ok", "page-num" : 1, "page-line" : 1, "tenant-id" : "0590d5f9-7dae-31b4-8969-71d07c0c9add" } }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 get-fp-hiscmd 是 REFERENCE 详细请参见表2。 查询配置历史记录详情 - 表2 get-fp-hiscmd-input对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-ac-iui-hiscmd:input REFERENCE 详细请参见表3。 - - 表3 get-fp-hiscmd-input-body对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 device-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 "0590d5f9-7dae-31b4-8969-71d07c0c9add" feature-name 否 string 1~1024个字符。 - 搜索条件:特性名称 """" message 否 string 0~1024个字符。 - 搜索条件:详细信息 """" start-time 否 int64 [0-9223372036854775807] - 搜索条件:开始记录时间 1 end-time 否 int64 [0-9223372036854775807] - 搜索条件:结束记录时间 1 result 否 string ok failed processing - 搜索条件:成功/失败/下发中 "ok" page-num 是 int32 [1-2147483647] - 排序条件:分页编号 1 page-line 是 int32 [1-100] - 排序条件:每页容量 1 tenant-id 否 string 0~128个字符。 - 排序条件:租户id "0590d5f9-7dae-31b4-8969-71d07c0c9add"
  • 响应示例 返回状态码为200:接口调用成功,响应体参考CommonResponse。 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:Invalid tag value 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
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 bannerInfo 是 REFERENCE 详细请参见表2。 需要存储的banner对象 - 表2 BannerInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - Banner id,uuid格式 - templateName 否 string - - banner模板名称 "templateName" bannerBefore 否 string - - 登录前显示的命令行信息 "header shell information Telecom Italia S.p.A." bannerAfter 否 string - - 登录后显示的命令行信息 "UNAUTHORIZED ACCESS TO THIS NETWORK DEVICE IS PROHIBITED You must haveexplicit permission to access or configure this deviceAll activities performed on this device may be logged based on TISecurity Policy"
  • 请求示例 HTTP的示例 POST /controller/campus/v2/banner/banner 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 { "id" : "", "templateName" : "templateName", "bannerBefore" : "header shell information Telecom Italia S.p.A.", "bannerAfter" : "UNAUTHORIZED ACCESS TO THIS NETWORK DEVICE IS PROHIBITED You must haveexplicit permission to access or configure this deviceAll activities performed on this device may be logged based on TISecurity Policy" }
  • 响应参数 返回状态码为200:接口调用成功,响应体参考CommonResponse。 表3 CommonResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码,0表示成功,非0表示失败。 "0" errmsg string - - 错误信息。 - 返回状态码为400:Invalid tag value 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /controller/campus/rest/sdwan/v1/device/dot1x/template 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 { "id" : "00000000-0000-0000-0000-000000000000", "templateInfo" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "name" : "d1", "desc" : "RADIUS服务器", "authenDomainName" : "huawei.com" } }
  • 响应示例 返回状态码为200:修改成功,响应体参考Dot1xTemplateCreateOrUpdateResponse。 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" : { "id" : "00000000-0000-0000-0000-000000000000", "templateInfo" : { "siteId" : "00000000-0000-0000-0000-000000000000", "deviceId" : "00000000-0000-0000-0000-000000000000", "name" : "d1", "desc" : "RADIUS服务器", "authenDomainName" : "huawei.com" } } } 返回状态码为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 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 RequestBody 是 REFERENCE 详细请参见表3。 NAC认证模板信息。 - 表3 DeviceDot1xTemplateInfoWithId对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 0~36个字符。 - NAC认证模板ID "00000000-0000-0000-0000-000000000000" templateInfo 是 REFERENCE 详细请参见表3。 - -
共99354条