华为云用户手册

  • 响应示例 返回状态码为200:成功查询RADIUS服务器模板信息。 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 { "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 1, "errcode" : "0", "errmsg" : "", "data" : [ { "name" : "radius1", "description" : "radius1", "multipleBackupServerConfig" : true, "radiusServerType" : "thirdPartyServer", "iaeDtoList" : [ { "iaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "iaeName" : "iae12", "iaeIp" : "192.168.1.1", "iaeAd" : "example.com", "iaeIpv6" : "FC00::0", "weight" : 80, "slaveIaeId" : "ce67b74c-01ac-4e2a-81af-0908d98ea242", "slaveIaeName" : "iae12", "slaveIaeIp" : "192.168.1.1", "slaveIaeAd" : "example.com", "slaveIaeIpv6" : "FC00::0" } ], "authServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "accountServerList" : [ { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10, "weight" : 80 } ], "masterAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAuthServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "masterAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.1", "port" : 10 }, "slaveAccountServer" : { "serverAddressType" : "ip", "serverAddress" : "192.168.1.2", "port" : 10 }, "realtimeAccounting" : { "realtimeEnable" : true, "realtimeInterval" : 10 }, "serverSelectionPolicy" : "master-backup", "serverSelectionAlgorithm" : "packets", "dpskConfig" : { "supportDpsk" : true, "dpskEncryptionMode" : "aes256gcm" }, "prohibitAttribute" : { "enable" : true, "attributes" : [ { "attributeName" : "HW-Input-Peak-Information-Rate", "prohibitReceive" : true, "prohibitSend" : true } ] }, "radiusAttributeConfig" : { "enable" : true, "attributes" : [ { "attributeName" : "Service-Type", "attributeValue" : "241", "optionValue" : "auth-type-mac", "macValue" : "10", "dot1xValue" : "2", "portalValue" : "4" } ] }, "calledStationId" : { "enable" : true, "attributeValue" : "ap-mac", "includeSsid" : true, "delimiter" : "+" }, "macFormatSetting" : { "macFormat" : true, "letter" : "uppercase", "connector" : "hyphen-split", "mode" : "XX" }, "enableAutomaticServerStatusDetection" : true, "automaticServerStatusDetection" : { "name" : "test", "password" : "null", "upServerInterval" : "" }, "enableAuthRequestRetransmitConfig" : true, "authRequestRetransmitConfig" : { "timeoutRetransmissionTimes" : 3, "timeoutInterval" : 5, "serverDownDuration" : 5 }, "sourceIpEnable" : true, "nassPortIdFormat" : "new", "translateExtendList" : [ { "accessAccept" : true, "accountResponse" : false, "srcVendorId" : 9, "srcSubId" : 2, "destAttributeName" : "HW-Input-Committed-Burst-Size" } ], "startAccountingFail" : true, "configName" : "abc", "id" : "fbb684c8-0d37-496f-bafa-4b06db151e2e" } ] } 返回状态码为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/v1/networkservice/networkconfig/profile/radius 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageSize 否 int32 - - 每页大小。 20 pageIndex 否 int32 - - 页码。 1 type 否 string 0~100个字符。 - 服务器类型,查询类型如果有多个以逗号分隔,如thirdPartyServer,builtInServer,hybridServer;当前服务器类型仅包括第三方、内置、混合。 "thirdPartyServer,builtInServer,hybridServer"
  • 响应示例 返回状态码为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-vpn:vpn" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "instance-name" : "vpn1", "af" : [ { "type" : "ipv4-unicast", "route-distinguisher" : "1:1", "vpn-target" : [ { "value" : "1:1", "vpn-target-type" : "export-extcommunity" } ], "import-policy" : "policy1", "export-policy" : "policy2" } ] } ] } 返回状态码为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 vpn-list对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-vpn:vpn ARRAY_REFERENCE 详细请参见表4。 VPN配置参数。 - 表4 nes-ne-vpn对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 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" instance-name string 1~31个字符。 - VPN实例名,单一主键字段。 "vpn1" af ARRAY_REFERENCE 0-2个列表项,详细请参见表5。 地址族。 - 表5 nes-ne-vpn-af对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 type string ipv4-unicast ipv6-unicast - 地址族类型,AR6700V仅支持ipv4-unicast,单一主键字段。 "ipv4-unicast" route-distinguisher string 3~21个字符。 - Route Distinguisher。当云网元为管理网元时,不支持配置。 "1:1" vpn-target ARRAY_REFERENCE 详细请参见表6。 VPN Target。 - import-policy string 1~200个字符。 - 接收路由策略。_public_ VPN不支持配置、Route Distinguisher未填写时,不支持配置。AR6700V主设备不支持。 "policy1" export-policy string 1~200个字符。 - 发布路由策略。_public_ VPN不支持配置、Route Distinguisher未填写时,不支持配置。AR6700V主设备不支持。 "policy2" 表6 nes-ne-vpn-af-vpn-target对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 value string 3~21个字符。 - VPN Target值,联合主键字段。 "1:1" vpn-target-type string import-extcommunity export-extcommunity - VPN Target类型。当云网元为管理网元时,不支持配置,联合主键字段。 "export-extcommunity" 返回状态码为400:请求参数错误。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-vpn:vpn 表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-vpn:vpn 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 restconf-transaction-id: "00000000-0000-0000-0000-000000000000"
  • 请求示例 HTTP的示例 GET /controller/campus/v1/lanwan/interconnection/route/static?vnId=fbb684c8-0d37-496f-bafa-4b06d5151e2e&siteId=fbb684c8-0d37-496f-bafa-4b06d5151e2e&linkId=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-ACCESS-TOKEN: x-yyyyyy
  • URI /controller/campus/v1/lanwan/interconnection/route/static 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vnId 是 string 36个字符。 - VN标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" siteId 是 string 36个字符。 - 站点标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" linkId 否 string 36个字符。 - 互联标识。uuid格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应参数 返回状态码为200:获取IPv4静态路由返回参数。 表2 QueryRouteStaticResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" totalRecords int32 [0-1000] - 总记录数 100 data ARRAY_REFERENCE 0-512个列表项,详细请参见表5。 查询到的IPv4静态路由数据集合。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:获取IPv4静态路由返回参数。 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" : 100, "data" : [ { "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "coreStaticInfoList" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "platform" : "platform", "priority" : 120, "destIp" : "192.168.10.0/24", "nextHopType" : "ip-address", "nextHopIpAddress" : "192.168.10.1", "isTracked" : false, "trackTargetIpAddress" : "192.168.10.1", "configSource" : "LANWAN" } ], "gatewayStaticInfoList" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "linkName" : "ConnectLink", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "deviceName" : "Core-1", "deviceType" : "LSW", "platform" : "platform", "priority" : 120, "destIp" : "192.168.10.0/24", "nextHopType" : "ip-address", "nextHopIpAddress" : "192.168.10.1", "isTracked" : false, "trackTargetIpAddress" : "192.168.10.1", "configSource" : "LANWAN" } ] } ] } 返回状态码为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/baseservice/api/v1/device/stack/action/batch-delete HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy { "stackIds" : ["d25de9be-1d9a-4d06-a519-09ff92fee050","d25de9be-1d9a-4d06-a519-09ff92fee050"] }
  • 响应示例 返回状态码为200:删除堆叠成功,响应体参考DeleteStackOut。 返回状态码为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 { "errorCode": 0, "errorMsg": null, "totalSize": 2, "regionDetails": [ { "nodeId": "7f75baad-c780-43a0-b2df-40e77b602e93", "tenantId": null, "siteId": null, "resType": "Region", "name": "2F", "remark": null, "parentNodeId": "82cc0ef8-0a10-4a44-bdb2-47244a7b6059", "posX": 564.0, "posY": 300.0, "longitude": null, "latitude": null, "scaleLength": "0.01999", "bgImageName": "1685515888186.jpg", "regionType": "region" }, { "nodeId": "09e6f195-65f6-44e3-a4c1-b366b3d2c044", "tenantId": null, "siteId": null, "resType": "Region", "name": "1F", "remark": null, "parentNodeId": "82cc0ef8-0a10-4a44-bdb2-47244a7b6059", "posX": 500.0, "posY": 300.0, "longitude": null, "latitude": null, "scaleLength": "0.01229", "bgImageName": null, "regionType": "region" } ] } 返回状态码为400:参数错误 HTTP/1.1 400 Bad Request Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为403:URL鉴权 HTTP/1.1 403 Forbidden Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为404:rest接口没找到 HTTP/1.1 404 Not Found Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为406:流控限流 HTTP/1.1 406 Not Acceptable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为500:默认ServiceException异常码,应用内部错误 HTTP/1.1 500 Internal Server Error Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为502:网关错误 HTTP/1.1 502 Bad Gateway Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为503:服务不可用 HTTP/1.1 503 Service Unavailable Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive 返回状态码为504:表示时间超时,总线超时时间300s HTTP/1.1 504 Gateway Timeout Date: Tue,30 Oct 2018 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
  • URI /rest/openapi/network/wlan/region-topo/region-details 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 params 是 string 0~8192个字符。 - 查询区域详情的过滤条件(参数项含义可参考OpenApiRegionDetailQueryModel模型)。 必填参数项:page、limit、siteId(站点Id,已规划站点时必填,其他场景不填该参数)。 可选参数项:sortColumn、sortMode、regionIds、regionTypes、name、remark、posX、posY、longitude、latitude。 {"page" : 1, "limit" : 20, "sortColumn" : "regionType", "sortMode" : "asc", "regionIds" : [ "980f46a9-a25d-48cb-ac45-b263fb511740" ], "regionTypes" : [ "region" ], "name" : "floor1", "remark" : "", "posX" : 500, "poxY" : 300}
  • 响应参数 返回状态码为200:返回操作是否成功 表2 OpenApiRegionDetailsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errorCode int32 - - 状态码 - errorMsg string - - 新增、修改、删除异常时的错误信息 - totalSize int32 - - 区域详情总条数 - regionDetails ARRAY_REFERENCE 详细请参见表3。 区域详情列表 - 表3 OpenApiRegionDetailModel对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 nodeId string - - 对象ID - tenantId string - - 租户ID - siteId string - - 站点ID - resType string - - 资源类型 - name string - - 对象名称 - remark string - - 描述信息 - parentNodeId string - - 父节点ID - posX double - - 节点的X坐标 - posY double - - 节点的Y坐标 - longitude double - - 经度 - latitude double - - 纬度 - regionType string - - 区域类型 - scaleLength string - - 比例尺长度 - bgImageName string - - 背景图名称 - 返回状态码为400:参数错误 详细信息请参见实际响应消息体。 返回状态码为403:URL鉴权 详细信息请参见实际响应消息体。 返回状态码为404:rest接口没找到 详细信息请参见实际响应消息体。 返回状态码为406:流控限流 详细信息请参见实际响应消息体。 返回状态码为500:默认ServiceException异常码,应用内部错误 详细信息请参见实际响应消息体。 返回状态码为502:网关错误 详细信息请参见实际响应消息体。 返回状态码为503:服务不可用 详细信息请参见实际响应消息体。 返回状态码为504:表示时间超时,总线超时时间300s 详细信息请参见实际响应消息体。
  • 请求示例 cURL的示例 curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language: en-US' -H 'X-ACCESS-TOKEN: x-yyyyyy' 'https://192.168.1.125:18002/rest/openapi/network/wlan/region-topo/region-details?params={page : 1, limit : 20, sortColumn : regionType, sortMode : asc, regionIds : [ 980f46a9-a25d-48cb-ac45-b263fb511740 ], regionTypes : [ region ], name : floor1, remark : , posX : 500, poxY : 300}' HTTP的示例 GET /rest/openapi/network/wlan/region-topo/region-details?params={page : 1, limit : 20, sortColumn : regionType, sortMode : asc, regionIds : [ 980f46a9-a25d-48cb-ac45-b263fb511740 ], regionTypes : [ region ], name : floor1, remark : , posX : 500, poxY : 300} 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: 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" : { "pageIndex" : 1, "pageSize" : 20, "totalRecords" : 30, "totalPage" : 2, "areaResList" : [ { "areaType" : "stub", "areaId" : "60e2e8a3cdf3470ea4d4f468c8b74095", "areaUUID" : "", "networkList" : ["192.168.0.1/24"], "abrSummaryList" : [ { "ipAddress" : "192.168.0.1/24" } ], "stubNoSummary" : false } ] }, "errcode" : "0", "errmsg" : "" }
  • 响应参数 返回状态码为200: 表3 QueryAreaListRes对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 data REFERENCE 详细请参见表4。 区域配置信息 - errcode string 1~128个字符。 - 错误码 "0" errmsg string 1~512个字符。 - 错误信息 - 表4 AreaInfoList对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 pageIndex int32 [1-65535] - 页面索引。 1 pageSize int32 [1-65535] - 每页显示记录数。 20 totalRecords int32 [1-65535] - 全量记录数。 30 totalPage int32 [1-65535] - 总体分页数。 2 areaResList ARRAY_REFERENCE 详细请参见表8。 区域信息。 -
  • 请求示例 HTTP的示例 GET /controller/campus/api/v1/networkconfig/lswospf/fbb684c8-0d37-496f-bafa-4b06d5151e2e/a63b91f86bbe415a92a4a5af437c858f/area 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/api/v1/networkconfig/lswospf/{deviceId}/{ospfId}/area 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 string 36个字符。 - 设备ID,UUID格式。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" ospfId 是 string 32个字符。 - OSPF ID。 "a63b91f86bbe415a92a4a5af437c858f" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 filter 否 string 0~256个字符。 - 查询过滤条件。pageIndex::1|pageSize::20|areaId::1 -
  • 响应示例 返回状态码为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
  • 请求示例 HTTP的示例 DELETE /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"
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-dhcpv4:relay 表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:查询随流检测防仿冒报文配置成功后的状态返回码。 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" : "Success", "deviceIds" : ["9a157da3-9e59-41c9-8312-254a38a3b275"] } 返回状态码为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/ipv6bgp-advance-config?vpnId=a99f794e-b510-438c-a75d-de59f02347eb&tnpId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&deviceId=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
  • 响应示例 返回状态码为200:接口调用成功,响应体参考QueryIpv6BgpAdvanceResponse。 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", "tnpId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "vpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "addressFamilyGlobals" : [ { "familyType" : "ipv6-unicast", "externalPreference" : 201, "maxLoadBalanceNum" : 1, "defaultRouteRedistribution" : false, "compareDifAsMed" : false, "routeRedistribution" : [ "direct" ], "ipv6AggregationRoute" : [ "fc00::/64" ] } ] } ] } 返回状态码为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/v1/sdwan/routing-protocol/ipv6bgp-advance-config 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 否 uuid - - VPN ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" tnpId 否 uuid - - TNP ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" siteId 是 uuid - - 站点ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb" deviceId 否 uuid - - 设备ID,UUID格式。 "a99f794e-b510-438c-a75d-de59f02347eb"
  • URI /controller/campus/v1/networkservice/networkconfig/net/lswport/devices/{deviceId}/ethtrunk-ports 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceId 是 uuid - - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e"
  • 响应示例 返回状态码为200:创建交换机EthTrunk端口成功,返回EthTrunk端口信息结构体参见EthTrunkResponseDto。 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" : { "status" : true, "description" : "LSW interface", "linkType" : "trunk", "defaultVlan" : 1, "allowPassVlan" : "1,3-10", "untaggedVlan" : "11,12-16", "taggedVlan" : "1,3-10", "arpSnoopingEnable" : false, "dhcpSnooping" : false, "dhcpSnoopingTrusted" : false, "ndSnooping" : false, "ndSnoopingTrusted" : false, "portIsolation" : false, "stp" : true, "stpEdgedport" : "normal", "bpduFilter" : "normal", "enableRelay" : false, "enableMadDetection" : false, "domainId" : 16, "naMsgCheck" : false, "nsMsgCheck" : false, "rsMsgCheck" : false, "ipsgCheck" : false, "daiCheck" : false, "collectDynamicMac" : false, "restoreIpSubnetVlanDefault" : false, "ipSubnetVlanEnable" : false, "linkUpDownTrapEnable" : true, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "loopbackDetectEnabled" : false, "loopbackDetectAction" : "shutdown", "loopbackDetectVlans" : "1,3-8", "loopbackDetectRecoveryTime" : 16, "trust" : "dscp", "loadBalance" : "src-dst-ip", "lacpPriorityValue" : 32768, "portSecurityEnable" : false, "portSecurityMaxinum" : 1, "stickyEnable" : false, "manualUpStream" : true, "outboundTrafficPolicy" : "aaa", "inboundTrafficPolicy" : "bbb", "voiceVlanEnable" : false, "voiceVlanId" : 2, "voiceVlanMode" : "tag", "isolate" : false, "arpExpireTime" : 1200, "portSecurityAction" : "protect", "portSecurityAgingTime" : 1440, "portSecurityAgingType" : "absolute", "ethTrunkMode" : "manual", "ethPnpStartSwitchEnable" : false, "LswEthTrunkLacpConfigDto" : { "lacpMode" : "customize", "lacpForceForward" : false, "leastActivenum" : 1, "maxActivenum" : 8, "lacpPreempt" : false, "preemptDelayTime" : 30, "lacpTimeoutType" : "fast", "lacpTimeoutNum" : 3 }, "portMemberList" : ["GigabitEthernet0/0/1","GigabitEthernet0/0/2"], "name" : "Eth-Trunk1" } } 返回状态码为201:创建交换机EthTrunk端口成功,返回EthTrunk端口信息,结构体参见EthTrunkResponseDto。 HTTP/1.1 201 Created 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" : { "status" : true, "description" : "LSW interface", "linkType" : "trunk", "defaultVlan" : 1, "allowPassVlan" : "1,3-10", "untaggedVlan" : "11,12-16", "taggedVlan" : "1,3-10", "arpSnoopingEnable" : false, "dhcpSnooping" : false, "dhcpSnoopingTrusted" : false, "ndSnooping" : false, "ndSnoopingTrusted" : false, "portIsolation" : false, "stp" : true, "stpEdgedport" : "normal", "bpduFilter" : "normal", "enableRelay" : false, "enableMadDetection" : false, "domainId" : 16, "naMsgCheck" : false, "nsMsgCheck" : false, "rsMsgCheck" : false, "ipsgCheck" : false, "daiCheck" : false, "collectDynamicMac" : false, "restoreIpSubnetVlanDefault" : false, "ipSubnetVlanEnable" : false, "linkUpDownTrapEnable" : true, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "loopbackDetectEnabled" : false, "loopbackDetectAction" : "shutdown", "loopbackDetectVlans" : "1,3-8", "loopbackDetectRecoveryTime" : 16, "trust" : "dscp", "loadBalance" : "src-dst-ip", "lacpPriorityValue" : 32768, "portSecurityEnable" : false, "portSecurityMaxinum" : 1, "stickyEnable" : false, "manualUpStream" : true, "outboundTrafficPolicy" : "aaa", "inboundTrafficPolicy" : "bbb", "voiceVlanEnable" : false, "voiceVlanId" : 2, "voiceVlanMode" : "tag", "isolate" : false, "arpExpireTime" : 1200, "portSecurityAction" : "protect", "portSecurityAgingTime" : 1440, "portSecurityAgingType" : "absolute", "ethTrunkMode" : "manual", "ethPnpStartSwitchEnable" : false, "LswEthTrunkLacpConfigDto" : { "lacpMode" : "customize", "lacpForceForward" : false, "leastActivenum" : 1, "maxActivenum" : 8, "lacpPreempt" : false, "preemptDelayTime" : 30, "lacpTimeoutType" : "fast", "lacpTimeoutNum" : 3 }, "portMemberList" : ["GigabitEthernet0/0/1","GigabitEthernet0/0/2"], "name" : "Eth-Trunk1" } }
  • 请求示例 HTTP的示例 POST /controller/campus/v1/networkservice/networkconfig/net/lswport/devices/fbb684c8-0d37-496f-bafa-4b06d5151e2e/ethtrunk-ports 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 { "status" : true, "description" : "LSW interface", "linkType" : "trunk", "defaultVlan" : 1, "allowPassVlan" : "1,3-10", "untaggedVlan" : "11,12-16", "taggedVlan" : "1,3-10", "arpSnoopingEnable" : false, "dhcpSnooping" : false, "dhcpSnoopingTrusted" : false, "ndSnooping" : false, "ndSnoopingTrusted" : false, "portIsolation" : false, "stp" : true, "stpEdgedport" : "normal", "bpduFilter" : "normal", "enableRelay" : false, "enableMadDetection" : false, "domainId" : 16, "naMsgCheck" : false, "nsMsgCheck" : false, "rsMsgCheck" : false, "ipsgCheck" : false, "daiCheck" : false, "collectDynamicMac" : false, "restoreIpSubnetVlanDefault" : false, "ipSubnetVlanEnable" : false, "linkUpDownTrapEnable" : true, "mdnsSnoopingEnable" : false, "dnsSnoopingEnable" : false, "loopbackDetectEnabled" : false, "loopbackDetectAction" : "shutdown", "loopbackDetectVlans" : "1,3-8", "loopbackDetectRecoveryTime" : 16, "trust" : "dscp", "loadBalance" : "src-dst-ip", "lacpPriorityValue" : 32768, "portSecurityEnable" : false, "portSecurityMaxinum" : 1, "stickyEnable" : false, "manualUpStream" : true, "outboundTrafficPolicy" : "aaa", "inboundTrafficPolicy" : "bbb", "voiceVlanEnable" : false, "voiceVlanId" : 2, "voiceVlanMode" : "tag", "isolate" : false, "arpExpireTime" : 1200, "portSecurityAction" : "protect", "portSecurityAgingTime" : 1440, "portSecurityAgingType" : "absolute", "ethTrunkMode" : "manual", "ethPnpStartSwitchEnable" : false, "LswEthTrunkLacpConfigDto" : { "lacpMode" : "customize", "lacpForceForward" : false, "leastActivenum" : 1, "maxActivenum" : 8, "lacpPreempt" : false, "preemptDelayTime" : 30, "lacpTimeoutType" : "fast", "lacpTimeoutNum" : 3 }, "portMemberList" : ["GigabitEthernet0/0/1","GigabitEthernet0/0/2"] }
共99354条