云服务器内容精选

  • 响应示例 返回状态码为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" : "", "totalRecords" : 200, "pageSize" : 20, "pageIndex" : 1, "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,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:查询成功返回。 表2 QueryVpnResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 200 pageSize int32 - - 每页显示数量。 20 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-8个列表项,详细请参见表6。 VPN信息。 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/vpn?pageIndex=0&pageSize=20&sort=name&vpnId=a99f794e-b510-438c-a75d-de59f02347eb&siteId=a99f794e-b510-438c-a75d-de59f02347eb&includeDefaultVpn=false&includeSite=false&vpnName=vpn Name 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:删除AP VPN配置成功,响应体参考DeleteApVpnResponseDto。 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" : [ { "id" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "name" : "apvpn", "description" : "The VPN policy not exists." } ], "fail" : [ { "id" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "name" : "apvpn", "description" : "The VPN policy not exists." } ] } 返回状态码为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:删除AP VPN配置成功,响应体参考DeleteApVpnResponseDto。 表3 DeleteApVpnResponseDto对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" success ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 删除AP VPN成功列表。 - fail ARRAY_REFERENCE 0-100个列表项,详细请参见表4。 删除AP VPN失败列表。 - 表4 ApVpnBaseInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id string 32个字符。 - VPNid。 "e4d2b0e95bb94ef0a75b6a530d0b41be" name string 1~94个字符。 - VPN名称。 "apvpn" description string 1~256个字符。 - 删除结果描述信息。 "The VPN policy not exists." 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部服务错误 详细信息请参见实际响应消息体。
  • URI /controller/campus/api/v1/networkconfig/apvpn/site/{siteId}/apvpn 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 36个字符。 - 站点ID。 "fbb684c8-0d37-496f-bafa-4b06d5151e2e" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 pageIndex 否 int32 [1-100] 1 第几页的数据。 1 pageSize 否 int32 [1-100] 20 一页多少条数据。 1
  • 响应示例 返回状态码为200:查询AP VPN成功,响应体参考GetApVpnResponseDto。 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" : "", "vpnList" : [ { "id" : "e4d2b0e95bb94ef0a75b6a530d0b41be", "ipsecConnectionName" : "vpn1", "deviceName" : "AirEngine6760R-51_FBF792C3", "deviceId" : "fbb684c8-0d37-496f-bafa-4b06d5151e2e", "peerAddress" : "192.168.1.1" , "localIdType" : "ip", "localIdValue" : "myhost.example.com", "refinedAcl" : [ { "priority" : 1, "action" : true, "protocol" : "tcp", "sourceIp" : "192.168.1.0/24", "sourceIpPort" : "1000", "desIp" : "192.168.1.0/24", "port" : "1000", "description" : "acl信息" } ], "filterAcl" : [ { "priority" : 1, "action" : true, "protocol" : "tcp", "sourceIp" : "192.168.1.0/24", "sourceIpPort" : "1000", "desIp" : "192.168.1.0/24", "port" : "1000", "description" : "acl信息" } ], "ipsecTemplateId" : "f285e423-492a-41ef-a4b8-5a687fc6832a", "preSharedKey" : "IAm@example" } ], "pageIndex" : 1, "pageSize" : 1, "total" : 1 } 返回状态码为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/api/v1/networkconfig/apvpn/site/fbb684c8-0d37-496f-bafa-4b06d5151e2e/apvpn?pageIndex=1&pageSize=1 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
  • 接口约束 该接口支持msp视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V和AR6700V子设备; 或者支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用,且仅支持AR6700V-L款型和V600系列设备。 该API可能会直接或间接影响现网业务运行,导致业务中断、关键数据丢失等,请谨慎操作!
  • URI /restconf/v2/data/huawei-ac-nes-device:nes/ne/{id}/huawei-nce-e-vpn:vpn/{instance-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" instance-name 是 string 1~31个字符。 - VPN实例名,单一主键字段。 "vpn1"
  • 请求示例 HTTP的示例 DELETE /restconf/v2/data/huawei-ac-nes-device:nes/ne/00000000-0000-0000-0000-000000000000/huawei-nce-e-vpn:vpn/vpn1 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,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
  • 响应示例 返回状态码为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的示例 PATCH /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" : { "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" } ] } }
  • 请求参数 表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-exclude-patch-false-augment对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 huawei-nce-e-vpn:vpn 否 REFERENCE 详细请参见表5。 VPN配置参数。 - 表5 vpn-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 instance-name 否 string 1~31个字符。 - VPN实例名,单一主键字段。 "vpn1" af 否 ARRAY_REFERENCE 0-2个列表项,详细请参见表6。 地址族。 - 表6 nes-ne-vpn-af-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 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-patch-false对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 value 否 string 3~21个字符。 - VPN Target值,联合主键字段。 "1:1" vpn-target-type 否 string import-extcommunity export-extcommunity - VPN Target类型。当云网元为管理网元时,不支持配置,联合主键字段。 "export-extcommunity"