华为云用户手册

  • 响应示例 返回状态码为200:修改成功,响应体参考SessionWhitelistResponse。 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" : [ { "policyId" : "00000000-0000-0000-0000-000000000000", "policyName" : "policy1", "deviceId" : "00000000-0000-0000-0000-000000000000", "deviceName" : "device1", "ruleCount" : 1, "sessionWhitelistType" : "spr,firewall", "aclRules" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "priority" : 1, "action" : "permit", "protocolNum" : 1, "sourceIP" : "192.168.0.0/16", "destinationIP" : "192.168.0.0/16", "sourcePortStart" : 1, "sourcePortEnd" : 1, "destinationPortStart" : 1, "destinationPortEnd" : 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:查询站点成功,响应体参考QuerySiteResponse。 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" : 200, "pageSize" : 20, "pageIndex" : 1, "data" : [ { "id" : "a99f794e-b510-438c-a75d-de59f02347eb", "name" : "site1", "locations" : [ { "name" : "Beijing", "address" : "Beijing", "floor" : "5F", "postcode" : "100000", "latitude" : "39.92", "longitude" : "116.46" } ], "devices" : [ { "deviceId" : "a99f794e-b510-438c-a75d-de59f02347eb", "locationName" : "nanjing" } ], "siteType" : "single-gateway", "interLink" : { "type" : "l3-interface", "enableGre" : false, "vlanMin" : 4000, "vlanMax" : 4008, "extendVlans" : ["1:9"], "portPairs" : [ { "device1PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortId" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device1PortType" : "GE", "device1PortNum" : "0/0/1", "device1PortAddress" : "192.168.101.1", "device1PortMask" : 24, "device2Id" : "a99f794e-b510-438c-a75d-de59f02347eb", "device2PortType" : "GE", "device2PortNum" : "0/0/1", "device2PortAddress" : "192.168.101.1", "device2PortMask" : 24 } ], "mtu" : 1500, "mss" : 1200 }, "role" : ["sd-wan-edge","evpn-rr"], "controlPoints" : ["a99f794e-b510-438c-a75d-de59f02347eb"], "timeZone" : "(UTC+08:00)Beijing,Chongqing,Hong Kong,Urumqi", "enableSummerConfig" : "", "enableAutoConfig" : true, "daylightSavingTime" : { "name" : "Atlantic/Canary", "offset" : "01:00", "enableWeekDay" : false, "startTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 }, "stopTime" : { "month" : "Jan", "time" : "23:59", "week" : "first", "weekday" : "Mon", "day" : 21 } }, "contact" : { "responsiblePerson" : "Jack Lee", "phoneNumber" : "152xxxxxxxx", "emails" : ["xxx@xxx.xxx"] }, "description" : "sdwan Site", "tag" : "tagHub", "isolated" : false, "enhancedMode" : 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的示例 GET /controller/campus/v1/sdwan/net/sites?pageIndex=1&pageSize=20&sort=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-AC CES S-TOKEN: x-yyyyyy
  • 响应参数 返回状态码为200:查询站点成功,响应体参考QuerySiteResponse。 表2 QuerySiteResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 每页显示数量。 20 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表12。 Site信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • URI /controller/campus/v1/networkconfig/profile/securityzones 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 name 否 string 0~64个字符。 - 安全 域名 称,不支持模糊查询。 "zonea" pageIndex 是 integer - - 当前页码。 "1" pageSize 是 integer [1-100] - 每页数量。 "30"
  • 响应示例 返回状态码为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" : "inner error", "totalRecords" : "9999", "pageIndex" : "1", "pageSize" : "30", "data" : [ { "zoneId" : "00000000-0000-0000-0000-00000000000f", "name" : "dmzzz", "priority" : "88", "description" : "finance dmz", "predefined" : 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的示例 GET /controller/campus/v1/networkconfig/profile/securityzones?name=zonea&pageIndex=1&pageSize=30 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:查询成功。 表2 PageQueryZoneResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "inner error" totalRecords integer - - 满足条件的记录总数。 "9999" pageIndex integer - - 页码 "1" pageSize integer - - 每页数量 "30" data ARRAY_REFERENCE 0-100个列表项,详细请参见表3。 安全域列表 - 返回状态码为400:校验失败。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 PUT /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-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000" { "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" } ] } ] }
  • 响应示例 返回状态码为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-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"
  • 请求参数 表2 header参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 restconf-transaction-id 否 string - - 事务ID。 "00000000-0000-0000-0000-000000000000" 表3 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-vpn:vpn 是 REFERENCE 详细请参见表4。 VPN配置参数。 - 表4 nes-ne-vpn-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-vpn:vpn 否 ARRAY_REFERENCE 详细请参见表5。 VPN配置参数。 - 表5 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个列表项,详细请参见表6。 地址族。 - 表6 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 详细请参见表7。 VPN Target。 - import-policy 否 string 1~200个字符。 - 接收路由策略。_public_ VPN不支持配置、Route Distinguisher未填写时,不支持配置。AR6700V主设备不支持。 "policy1" export-policy 否 string 1~200个字符。 - 发布路由策略。_public_ VPN不支持配置、Route Distinguisher未填写时,不支持配置。AR6700V主设备不支持。 "policy2" 表7 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"
  • 响应示例 返回状态码为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-detachment 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" } ] } ] }
  • 响应示例 返回状态码为200:删除成功,响应体参考CommonResponse。 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" : "" } 返回状态码为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 /controller/campus/v1/sdwan/netstream/00000000-0000-0000-0000-000000000000/interface HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • 请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/overlay-network/iwg-interworking/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 { "iwgPolicyInfos" : [ { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 1 } ] }
  • 响应示例 返回状态码为200:接口调用成功,响应体参考IwgPolicyResponse。 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" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 1 } ], "fail" : [ { "errcode" : "0", "errmsg" : "", "data" : { "id" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "siteId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "localVpnId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "remoteVpnImportRt" : ["123:123","124:124"], "remoteVpnExportRt" : ["123:123","124:124"], "remoteVpnIpv6ImportRt" : ["123:123","124:124"], "remoteVpnIpv6ExportRt" : ["123:123","124:124"], "diffservMode" : "pipe", "mplsExp" : 1 } } ] } 返回状态码为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 返回状态码为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:通知成功,响应体参考NotifyMdmInfoOutputDto。 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" : [ "xx-xx-xx-xx-xx-xx" ], "failure" : [ { "errcode" : "101", "errmsg" : "Fail to find the mdm info that need updated", "data" : "xx-xx-xx-xx-xx-xx" } ] } 返回状态码为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/v1/accountservice/securityapi/notifycompliancestatues/00000000-0000-0000-0000-000000000001 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 { "deviceinfos" : [ { "mac" : "xx-xx-xx-xx-xx-xx", "ip" : "192.168.1.2", "tid" : "6c3540374a6837b20212efe25ac75123", "mdmAttributeValue" : "92", "complianceStatus" : "NOT_COMPLY", "timeStamp" : "1508923416" } ] }
  • 请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 NotifyMdmInfoInputDto 是 REFERENCE 详细请参见表3。 通知mdm信息入参 - 表3 NotifyMdmInfoInputDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 deviceinfos 否 ARRAY_REFERENCE 1-1000个列表项,详细请参见表4。 待更新的mdm终端信息集合。 - 表4 UpdateMdmInfoDto对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 mac 是 string 17个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 绑定设备的MAC,MAC的格式支持xx-xx-xx-xx-xx-xx。 "xx-xx-xx-xx-xx-xx" ip 否 string - - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 终端ip地址,ipv4。 "192.168.1.2" tid 否 string 0~36个字符。 - 第三方系统中终端设备的唯一标识, 可为空。 "6c3540374a6837b20212efe25ac75123" mdmAttributeValue 否 string 0~64个字符。 - mdm属性值 "92" complianceStatus 是 string NOT_COMPLY COMPLIANT NA - 合规状态, 判断终端是否违规,1)NOT_COMPLY:不合规,2)COMPLIANT:合规, 3)NA: 不涉及(设备不存在、还未注册等情况) "NOT_COMPLY" timeStamp 否 string 10~13个字符。 - 当前时间戳 "1508923416"
  • 响应参数 返回状态码为200:查询成功,响应体参考QueryLocalAccessPolicyResponse。 表2 QueryLocalAccessPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表8。 站点本地上网策略信息。 - 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为200:查询成功,响应体参考QueryLocalAccessPolicyResponse。 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, "pageSize" : 10, "pageIndex" : 1, "data" : [ { "id" : "000000-0000-0000-0000-000000000000", "vpnId" : "000000-0000-0000-0000-000000000000", "vpnName" : "VPN1", "siteId" : "000000-0000-0000-0000-000000000000", "siteName" : "site1", "trackIP" : "10.12.13.14", "enableVas" : true, "classificationProfiles" : [ "000000-0000-0000-0000-000000000000" ], "enableLocalFirst" : true, "masterSiteSource" : "tenant", "masterSiteId" : "000000-0000-0000-0000-000000000000", "masterSiteName" : "site1", "backupSiteSource" : "tenant", "backupSiteId" : "000000-0000-0000-0000-000000000000", "backupSiteName" : "site1", "internetAccessType" : "localAccess", "transportNetworkConfigs" : [ { "transportNetworkPortId" : "000000-0000-0000-0000-000000000000", "transportNetworkPortName" : "internet1", "transportNetworkPortVpnName" : "underlay_1", "enableNat" : true, "enableIpv6" : true, "priority" : "1", "bandwidth" : 10, "trackIP" : "10.12.13.14", "dhcpTrackIP" : "10.12.13.14", "mtu" : 9000, "downlinkBandwidth" : 1000, "uplinkBandwidth" : 1000, "downlinkQos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "rulePriority" : 1, "ruleClassificationId" : "00000000-0000-0000-0000-000000000000", "ruleClassificationName" : "qosClassificationName", "ruleProfileId" : "00000000-0000-0000-0000-000000000000", "ruleProfileName" : "templateName" } ], "uplinkQos" : [ { "ruleId" : "00000000-0000-0000-0000-000000000000", "rulePriority" : 1, "ruleClassificationId" : "00000000-0000-0000-0000-000000000000", "ruleClassificationName" : "qosClassificationName", "ruleProfileId" : "00000000-0000-0000-0000-000000000000", "ruleProfileName" : "templateName" } ] } ], "ipsecTunnelConfigs" : [ { "trackIP" : "10.12.13.14", "wanLinkName" : "AR 104", "deviceName" : "AR 104", "id" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "priority" : "1", "tunnelPortName" : "Tunnel0/0/400", "wanLinkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6", "ipAddress" : "192.168.0.1/24", "srcIpAddress" : "192.168.1.1", "srcType" : "IP", "srcInterfaceId" : "00000000-0000-0000-0000-000000000000", "dstIpAddress" : "192.168.1.2", "ipsecProfileId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "mtu" : 1500, "TCPmss" : 1200, "bandwidth" : 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
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/local-access?vpnId=000000-0000-0000-0000-000000000000&siteName=site1 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-nvo3:nvo3/{source-nve} 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 是 string 36个字符。满足正则表达[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}。 - 设备ID。 "00000000-0000-0000-0000-000000000000" source-nve 是 string 1~63个字符。 - 源端接口,仅支持NVE口,单一主键字段。 "Nve1"
  • 请求示例 HTTP的示例 GET /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-nvo3:nvo3/Nve1 HTTP/1.1 Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN: x-yyyyyy restconf-transaction-id: "00000000-0000-0000-0000-000000000000"
  • 响应示例 返回状态码为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-nvo3:nvo3" : [ { "config-status" : "configured-database-success", "last-committed-time" : "2022-01-01 00:00:00", "related-pkg-version" : "1.0.1", "edit-state" : "RUNNING", "source-nve" : "Nve1", "source-vtep-ip" : "10.1.1.1", "vni-instance" : [ { "vni" : 10, "static-peer" : [ { "address" : "10.1.2.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:删除Loopback配置成功,响应体参考DeleteLoopbackResponseDto。 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" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "name" : "Loopback1" } ], "fail" : [ { "id" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "name" : "Loopback1" } ] } 返回状态码为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:删除Loopback配置成功,响应体参考DeleteLoopbackResponseDto。 表4 DeleteLoopbackResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 删除Loopback成功列表,结构体参见LoopbackBaseInfo。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表5。 删除Loopback失败列表,结构体参见LoopbackBaseInfo。 - 表5 LoopbackBaseInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 32个字符。 - id。 "e4d2b0e95bb94ef0a75b6a530d0b41be" name string 1~32个字符。 - Loopback名称。 "Loopback1" 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 DELETE /controller/campus/api/v1/networkconfig/loopback/device/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 { "ids" : ["e4d2b0e95bb94ef0a75b6a530d0b41be"] }
共100000条
提示

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