华为云用户手册

  • 请求示例 HTTP的示例 GET /controller/campus/v1/oamservice/saupgrade/sites/ea25fdbf-8dee-4823-bac2-5bfe8e3359cad 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:接口调用成功,响应体参考FlowDistrResp。 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" : [ { "targetName" : "humanflow", "counts" : [ { "count" : "123", "stamp" : 1565049600000 } ] } ] } 返回状态码为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
  • URI /controller/campus/v1/performanceservice/endpointbehavior/realtimeflow 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 否 string - - 站点ID,UUID格式。不传默认租户级查询. "9dffc44b-1824-42a4-ac48-616e3f0eaa2a" tagId 否 string - - 标签ID,UUID格式,若不设置,则默认查询站点下所有设备。 "31f35021-e656-472a-8937-9c6d6da76e6e"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/endpointbehavior/realtimeflow?siteId=9dffc44b-1824-42a4-ac48-616e3f0eaa2a&tagId=31f35021-e656-472a-8937-9c6d6da76e6e 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:文件查询成功返回。响应体参考QueryFileResponse 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" : "", "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 1, "fileInfoList" : [ { "fileId" : "7d4ea473-dc8b-4acc-8cf9-0a550cbb09e6", "subFileDetails" : [ { "fileId" : "7d4ea473-dc8b-4acc-8cf9-0a550cbb09e6", "subFileDetails" : [ { ... } ], "currentUserUpload" : true, "fileType" : 20, "feature" : 22, "version" : "1.1", "fileName" : "test.xml", "description" : "文件描述", "tenantName" : "tenant", "fileSize" : "0", "offset" : 0, "sizeUnit" : "B", "uploadProgress" : 100, "createTime" : "2022-10-25 21:01:35", "iconString" : null, "storageTypesSupport" : [ { ... } ], "fileServerName" : " FusionInsight ", "manualRecord" : 0, "status" : 1, "needToReboot" : false, } ], "currentUserUpload" : true, "fileType" : 20, "feature" : 22, "version" : "1.1", "fileName" : "test.xml", "description" : "文件描述", "tenantName" : "tenant", "fileSize" : "0", "offset" : 0, "sizeUnit" : "B", "uploadProgress" : 100, "createTime" : "2022-10-25 21:01:35", "iconString" : "", "storageTypesSupport" : [ "" ], "fileServerName" : "FusionInsight", "manualRecord" : 0, "status" : 1, "needToReboot" : false } ] } 返回状态码为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/baseservice/api/v1/filemgr/files/action/batch-query 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 [ "1" ]
  • 响应示例 返回状态码为200:查询站点模板下的AP无线安全配置成功后的消息体。 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" : { "securityLevel" : "Off", "illegalDeviceDetect" : { "illegalDeviceDetect" : false, "macWhiteList" : [ "XX:XX:XX:XX:XX:XX" ], "ouiSsidMatch" : "both", "ouiWhiteList" : [ "02:02:00" ], "ssidWhiteList" : [ "abc" ] }, "manualContainDevice" : { "manualContainDevice" : false, "manualContainDeviceList" : [ "XX:XX:XX:XX:XX:XX" ] }, "spoofAPContain" : { "spoofAPContain" : false, "spoofingSSIDRuleList" : [ "abc" ] }, "terminalProtection" : { "terminalProtection" : false, "protectTerminalMACList" : [ "XX:XX:XX:XX:XX:XX" ] }, "bruteForceAttackDetect" : { "bruteForceAttackDetect" : false, "bruteForceThreshold" : 20, "bruteForceInterval" : 60 }, "spoofAttackDetect" : false, "floodAttackDetect" : false, "weakIvDetect" : false, "dynamicBlackListDefense" : false, "adhocContain" : false, "openDeviceContain" : false } } 返回状态码为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
  • URI /controller/campus/v3/networkconfig/site-templates/{siteTemplateId}/apwids 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteTemplateId 是 string 36个字符。 - 站点模板ID, UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 请求示例 HTTP的示例 GET /controller/campus/v3/networkconfig/site-templates/fbb684c8-0d37-496f-bafa-4b06d5151e2e/apwids 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
  • 响应示例 返回状态码为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 { "errcode" : "0", "errmsg" : "" }
  • URI /controller/campus/v1/networkservice/networkconfig/profile/apvpn/encryptionpolicy/{id} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 32~36个字符。 - 策略ID。 "fbb684c8-0d37-496f-bafa-4b06db151e2e"
  • 请求示例 HTTP的示例 DELETE /controller/campus/v1/networkservice/networkconfig/profile/apvpn/encryptionpolicy/fbb684c8-0d37-496f-bafa-4b06db151e2e 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
  • 硬件安装云化设备 根据部署规划时的网络设备安装点位设计、设备间互联等信息,完成网络设备的硬件安装、连线、上电等操作,参见表1。 表1 硬件安装与布线任务一览表 任务 任务说明 参考链接 安装硬件设备 硬件设备安装需要遵循施工规范,常见的硬件施工规范有: 物理设备必须可靠接地。 物理设备谨慎搬运,要连带外纸箱或泡沫垫,不要裸机搬运。 所有光纤、网线、高速电缆和电源线分开布线,规范折弯有序捆扎。 所有光纤、网线和电源线需要考虑长度和传输距离是否能够满足环境的需求。 请单击以下设备名称,进入“硬件安装与维护指南”手册,查看对应设备款型的安装指导。 若无法找到,请在搜索框中输入设备款型查找安装指导。 WAC AP 连接线缆 根据布线规划完成线缆连接,连接时注意按照规范在线缆两端打上标签。 设备配电、上电 请按照规划的配电参数和各个产品的产品文档来执行设备上电操作。
  • 响应参数 返回状态码为200:查询成功,响应体参考GetUsergroupsOutputDto。 表2 GetUsergroupsOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [0-2000000] - 当前页数。 1 pageSize int32 [0-1000] - 每页最大显示数量。 20 totalRecords int32 [0-2147483647] - 查询到的总结果数。 1 errcode string - - 错误码。 "0" errmsg string - - 错误信息描述。 "" data ARRAY_REFERENCE 0-1000个列表项,详细请参见表3。 返回数据内容。 - 表3 UsergroupOutputDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string - - 用户组ID。UUID格式 "a91e1696-02a2-4a68-bad4-aa639359c8cf" description string - - 用户组描述。 "administrator group" fullPathName string - - 用户组全路径。 "/root/admin" bsid string - - 用户组层级关系。 "00000-00001" parentId string - - 父用户组ID。UUID格式 "66848b66-482d-4ba1-b862-4f1ab763fc95" name string - - 用户组名。 "admin" address string - - 地址。 "Xihu North Community" postalCode string - - 邮编。 "417700" adminEmail string - - 管理员邮箱。 "xxx@example.com" orderId int32 - - 用于同一级用户组排序。 1134 dataSource int32 - - 数据来源 0 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考GetUsergroupsOutputDto。 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 { "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 1, "errcode" : "0", "errmsg" : "", "data" : [ { "id" : "a91e1696-02a2-4a68-bad4-aa639359c8cf", "description" : "administrator group", "fullPathName" : "/root/admin", "bsid" : "00000-00001", "parentId" : "66848b66-482d-4ba1-b862-4f1ab763fc95", "name" : "admin", "address" : "Xihu North Community", "postalCode" : "417700", "adminEmail" : "xxx@example.com", "orderId" : 1134, "dataSource" : 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
  • 请求示例 HTTP的示例 GET /controller/campus/v1/accountservice/usergroups?userGroupId=a91e1696-02a2-4a68-bad4-aa639359c8cf&userGroupName=user&isContainSubGroup=false&pageIndex=1&pageSize=20&sort=userGroupName 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/accountservice/usergroups 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 userGroupId 否 string - - 用户组ID。UUID格式 "a91e1696-02a2-4a68-bad4-aa639359c8cf" userGroupName 否 string 0~255个字符。 - 用户组名,支持模糊查询。 "user" isContainSubGroup 否 boolean true false - 是否包含子用户组,该变量需要和userGroupId一起使用,主要用于查询指定用户组下子部门(只包含当前指定用户组下一层子用户组,更下层的不包含)。默认值false。 "false" pageIndex 否 int32 [0-2000000] - 页面索引。 1 pageSize 否 int32 [0-1000] - 页面大小。 20 sort 否 string - - 排序字段仅支持‘userGroupName’ +表示升序,-表示降序,默认用升序。 "userGroupName"
  • 响应示例 返回状态码为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" : "", "totalRecords" : 1, "pageIndex" : 1, "pageSize" : 20, "data" : { "lldp" : [ { "localIfName" : "interface 0/0/0", "remoteIfName" : "interface 0/0/1", "sysName" : "10", "sysDescription" : "xx:xx:xx:xx:xx:xx", "remoteMac" : "xx:xx:xx:xx:xx:xx", "sysCapEnabled" : "cap-bridge cap-router", "sysCapSupported" : "cap-router" } ] } }
  • 响应参数 返回状态码为200:查询成功。 表3 NeighborsInfoResultDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误描述。 "" totalRecords integer - - 当前查询LLDP连接的总数。 1 pageIndex integer - - 分页的序号。 1 pageSize integer - - 分页的大小。 20 data REFERENCE 详细请参见表4。 - - 表4 data对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 lldp ARRAY_REFERENCE 0-65535个列表项,详细请参见表5。 LLDP数据。 - 表5 NeighborsInfoDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 localIfName string - - 本端接口名称。 "interface 0/0/0" remoteIfName string - - 远端接口名称。 "interface 0/0/1" sysName string - - 远端系统名称。 "10" sysDescription string - - 远端系统描述。 "xx:xx:xx:xx:xx:xx" remoteMac string - - 远端系统MAC。 "xx:xx:xx:xx:xx:xx" sysCapEnabled string - - 对端设备支持的能力:cap-other、cap-repeater、cap-bridge、cap-wlan-access-point、cap-router、cap-telephone、cap-docsis-cable-device、cap-station-only;多个能力时以空格间隔。 "cap-bridge cap-router" sysCapSupported string - - 对端设备使能的能力:cap-other、cap-repeater、cap-bridge、cap-wlan-access-point、cap-router、cap-telephone、cap-docsis-cable-device、cap-station-only;多个能力时以空格间隔。 "cap-router"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/networkresource/topomanager/device/d4e8513d-69f7-41bb-a3f5-b3a0fcc7b6e0/neighbors?localIfName=GigabitEthernet0/0/0&pageIndex=0&pageSize=20 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:更新成功,响应体参考ReplaceDeviceCertificateResponseDto。 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" : "", "certificationStatus" : "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
  • 响应参数 返回状态码为200:更新成功,响应体参考ReplaceDeviceCertificateResponseDto。 表4 ReplaceDeviceCertificateResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 1~64个字符。 - 错误码。 "0" errmsg string 1~64个字符。 - 错误信息。 "" certificationStatus string 1~64个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 证书状态(0:初始化,1:申请中,2:申请成功,3:申请失败)。 "1" 返回状态码为400:校验异常,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 POST /controller/campus/v1/oamservice/certification/device/certificate 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", "caServerId" : "00000000-0000-0000-0000-000000000000", "algorithm" : "rsa", "algLength" : "4096", "entity" : { "ipAddress" : "10.1.1.1", "fqdn" : "test.abc.com", "email" : "user@abc.com", "country" : "cn", "state" : "jiangsu", "organization" : "huawei", "department" : "huawei" }, "transportNetworkPortId" : "00000000-0000-0000-0000-000000000000", "challengePwd" : "password", "vpnId" : "18bd7aec-f163-4091-bc5e-d6c19725d72c", "vpnInstanceName" : "vpn1", "sourceInterface" : "loopback1", "urlMode" : 0, "sslClientVersion" : "tls1.2", "sslClientCipher" : 16, "pkiDomain" : "default" }
  • 请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 replaceDeviceCertificateDto 是 REFERENCE 详细请参见表2。 替换设备证书。 - 表2 ReplaceDeviceCertificateDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 0~64个字符。 - 设备ID。 "00000000-0000-0000-0000-000000000000" caServerId 是 string 0~64个字符。 - CA服务器ID。 该字段对应UI页面上是:UI【选择CA服务】 "00000000-0000-0000-0000-000000000000" algorithm 是 string 0~16个字符。 - 密钥算法(支持算法:RSA),只支持小写。 该字段对应UI页面上是:UI【密钥算法】 "rsa" algLength 是 string 0~8个字符。 - 密钥长度,该字段可以设置为以下几种: a) 2048, b) 3072, c) 4096 RSA长度小于3072, 安全性较低,建议使用较为安全的协议版本。 该字段对应UI页面上是:UI【密钥长度】 "4096" entity 否 REFERENCE 详细请参见表3。 - - transportNetworkPortId 否 uuid 0~256个字符。 - TNP ID,underlay场景使用,不支持IPv6链路。 "00000000-0000-0000-0000-000000000000" challengePwd 否 password 0~128个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 SCEP证书申请通用挑战密码。 "password" vpnId 否 string 0~64个字符。 - vpnID,overlay场景使用。 "18bd7aec-f163-4091-bc5e-d6c19725d72c" vpnInstanceName 否 string 0~64个字符。 - vpn实例名称,overlay场景使用。 该字段对应UI页面上是:UI【vpn实例名称】 "vpn1" sourceInterface 否 string 0~64个字符。 - 源接口名,overlay场景使用。 该字段对应UI页面上是:UI【源接口名】 "loopback1" urlMode 否 int32 [0-1] - 协议类型,该字段的取值范围是0:http, 1:https。 HTTPS协议比HTTP协议有更多安全保证,建议选择HTTPS协议。 该字段对应UI页面上是:UI【协议类型】 0 sslClientVersion 否 string 0~6个字符。 - tls版本,当urlMode字段是1时,必须设置该字段。 该字段的取值是tls1.1或tls1.2。 TLS1.1是不安全的协议,推荐使用更安全的TLS1.2协议。 该字段对应UI页面上是:UI【版本】 "tls1.2" sslClientCipher 否 int32 [1-31] - 认证和加密算法,当urlMode字段是1时,必须设置该字段。 该字段的取值范围是,rsa-3des-cbc-sha,权重为1;rsa-aes-128-cbc-sha,权重为2;rsa-aes-128-sha256,权重为4;rsa-aes-256-sha256,权重为8;ecdhe_rsa_aes256_gcm_sha384,权重为16。可以同时支持多种算法,比如需要同时支持rsa-3des-cbc-sha和rsa-aes-128-cbc-sha时,则该字段值为3(1+2)。 基于高安全性角度考虑,不建议配置rsa-3des-cbc-sha、rsa-aes-128-cbc-sha、rsa-aes-128-sha256和rsa-aes-256-sha256。 该字段对应UI页面上是:UI【认证和加密算法】 16 pkiDomain 否 string 0~64个字符。 - PKI域,支持设备替换default域证书。 取值范围:default 不填写该字段时: a) V600设备将替换证书到证书域nce_campus_netconf, b) AR6700V及AR6700V-L设备将替换证书到证书域default_om, b) 其他设备将替换证书到证书域default。 填写该字段时,值只能填写为default: a) V600设备中,只有V600R023C10及以上版本的AR设备支持填写此字段,将替换证书到证书域default;其他V600设备不支持此字段。 b) AR6700V及AR6700V-L设备将替换证书到证书域default_om, b) 非V600设备,将替换证书到证书域default。 该字段对应UI页面上是:UI【PKI 域名 】 "default" 表3 Entity对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipAddress 否 string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 IP地址。 该字段对应UI页面上是:UI【IP】 "10.1.1.1" fqdn 否 string 0~64个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 FQDN名称。 该字段对应UI页面上是:UI【FQDN名称】 "test.abc.com" email 否 string 0~64个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 电子邮箱地址。 该字段对应UI页面上是:UI【电子邮箱地址】 "user@abc.com" country 否 string 0~2个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 实体所属的国家代码。 "cn" state 否 string 0~32个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 实体所属的州或省。 "jiangsu" organization 否 string 0~32个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 实体所属的组织。 "huawei" department 否 string 0~191个字符。 - 实体所属的部门,支持输入多个部门,部门间以逗号分隔。字符类型可以是大小写字母、空格和特殊字符":"、".",使用逗号分隔部门,最多允许输入五个逗号且逗号前后不能全部为空格或为空,使用逗号分隔的单个OU长度不超过31位字符。 "huawei"
  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-traffic-behavior:traffic-behavior 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-traffic-behavior:traffic-behavior" : [ { "config-status" : "reserved", "last-committed-time" : "last-committed-time", "related-pkg-version" : "related-pkg-version", "edit-state" : "RUNNING", "name" : "Traffic Behavior", "description" : "Description", "filter-action" : { "filter" : "permit" }, "remark-action-colors" : { "remark-action-color" : [ { "remark-type" : "8021p", "remark-value" : 254 } ] }, "remark-actions" : { "remark-action" : [ { "action-type" : "8021p", "remark-value" : 254, "after-trust" : "enable" } ] }, "set-te-classes" : { "class-id" : 1 }, "service-class-actions" : { "service-class-action" : [ { "action-type" : "service-class", "service-class" : "be", "color" : "green", "remark-switch" : "enable", "bfd-session-name" : "BFD Session Name" } ] }, "statistic-action" : { "statistic-enable" : "Statistic enable" }, "car-actions" : { "car-action" : [ { "action-type" : "car", "cir" : 4294967294, "pir" : 4294967294, "cbs" : 4294967294, "pbs" : 4294967294, "adjust" : 10, "green-action" : "pass", "green-container" : { "green-service-class" : "be", "green-color" : "green", "green-remark-dscp" : 62 }, "yellow-action" : "pass", "yellow-container" : { "yellow-service-class" : "be", "yellow-color" : "yellow", "yellow-remark-dscp" : 62 }, "red-action" : "pass", "red-container" : { "red-service-class" : "be", "red-color" : "red", "red-remark-dscp" : 62 }, "color-aware" : "enable", "limit-type" : "pps", "share-mode" : "enable" } ] }, "pbr" : { "pbr-ipv4" : { "redirect-tunnel" : { "tunnel-name" : "Tunnel Name" }, "ipv4-nexthops" : { "nexthop-addresses" : { "nexthop-address" : [ { "ip-address" : "10.1.0.0" } ] } }, "redirect-srv6-te-policy" : { "endpoint" : "Endpoint IPv6", "color" : 4294967294, "sid-type" : "sid", "sid-ip" : "Sid IP" }, "ipv4-nexthop" : { "nexthop-address" : "10.1.0.0", "none" : { "deny" : false }, "interface" : { "if-name" : "Interface Name" } } }, "pbr-ipv6" : { "ipv6-nexthops" : { "nexthop-addresses" : { "nexthop-address" : [ { "ipv6-address" : "fc00::/7" } ] } }, "ipv6-nexthop" : { "nexthop-address" : "fc00::/7", "none" : { "deny" : false }, "interface" : { "if-name" : "Interface Name" } } } }, "flow-queue-action" : { "flow-queue-name" : "name1", "queue-name" : "name2" }, "qos-profile-action" : { "qos-profile-name" : "name1", "user-queue-name" : "name2" } } ] }
  • 响应示例 返回状态码为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-traffic-behavior:traffic-behavior 是 REFERENCE 详细请参见表4。 流行为配置。 - 表4 nes-ne-traffic-behavior-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-traffic-behavior:traffic-behavior 否 ARRAY_REFERENCE 详细请参见表5。 流行为配置。 - 表5 nes-ne-traffic-behavior对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 config-status 否 string reserved initial configuring-database configured-database-success configured-database-failed configuring-device configured-device-success configured-device-failed reserved 配置状态,对应保留未用状态、初始状态、数据库存储中状态、预配置状态、数据库存储失败状态、部署中状态、成功状态、失败状态;不支持编辑,仅查询返回。 "reserved" last-committed-time 否 string 0~255个字符。 - 最后提交时间,该特性最后提交时间;不支持编辑,仅查询返回。 "last-committed-time" related-pkg-version 否 string 0~255个字符。 - 包版本,插件包版本;不支持编辑,仅查询返回。 "related-pkg-version" edit-state 否 string RUNNING CANDIDATE UNDEPLOYING UNDEPLOYED - 编辑状态,对应运行状态、候选状态、取消部署状态、未部署状态;不支持编辑,仅查询返回。 "RUNNING" name 否 string 1~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 名称,单一主键字段。 "Traffic Behavior" description 否 string 1~127个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 描述。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。 "Description" filter-action 否 REFERENCE 详细请参见表6。 过滤动作。AR6700V主设备和AR6700V子设备不支持。 - remark-action-colors 否 REFERENCE 详细请参见表7。 重标记颜色。 - remark-actions 否 REFERENCE 详细请参见表9。 重标记。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。 - set-te-classes 否 REFERENCE 详细请参见表11。 TE Class。AR6700V主设备和AR6700V子设备不支持。 - service-class-actions 否 REFERENCE 详细请参见表12。 服务等级。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。 - statistic-action 否 REFERENCE 详细请参见表14。 统计。 - car-actions 否 REFERENCE 详细请参见表15。 流量监管。 - pbr 否 REFERENCE 详细请参见表20。 重定向。AR6700V主设备和AR6700V子设备不支持。 - flow-queue-action 否 REFERENCE 详细请参见表37。 流队列行为。 - qos-profile-action 否 REFERENCE 详细请参见表38。 QoS模板行为。 - 表6 filter-action对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 filter 否 string permit deny permit 类型。 "permit" 表7 remark-action-colors对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 remark-action-color 否 ARRAY_REFERENCE 详细请参见表8。 重标记颜色。 - 表8 remark-action-colors-remark-action-color对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 remark-type 否 string 8021p dscp qos-local-precedence mpls-exp - 标记类型,单一主键字段。 "8021p" remark-value 否 int32 [0-255] - 值。 254 表9 remark-actions对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 remark-action 否 ARRAY_REFERENCE 0-8个列表项,详细请参见表10。 重标记。 - 表10 remark-actions-remark-action对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 action-type 否 string 8021p ipv4-dscp tos ipv6-dscp ip-precedence - 操作类型,单一主键字段。 "8021p" remark-value 是 int64 [0-255] - 标记值。 254 after-trust 否 string enable - 在简单流后重新标记VLAN报文的802.1p值。 "enable" 表11 set-te-classes对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 class-id 否 int32 [1-65535] - Class ID。 1 表12 service-class-actions对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 service-class-action 否 ARRAY_REFERENCE 0-3个列表项,详细请参见表13。 指定服务等级与颜色。 - 表13 service-class-actions-service-class-action对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 action-type 否 string service-class service-class-master-bfd service-class-slave-bfd - 动作类型,单一主键字段。 "service-class" service-class 是 string be af1 af2 af3 af4 ef cs6 cs7 - 服务等级。 "be" color 是 string green yellow red - 颜色。 "green" remark-switch 否 string enable disable enable 标记开关。 "enable" bfd-session-name 否 string 1~64个字符。满足正则表达([^\s?]+[\s]*[^?]*[^\s?]+|[^\s?]*)。 - BFD 会话名称。 "BFD Session Name" 表14 statistic-action对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 statistic-enable 否 string - - 使能统计。 "Statistic enable" 表15 car-actions对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 car-action 否 ARRAY_REFERENCE 详细请参见表16。 流量监管。 - 表16 car-actions-car-action对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 action-type 否 string car - 监管类型,单一主键字段。 "car" cir 是 int64 [0-4294967295] - 承诺速率。 4294967294 pir 否 int64 [0-4294967295] - 峰值速率。 4294967294 cbs 是 int64 [0-4294967295] - 承诺突发尺寸。 4294967294 pbs 是 int64 [0-4294967295] - 峰值突发尺寸。 4294967294 adjust 否 int32 - - 调整。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。需满足:-32..-1 | 1..31. 10 green-action 是 string pass discard - 绿色报文行为。 "pass" green-container 否 REFERENCE 详细请参见表17。 绿色报文的行为参数。AR6700V主设备和AR6700V子设备不支持。 - yellow-action 否 string pass discard - 黄色报文行为。 "pass" yellow-container 否 REFERENCE 详细请参见表18。 黄色报文的行为参数。AR6700V主设备和AR6700V子设备不支持。 - red-action 是 string pass discard - 红色报文行为。 "pass" red-container 否 REFERENCE 详细请参见表19。 红色报文的行为参数。AR6700V主设备和AR6700V子设备不支持。 - color-aware 否 string enable - 色敏模式。 "enable" limit-type 否 string pps - 限制类型。AR6700V主设备,AR6700V子设备和AR6700V-L款型不支持。 "pps" share-mode 否 string enable - 共享模式。 "enable" 表17 green-container对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 green-service-class 否 string be af1 af2 af3 af4 ef cs6 cs7 - 绿色报文服务等级。 "be" green-color 否 string green yellow red - 绿色报文重新定义的颜色。 "green" green-remark-dscp 否 int32 [0-63] - 绿色报文的DHCP优先级。AR6700V-L款型不支持。 62 表18 yellow-container对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 yellow-service-class 否 string be af1 af2 af3 af4 ef cs6 cs7 - 黄色报文服务等级。 "be" yellow-color 否 string green yellow red - 黄色报文重新定义的颜色。 "yellow" yellow-remark-dscp 否 int32 [0-63] - 黄色报文的DHCP优先级。AR6700V-L款型不支持。 62 表19 red-container对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 red-service-class 否 string be af1 af2 af3 af4 ef cs6 cs7 - 红色报文服务等级。 "be" red-color 否 string green yellow red - 红色报文重新定义的颜色。 "red" red-remark-dscp 否 int32 [0-63] - 红色报文的DHCP优先级。AR6700V-L款型不支持。 62 表20 pbr对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pbr-ipv4 否 REFERENCE 详细请参见表21。 重定向IPv4。 - pbr-ipv6 否 REFERENCE 详细请参见表30。 重定向IPv6。 - 表21 pbr-ipv4对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 redirect-tunnel 否 REFERENCE 详细请参见表22。 重定向隧道。 - ipv4-nexthops 否 REFERENCE 详细请参见表23。 IPv4多下一跳。 - redirect-srv6-te-policy 否 REFERENCE 详细请参见表26。 重定向策略。 - ipv4-nexthop 否 REFERENCE 详细请参见表27。 IPv4下一跳。 - 表22 redirect-tunnel对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 tunnel-name 是 string 1~63个字符。 - 隧道名称。 "Tunnel Name" 表23 ipv4-nexthops对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nexthop-addresses 否 REFERENCE 详细请参见表24。 下一跳地址。 - 表24 ipv4-nexthops-nexthop-addresses对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nexthop-address 否 ARRAY_REFERENCE 0-16个列表项,详细请参见表25。 下一跳地址。 - 表25 nexthop-addresses-nexthop-address对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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}]+)?。 - IP地址,单一主键字段。 "10.1.0.0" 表26 redirect-srv6-te-policy对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 endpoint 是 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 端点IPv6地址。 "Endpoint IPv6" color 是 int64 [0-4294967295] - 颜色。 4294967294 sid-type 是 string sid vpnsid - Sid类型。 "sid" sid-ip 是 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - Sid IPv6地址。 "Sid IP" 表27 ipv4-nexthop对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nexthop-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}]+)?。 - 下一跳地址。 "10.1.0.0" none 否 REFERENCE 详细请参见表28。 无接口。 - interface 否 REFERENCE 详细请参见表29。 重定向接口。 - 表28 ipv4-nexthop-none对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deny 否 boolean true false false 阻断。 false 表29 ipv4-nexthop-interface对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 if-name 是 string 1~63个字符。 - 接口名称。 "Interface Name" 表30 pbr-ipv6对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv6-nexthops 否 REFERENCE 详细请参见表31。 IPv6多下一跳。 - ipv6-nexthop 否 REFERENCE 详细请参见表34。 IPv6下一跳。 - 表31 ipv6-nexthops对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nexthop-addresses 否 REFERENCE 详细请参见表32。 下一跳地址。 - 表32 ipv6-nexthops-nexthop-addresses对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nexthop-address 否 ARRAY_REFERENCE 0-16个列表项,详细请参见表33。 下一跳地址。 - 表33 nexthops-nexthop-addresses-nexthop-address对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 ipv6-address 否 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - IPv6地址,单一主键字段。 "fc00::/7" 表34 ipv6-nexthop对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 nexthop-address 是 string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 下一跳地址。 "fc00::/7" none 否 REFERENCE 详细请参见表35。 无接口。 - interface 否 REFERENCE 详细请参见表36。 重定向接口。 - 表35 ipv6-nexthop-none对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deny 否 boolean true false false 阻断。 false 表36 ipv6-nexthop-interface对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 if-name 是 string 1~63个字符。 - 接口名称。 "Interface Name" 表37 flow-queue-action对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 flow-queue-name 否 string 1~31个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - 流队列名称。 "name1" queue-name 否 string 1~31个字符。 - 流行为队列名称。 "name2" 表38 qos-profile-action对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 qos-profile-name 否 string 1~63个字符。满足正则表达[a-zA-Z0-9]([^\s]*)。 - QoS模板名称。 "name1" user-queue-name 否 string 1~31个字符。 - 用户队列名称。 "name2"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-traffic-behavior:traffic-behavior 表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的示例 PATCH /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-dhcpv4:relay 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-dhcpv4:relay" : { "global" : { "trust-option82" : true, "reply-forward-all" : 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 返回状态码为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
共100000条
提示

您即将访问非华为云网站,请注意账号财产安全