华为云用户手册

  • 响应示例 返回状态码为200:接口调用成功,响应体参考QueryPortResponse。 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" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "portType" : "GE", "portNumber" : "2/0/0", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Device1", "portSwitch" : "layer2-port", "isPhysical" : false, "stpEnable" : true, "pnpVlanEnable" : true, "linkInfo" : { "linkType" : "Ethernet", "cellular" : { "apn" : "abc" }, "atm" : { "pvcVpi" : 123, "pvcVci" : 123 }, "ethernet" : { "negotiationMode" : "auto", "media" : "copper", "duplex" : "full", "speed" : 100 } }, "isMemberEthTrunk" : true, "isMemberWanLink" : true, "isInterLink" : true, "bandwidth" : 10, "trustEnable" : false, "trust" : "dscp", "description" : "port description", "isRuLink" : true, "ruMntAddress" : "192.168.2.1", "prefixLength" : 24 } ] } 返回状态码为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/net/ports?portId=fbb684c8-0d37-496f-bafa-4b06d5151e2e&deviceId=fbb684c8-0d37-496f-bafa-4b06d5151e2e 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
  • URI /controller/campus/v1/sdwan/net/ports 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 portId 否 uuid - - 端口ID,与deviceId必填其一,如果同时存在,以portId为主。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" deviceId 否 uuid - - 设备ID,当没有指定portId时,表示查询该Device的所有port信息。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应参数 返回状态码为200:接口调用成功,响应体参考QueryPortResponse。 表2 QueryPortResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data ARRAY_REFERENCE 0-1000个列表项,详细请参见表9。 端口信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为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" : "", "success" : [ { "name" : "vpn_1", "description" : "Default", "vpnNameInDevice" : "vpn_1", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ], "overlayHeadLength" : 36, "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "ipsecEncryption" : true, "enableIPv6" : true, "defaultVpn" : true, "vpnIndex" : 0, "deleteStatus" : true } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "name" : "vpn_1", "description" : "Default", "vpnNameInDevice" : "vpn_1", "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ], "overlayHeadLength" : 36, "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "ipsecEncryption" : true, "enableIPv6" : true, "defaultVpn" : true, "vpnIndex" : 0, "deleteStatus" : true } } ] } 返回状态码为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的示例 PUT /controller/campus/v1/sdwan/overlay-network/vpn/site-attachment 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 { "vpns" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteIds" : ["fbb684c8-0d37-496f-bafa-4b06d5151e2e"], "siteRouteDistinguishers" : [ { "siteId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "routeDistinguisher" : "101:3" } ] } ] }
  • 请求示例 HTTP的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-route-policy:ext-community-filter 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-route-policy:ext-community-filter" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "name" : "filter1", "filter-type" : "basic", "basic-node" : [ { "sequence" : 1, "match-mode" : "permit", "ext-community-member" : [ { "value" : "1:1" } ] } ] } ] }
  • 响应示例 返回状态码为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-route-policy:ext-community-filter 是 REFERENCE 详细请参见表4。 扩展团体属性配置参数。 - 表4 nes-ne-ext-community-filter-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-route-policy:ext-community-filter 否 ARRAY_REFERENCE 详细请参见表5。 扩展团体属性配置参数。 - 表5 nes-ne-ext-community-filter对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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" name 否 string - - 名称,整数形式时范围1-199,字符串形式时1-51个字符且不能都是数字,单一主键字段。 "filter1" filter-type 是 string basic advanced - 过滤类型。 "basic" basic-node 否 ARRAY_REFERENCE 1-65535个列表项,详细请参见表6。 节点。 - 表6 nes-ne-ext-community-filter-basic-node对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sequence 否 int64 [1-4294967295] - 序号,单一主键字段。 1 match-mode 否 string permit deny - 匹配类型。 "permit" ext-community-member 否 ARRAY_REFERENCE 1-16个列表项,详细请参见表7。 扩展团体属性。 - 表7 nes-ne-ext-community-filter-basic-node-ext-community-member对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 value 否 string 3~21个字符。满足正则表达((([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}]+)?:(6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}|0))|((6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}|0):(([0-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5])))|((((6553[6-9])|(655[4-9]\d{1})|(65[6-9]\d{2})|(6[6-9]\d{3})|([7-9]\d{4}))|([1-9]\d{5,8})|((4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))):(6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}|0))|((6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}|0)\.(6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}|0):(6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{0,3}|0))。 - 扩展团体值,取值范围为0-65535:0-4294967295 或 0.0.0.0-255.255.255.255:0-65535 或 65536-4294967295:0-65535 或 0-65535.0-65535:0-65535,单一主键字段。 "1:1"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-route-policy:ext-community-filter 表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的示例 PUT /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-mpls:mpls 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-mpls:mpls" : { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "enable" : true, "lsr-id" : "10.1.1.1" } }
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 是 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls:mpls 是 REFERENCE 详细请参见表4。 全局MPLS配置参数。 - 表4 mpls-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-mpls:mpls 否 REFERENCE 详细请参见表5。 全局MPLS配置参数。 - 表5 mpls对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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 否 boolean true false false 使能。 true lsr-id 否 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}]+)?。 - LSR ID,IPv4地址格式。 "10.1.1.1"
  • 响应示例 返回状态码为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
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-mpls:mpls 表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:查询成功,响应体参考QueryConfigurableAppsResponse。 表2 QueryConfigurableAppsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据量。 1 data ARRAY_REFERENCE 详细请参见表3。 应用探测URL信息。 - 表3 ConfigurableAppInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 appName string - - 应用名称。 "Google" appType int32 - - 应用类型。值范围:1 表示预定义应用,2 表示自定义应用。 1 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryConfigurableAppsResponse。 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, "data" : [ { "appName" : "Google", "appType" : 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
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/application/detection-url/configurable?appName=office 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的示例 PUT /controller/campus/v1/sdwan/policy/traffic/behavior-profile 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 { "trafficBehaviors" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : false } } ] }
  • 响应示例 返回状态码为200:修改成功,响应体参考TrafficBehaviorResponse。 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", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : false } } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "data" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "type" : "qos", "redirectInfo" : { "nextHopType" : "ip", "nextHop" : "192.168.2.254", "nextHopSiteId" : "000000-0000-0000-0000-000000000000", "nextHopSiteName" : "site", "trackIp" : "192.168.2.2", "backupNextHop" : "192.168.2.224", "backupNextHopSiteId" : "000000-0000-0000-0000-000000000000", "backupNextHopSiteName" : "site", "backupTrackIp" : "192.168.2.222" }, "qosInfo" : { "id" : "00000000-0000-0000-0000-000000000000", "name" : "templateName", "inboundCar" : { "enableInboundQos" : false, "cirValue" : 1, "cirPercentage" : 10, "pirValue" : 1, "pirPercentage" : 10 }, "enableQueuePriority" : false, "priorityLevel" : "highest", "guaranteedBandwidthValue" : 1, "guaranteedBandwidthPercentage" : 10, "enableBandwidthLimit" : false, "limitType" : "CAR", "limitBandwidthValue" : 1, "limitBandwidthPeakValue" : 1, "limitBandwidthPercentage" : 10, "enableRemarkDscp" : false, "remarkDscpValue" : 10, "enableRemark8021p" : false, "remark8021pValue" : 1, "enableRemarkMplsExp" : false, "remarkMplsExpValue" : 6, "enableStatistic" : false, "enableWred" : false, "wredProfileId" : "00000000-0000-0000-0000-000000000000", "wredProfileName" : "wredProfileName", "enableQueueLength" : false, "queueByteLength" : 3000, "queuePacketLength" : 10, "wanEnable" : true, "lanEnable" : false, "tcpOptimization" : { "enableTcpOptimization" : false, "congestionControlAlgorithm" : "BBR", "sendBufferMax" : 6000 }, "weightFixEnable" : 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
  • 响应示例 返回状态码为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-bgp:vpn-bgp" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "vpn-instance" : "_public_", "router-id" : "10.1.0.0", "ipv4-unicast" : { "enable" : true, "default-route-import" : true, "route-select-delay" : 10, "reflector-cluster-id" : 10, "reflect-change-path" : true, "auto-frr" : true, "mode" : "be", "down-switch" : true, "route-relay-tunnel-v6-selector" : "policy1", "preference" : { "external" : 10, "internal" : 10, "local" : 10 }, "aggregate-route" : [ { "address" : "192.168.1.1", "mask" : 24 } ], "network-route" : [ { "address" : "192.168.1.2", "mask" : 24, "route-policy" : "policy1" } ], "import-routing" : [ { "protocol" : "static", "thead-id" : 10, "cost" : 10, "route-policy" : "policy1" } ], "evpn" : { "srv6" : { "mode" : "be", "down-switch" : true }, "locator" : [ { "name" : "name" } ] }, "advertise-l2-evpn" : { "advertise-route-to-evpn" : [ { "protocol" : "all", "advertise-route-mode" : "all" } ] }, "locator" : [ { "name" : "name" } ] }, "ipv6-unicast" : { "enable" : true, "default-route-import" : true, "route-select-delay" : 10, "reflector-cluster-id" : 10, "reflect-change-path" : true, "auto-frr" : true, "mode" : "be", "down-switch" : true, "route-relay-tunnel-v6-selector" : "policy1", "preference" : { "external" : 10, "internal" : 10, "local" : 10 }, "aggregate-route" : [ { "address" : "fc00::7", "mask" : 96 } ], "network-route" : [ { "address" : "fc00::7", "mask" : 96 } ], "import-routing" : [ { "protocol" : "static", "thead-id" : 10, "cost" : 10, "route-policy" : "policy1" } ], "evpn" : { "srv6" : { "mode" : "be", "down-switch" : true }, "locator" : [ { "name" : "name" } ] }, "advertise-l2-evpn" : { "advertise-route-to-evpn" : [ { "protocol" : "all", "advertise-route-mode" : "all" } ] }, "locator" : [ { "name" : "name" } ], "locator-routes" : [ { "locator-name" : "name" } ] }, "ipv4-vpn" : { "enable" : true, "policy-vpntarget" : true }, "l2vpn-evpn" : { "enable" : true, "policy-vpn-target" : true, "reflect-change-path" : true }, "link-state-unicast" : { "enable" : "True", "domain-identifier" : "192.168.1.1", "reflector-cluster-id" : 10 }, "ipv6-srpolicy" : { "enable" : "True", "nexthop-select-depend-type" : "default", "router-id-filter" : true }, "bgp-peer" : [ { "peer-ip" : "192.168.1.1", "peer-as" : "1", "local-as-number" : "1", "local-if-name" : "GE0/0/0", "local-if-address" : "192.168.1.1", "ebgp-max-hop" : 10, "auth-type" : "password", "password-type" : "cipher", "password-text" : "Example@123", "key-chain-name" : "aa", "timer" : { "keep-alive-time" : 10, "host-time" : 10, "connect-retry-time" : 10 }, "ipv4-unicast" : { "enable" : true, "allow-as-loop" : 1, "advertise-community" : true, "advertise-ext-community" : true, "nexthop-config" : "local", "prefix-sid" : "default", "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1", "route-update-interval" : 10 }, "ipv6-unicast" : { "enable" : true, "allow-as-loop" : 1, "advertise-community" : true, "advertise-ext-community" : true, "nexthop-config" : "local", "prefix-sid" : "default", "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "ipv4-vpn" : { "enable" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "l2vpn-evpn" : { "enable" : true, "reflect-client" : true, "export-route-policy" : "policy1", "import-route-policy" : "policy1" }, "link-state-unicast" : { "enable" : "True", "reflect-client" : true, "export-route-policy" : "policy1" }, "ipv6-srpolicy" : { "enable" : "True", "reflect-client" : true, "advertise-ext-community" : true, "graceful-restart-static-timer" : 3600 }, "bfd" : { "enable" : true, "multiplier" : 3, "min-rx-interval" : 10, "min-tx-interval" : 10 } } ] } ] } 返回状态码为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 vpn-bgp-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-bgp:vpn-bgp ARRAY_REFERENCE 详细请参见表4。 VPN BGP配置。 - 表4 nes-ne-vpn-bgp对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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" vpn-instance string 1~31个字符。 _public_ VPN,单一主键字段。 "_public_" router-id 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}]+)?。 - Router ID。 "10.1.0.0" ipv4-unicast REFERENCE 详细请参见表5。 IPv4地址族。 - ipv6-unicast REFERENCE 详细请参见表16。 IPv6地址族,6700V子设备不支持。 - ipv4-vpn REFERENCE 详细请参见表27。 VPNv4地址族,AR6700V主设备不支持。 - l2vpn-evpn REFERENCE 详细请参见表28。 L2 EVPN,AR6700V主设备不支持。 - link-state-unicast REFERENCE 详细请参见表29。 BGP-LS,AR6700V主设备和AR6700V子设备不支持。 - ipv6-srpolicy REFERENCE 详细请参见表30。 IPv6 SR-Policy,AR6700V主设备和AR6700V子设备不支持。 - bgp-peer ARRAY_REFERENCE 详细请参见表31。 BGP对等体。 - 表5 nes-ne-vpn-bgp-ipv4-unicast对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false - 使能IPv4地址族,AR6700V主设备不支持。 true default-route-import boolean true false - 引入默认路由,AR6700V主设备不支持。 true route-select-delay int32 [0-3600] - 延迟路由回切(秒),AR6700V主设备不支持。 10 reflector-cluster-id int64 [1-4294967295] - 反射器集群ID,AR6700V主设备不支持。 10 reflect-change-path boolean true false false 反射器改变路径,AR6700V主设备不支持。 true auto-frr boolean true false false Auto frr,AR6700V主设备不支持。 true mode string be te - SRv6 模式,AR6700V主设备和AR6700V子设备不支持。 "be" down-switch boolean true false - TE隧道发生故障切换TE到BE,AR6700V主设备和AR6700V子设备不支持。 true route-relay-tunnel-v6-selector string 1~40个字符。 - 隧道选择器,AR6700V主设备不支持。 "policy1" preference REFERENCE 详细请参见表6。 优先级,AR6700V主设备不支持。 - aggregate-route ARRAY_REFERENCE 详细请参见表7。 聚合路由,AR6700V主设备不支持。 - network-route ARRAY_REFERENCE 详细请参见表8。 网段路由。 - import-routing ARRAY_REFERENCE 详细请参见表9。 引入路由。 - evpn REFERENCE 详细请参见表10。 EVPN,AR6700V主设备和AR6700V子设备不支持。 - advertise-l2-evpn REFERENCE 详细请参见表13。 通告 L2 EVPN,AR6700V主设备不支持。 - locator ARRAY_REFERENCE 0-1个列表项,详细请参见表15。 Locator,AR6700V主设备和AR6700V子设备不支持。 - 表6 ipv4-unicast-preference对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 external int32 [1-255] - 外部优先级。 10 internal int32 [1-255] - 内部优先级。 10 local int32 [1-255] - 本地优先级。 10 表7 ipv4-unicast-aggregate-route对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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" mask int32 [0-32] - 聚合路由掩码,联合主键字段。 24 表8 ipv4-unicast-network-route对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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.2" mask int32 [0-32] - 网段路由掩码,联合主键字段。 24 route-policy string 1~200个字符。 - 路由策略。 "policy1" 表9 ipv4-unicast-import-routing对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 protocol string direct ospf isis static rip unr op-route - 引入路由协议,联合主键字段。 "static" thead-id int64 [0-4294967295] - 进程 ID,联合主键字段。 10 cost int64 [0-4294967295] - 花销。 10 route-policy string 1~200个字符。 - 路由策略。 "policy1" 表10 ipv4-unicast-evpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 srv6 REFERENCE 详细请参见表11。 SRv6 模式。 - locator ARRAY_REFERENCE 0-1个列表项,详细请参见表12。 Locator。AR6700V-L款型不支持。 - 表11 evpn-srv6对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 mode string be te - SRv6 模式。 "be" down-switch boolean true false false TE隧道发生故障切换TE到BE。 true 表12 evpn-locator对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表13 ipv4-unicast-advertise-l2-evpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 advertise-route-to-evpn ARRAY_REFERENCE 详细请参见表14。 通告 L2 EVPN。 - 表14 advertise-route-to-evpn-type-advertise-route-to-evpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 protocol string all - 路由协议,单一主键字段。 "all" advertise-route-mode string all best valid all VPN向evrf发布路由模式,AR6700V子设备不支持。 "all" 表15 ipv4-unicast-locator对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表16 nes-ne-vpn-bgp-ipv6-unicast对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false - 使能IPv6地址族,AR6700V主设备不支持。 true default-route-import boolean true false - 引入默认路由,AR6700V主设备不支持。 true route-select-delay int32 [0-3600] - 延迟路由回切(秒),AR6700V主设备不支持。 10 reflector-cluster-id int64 [1-4294967295] - 反射器集群ID,AR6700V主设备不支持。 10 reflect-change-path boolean true false false 反射器改变路径,AR6700V主设备不支持。 true auto-frr boolean true false false Auto frr,AR6700V主设备不支持。 true mode string be te - SRv6 模式,AR6700V主设备不支持。 "be" down-switch boolean true false - TE隧道发生故障切换TE到BE,AR6700V主设备不支持。 true route-relay-tunnel-v6-selector string 1~40个字符。 - 隧道选择器,AR6700V主设备不支持。 "policy1" preference REFERENCE 详细请参见表17。 优先级,AR6700V主设备不支持。 - aggregate-route ARRAY_REFERENCE 详细请参见表18。 聚合路由,AR6700V主设备不支持。 - network-route ARRAY_REFERENCE 详细请参见表19。 网段路由 - import-routing ARRAY_REFERENCE 详细请参见表20。 引入路由。 - evpn REFERENCE 详细请参见表21。 EVPN,AR6700V主设备不支持。 - advertise-l2-evpn REFERENCE 详细请参见表24。 通告 L2 EVPN,AR6700V主设备不支持。 - locator ARRAY_REFERENCE 详细请参见表25。 配置SRv6 locator,AR6700V主设备不支持。 - locator-routes ARRAY_REFERENCE 详细请参见表26。 Locator 路由,AR6700V主设备不支持。 - 表17 ipv6-unicast-preference对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 external int32 [1-255] - 外部优先级。 10 internal int32 [1-255] - 内部优先级。 10 local int32 [1-255] - 本地优先级。 10 表18 ipv6-unicast-aggregate-route对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 address string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 聚合路由地址,联合主键字段。 "fc00::7" mask int32 [0-128] - 聚合路由掩码,联合主键字段。 96 表19 ipv6-unicast-network-route对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 address string 满足正则表达(([^:]+:){6}(([^:]+:[^:]+)|(.*\..*)))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?)(%.+)?。 - 网段路由地址,联合主键字段。 "fc00::7" mask int32 [0-128] - 网段路由掩码,联合主键字段。 96 表20 ipv6-unicast-import-routing对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 protocol string direct isis static ospfv3 ripng unr - 引入路由协议,联合主键字段。 "static" thead-id int64 [0-4294967295] - 进程 ID,联合主键字段。 10 cost int64 [0-4294967295] - 花销。 10 route-policy string 1~200个字符。 - 路由策略。 "policy1" 表21 ipv6-unicast-evpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 srv6 REFERENCE 详细请参见表22。 SRv6。 - locator ARRAY_REFERENCE 0-1个列表项,详细请参见表23。 Locator。AR6700V-L款型不支持。 - 表22 srv6对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 mode string be te - SRv6 模式。 "be" down-switch boolean true false false TE隧道发生故障切换TE到BE。 true 表23 unicast-evpn-locator对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表24 ipv6-unicast-advertise-l2-evpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 advertise-route-to-evpn ARRAY_REFERENCE 详细请参见表14。 通告 L2 EVPN。 - 表25 ipv6-unicast-locator对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表26 ipv6-unicast-locator-routes对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 locator-name string 1~31个字符。 - Locator 名称,单一主键字段。 "name" 表27 nes-ne-vpn-bgp-ipv4-vpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false true 使能VPNv4地址族。 true policy-vpntarget boolean true false true 对接收到的VPN路由启用/禁用基于VPN目标的过滤。只有导出RT属性与本地导入RT属性匹配的VPN路由才能添加到路由表中。该选项可用于Kompella方式的跨域VPN Option B解决方案和ASBR MP-EBGP跨域L2VPN解决方案。 true 表28 nes-ne-vpn-bgp-l2vpn-evpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false - 使能L2 EVPN。 true policy-vpn-target boolean true false - 配置VPN Target。 true reflect-change-path boolean true false false 反射器改变路径,AR6700V子设备不支持。 true 表29 nes-ne-vpn-bgp-link-state-unicast对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable string - - 使能BGP-LS。 "True" domain-identifier string - - 区域标识符,IPv4地址格式。 "192.168.1.1" reflector-cluster-id int64 [1-4294967295] - 反射器集群ID。 10 表30 nes-ne-vpn-bgp-ipv6-srpolicy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable string - - 使能IPv6 SR-Policy。 "True" nexthop-select-depend-type string default depend-ip - 下一跳迭代到IP地址时路由参与选路。 "default" router-id-filter boolean true false - Router ID过滤。 true 表31 nes-ne-vpn-bgp-bgp-peer对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 peer-ip string - - 对端IPv4或IPv6地址,单一主键字段。 "192.168.1.1" peer-as string 1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。 - 对端AS。 "1" local-as-number string 1~11个字符。满足正则表达(([1-9]\d{0,8})|([1-3]\d{9})|(4[0-1]\d{8})|(42[0-8]\d{7})|(429[0-3]\d{6})|(4294[0-8]\d{5})|(42949[0-5]\d{4})|(429496[0-6]\d{3})|(4294967[0-1]\d{2})|(42949672[0-8]\d{1})|(429496729[0-5]))。 - 本端伪AS号。 "1" local-if-name string 1~63个字符。 - 接口名称。 "GE0/0/0" local-if-address string - - 接口地址。 "192.168.1.1" ebgp-max-hop int64 [1-255] - EBGP允许最大跳数。 10 auth-type string null password keychain - 认证方式。 "password" password-type string cipher simple - 密码类型。 "cipher" password-text string 1~432个字符。 - 密码。 "Example@123" key-chain-name string 1~47个字符。满足正则表达[^A-Z]+。 - key-chain。 "aa" timer REFERENCE 详细请参见表38。 保活时间。 - ipv4-unicast REFERENCE 详细请参见表32。 IPv4地址族。 - ipv6-unicast REFERENCE 详细请参见表33。 IPv6地址族,AR6700V主设备和AR6700V子设备不支持。 - ipv4-vpn REFERENCE 详细请参见表34。 VPNv4地址族,AR6700V主设备不支持。 - l2vpn-evpn REFERENCE 详细请参见表35。 L2 EVPN,AR6700V主设备不支持。 - link-state-unicast REFERENCE 详细请参见表36。 BGP-LS,AR6700V主设备和AR6700V子设备不支持。 - ipv6-srpolicy REFERENCE 详细请参见表37。 IPv6 SR-Policy,AR6700V主设备和AR6700V子设备不支持。 - bfd REFERENCE 详细请参见表39。 BFD。 - 表32 ipv4-unicast对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false - 使能IPv4地址族。 true allow-as-loop int32 [1-10] - AS号的重复次数。 1 advertise-community boolean true false - 发布团体属性。 true advertise-ext-community boolean true false - 发布扩展团体属性。 true nexthop-config string local invariable - 下一跳配置。 "local" prefix-sid string default enable disable - 使能/去使能设备与指定的IPv6对等体交换IPv4前缀SID。 "default" reflect-client boolean true false - 使能/去使能本端设备作为路由反射器(RR),将对等体或对等体组作为其客户端。此配置仅适用于IBGP对等体之间。地址族中的RR及其客户端的配置仅在该地址族中有效。因此,建议将RR及其客户端配置在所需的指定地址族中。 true export-route-policy string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" import-route-policy string 1~200个字符。 - 引入路由策略,路由策略名称。 "policy1" route-update-interval int32 [0-600] - 路由更新间隔(秒)。 10 表33 ipv6-unicast对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false - 使能IPv6地址族。 true allow-as-loop int32 [1-10] - AS号的重复次数。 1 advertise-community boolean true false - 发布团体属性。 true advertise-ext-community boolean true false - 发布扩展团体属性。 true nexthop-config string local invariable - 下一跳配置。 "local" prefix-sid string default enable disable - 使能/去使能设备与指定的IPv6对等体交换IPv4前缀SID。 "default" reflect-client boolean true false - 使能/去使能本端设备作为路由反射器(RR),将对等体或对等体组作为其客户端。此配置仅适用于IBGP对等体之间。地址族中的RR及其客户端的配置仅在该地址族中有效。因此,建议将RR及其客户端配置在所需的指定地址族中。 true export-route-policy string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" import-route-policy string 1~200个字符。 - 引入路由策略,路由策略名称。 "policy1" 表34 ipv4-vpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false - 使能VPNv4地址族。 true export-route-policy string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" import-route-policy string 1~200个字符。 - 引入路由策略,路由策略名称。 "policy1" 表35 l2vpn-evpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false - 使能L2 EVPN。 true reflect-client boolean true false - RR反射,AR6700V子设备不支持。 true export-route-policy string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" import-route-policy string 1~200个字符。 - 引入路由策略,路由策略名称。AR6700V子设备不支持。 "policy1" 表36 link-state-unicast对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable string - - 使能BGP-LS。 "True" reflect-client boolean true false - RR反射。 true export-route-policy string 1~200个字符。 - 发布路由策略,路由策略名称。 "policy1" 表37 ipv6-srpolicy对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable string - - 使能IPv6 SR-Policy。 "True" reflect-client boolean true false - RR反射。 true advertise-ext-community boolean true false - 发布扩展团体属性。 true graceful-restart-static-timer int64 [3600-2147483647] - 等待对端GR恢复的最大时间。 3600 表38 timer对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 keep-alive-time int32 [0-21845] - 存活时间(秒)。 10 host-time int32 [0-65535] - 存持时间(秒)。 10 connect-retry-time int32 [1-65535] - 连接重传时间(秒)。 10 表39 bfd对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 enable boolean true false - 使能BFD。 true multiplier int64 [3-50] - 本地检测倍数。 3 min-rx-interval int64 [3-20000] - 最小接收间隔(毫秒)。 10 min-tx-interval int64 [3-20000] - 最小发送间隔(毫秒)。 10 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:接口调用成功,响应体参考DeviceHealthListDto。 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" : 12, "data" : [ { "timestamp" : 1537407600, "deviceHealthPoint" : 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
  • URI /controller/campus/v1/performanceservice/basicperformance/trend/{siteId} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,UUID格式。 "5cd2d350-b530-4469-8df6-4e5b6c70ff6d" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceType 是 int32 - - 设备类型,该字段废弃,请填1。 1 beginTime 是 int64 - - 起始格林威治时间(时间精确到毫秒)。 1568044800561 endTime 是 int64 - - 结束格林威治时间(时间精确到毫秒)。 1568044800561
  • 请求示例 HTTP的示例 GET /controller/campus/v1/performanceservice/basicperformance/trend/5cd2d350-b530-4469-8df6-4e5b6c70ff6d?deviceType=1&beginTime=1568044800561&endTime=1568044800561 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:接口调用成功,响应体参考DeviceHealthListDto。 表3 DeviceHealthListDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" totalRecords integer [0-289] - 所有返回结果数。 12 data ARRAY_REFERENCE 0-289个列表项,详细请参见表4。 查询到的设备健康度。 - 表4 DeviceHealthDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 timestamp int64 [0-2147483647] - 时间戳。 1537407600 deviceHealthPoint int32 [0-100] - 设备健康点,表示设备健康度。 0 返回状态码为400:参数非法,查询失败。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-bgp:vpn-bgp 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-bgp:vpn-bgp 表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"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-direct-route-vlink:vlink-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/3"
  • 响应示例 返回状态码为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-direct-route-vlink:vlink-if/GE0%2F0%2F3 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"
共100000条
提示

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