云服务器内容精选

  • 响应示例 返回状态码为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" : "", "topology" : { "areas" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "area_1", "areaType" : "leaf", "topologyType" : "hub-spoke", "enableDynamicTunnel" : "", "gatewayIPv6Enable" : false, "hubWorkMode" : "with-interconnection", "isFullReplaceSite" : "", "siteAttachments" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "siteRoles" : [{"role":"hub","sitePriority":"active"},{"role":"border","sitePriority":"active"}], "accessServiceHubs" : [ { "siteName" : "", "siteId" : "00000000-0000-0000-0000-000000000000", "accessPriority" : 2 } ], "borderRelationShip" : { "activeBorderSiteId" : "00000000-0000-0000-0000-000000000000", "activeBorderSiteName" : "Site Name", "standbyBorderSiteId" : "00000000-0000-0000-0000-000000000000", "standbyBorderSiteName" : "Site Name" }, "enableHubLanConnect" : "" } ] } ] }, "processInstanceId" : "", "totalRecords" : 10, "pageSize" : 10, "pageIndex" : 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
  • 响应参数 返回状态码为200:查询拓扑成功。 表3 TopologyPageResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" topology REFERENCE 详细请参见表10。 拓扑信息。 - processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 - totalRecords int32 - - 总的数据条数。 10 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology?areaId=00000000-0000-0000-0000-000000000000&areaType=leaf&areaName=leaf 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/overlay-network/{vpnId}/topology 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID,UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 areaId 否 uuid - - 指定区域ID,UUID格式。EVPN模式下,如果不填,表明查询指定vpn下的所有area。 "00000000-0000-0000-0000-000000000000" areaType 否 string 0~32个字符。 - 区域类型,支持按区域类型查询,取值范围:leaf、backbone。 "leaf" areaName 否 string 0~32个字符。 - 区 域名 称,支持按区域名称模糊查询。 "leaf" pageIndex 否 int32 - - 当前页数,为空表示查询所有。 - pageSize 否 int32 - - 每页显示数量,为空表示查询所有。 -
  • 响应示例 返回状态码为200:查询关联spoke站点成功 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" : "", "isHub" : true, "data" : [ { "id" : "00000000-0000-0000-0000-000000000000", "name" : "Site Name", "role" : 2, "siteGateType" : 1, "address" : "", "floor" : "" } ], "totalRecords" : 10, "pageSize" : 10, "pageIndex" : 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
  • URI /controller/campus/v1/sdwan/overlay-network/topology/get-related-spoke-sites 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,uuid格式。 "00000000-0000-0000-0000-000000000000" keyWord 否 string 0~64个字符。 - 关键字。 "site1" pageIndex 否 int32 - - 当前页数,为空表示查询所有页。 - pageSize 否 int32 - - 每页显示数量,为空表示查询所有页 -
  • 请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/overlay-network/topology/get-related-spoke-sites?siteId=00000000-0000-0000-0000-000000000000&keyWord=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
  • 响应参数 返回状态码为200:查询关联spoke站点成功 表2 SpokeSitesPageResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~10个字符。 - 错误码,0表示成功,非0表示失败。 "0" errmsg string 0~256个字符。 - 错误信息 - isHub boolean true false false 是否是hub站点 true data ARRAY_REFERENCE 0-1000个列表项,详细请参见表3。 关联的spoke站点列表。 - totalRecords int32 - - 总的数据条数。 10 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 表3 TopoSiteInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 站点ID,uuid格式。 "00000000-0000-0000-0000-000000000000" name string - - 站点名称。 "Site Name" role int32 - - 站点角色。 2 siteGateType int32 [1-2] - 站点单双关,1代表单网关,2代表双网关。 1 address string 0~256个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 地址 - floor string 0~256个字符。 - 该字段可能包含敏感信息和个人数据,请妥善做好保护。 楼层 - 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • URI /controller/campus/v1/sdwan/overlay-network/{vpnId}/topology/policy 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID,UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyName 否 string - - 自定义策略名称。不填时表示查vpn下的所有策略,填写时表示查询指定名称的策略。 "connectionPolicy" pageIndex 否 int32 - - 当前页数,为空表示查询所有页。 - pageSize 否 int32 - - 每页显示数量,为空表示查询所有页 -
  • 响应参数 返回状态码为200:查询拓扑自定义策略成功。 表3 CustomPolicyPageResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" customPolicys ARRAY_REFERENCE 1-100个列表项,详细请参见表13。 自定义策略。 - totalRecords int32 - - 总的数据条数。 10 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 返回状态码为400:校验异常。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误。 详细信息请参见实际响应消息体。
  • 响应示例 返回状态码为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" : "", "customPolicys" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "partialMeshPolicy", "priority" : 1, "rules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "matchCondition" : { "ipAddressPrefix" : { "prefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ], "ipv6PrefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "siteIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "siteNames" : ["siteName1","siteName2"] }, "applyAction" : { "siteSource" : "tenant", "nextHops" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "preference" : 2 } ], "applyMode" : "additive", "mode" : "permit" } } ], "applyToSites" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "applyToSiteNames" : ["siteName1","siteName2"] } ], "totalRecords" : 10, "pageSize" : 10, "pageIndex" : 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/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology/policy?policyName=connectionPolicy 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/sdwan/overlay-network/{vpnId}/topology/policy 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID,UUID格式。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 policyName 否 string - - 自定义策略名称。不填时表示删除vpn下的所有策略,填写时表示删除指定名称的策略。 "connectionPolicy"
  • 请求示例 HTTP的示例 DELETE /controller/campus/v1/sdwan/overlay-network/00000000-0000-0000-0000-000000000000/topology/policy?policyName=connectionPolicy 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 { "errcode" : "0", "errmsg" : "", "customPolicys" : [ { "id" : "00000000-0000-0000-0000-000000000000", "policyName" : "partialMeshPolicy", "priority" : 1, "rules" : [ { "id" : "00000000-0000-0000-0000-000000000000", "matchCondition" : { "ipAddressPrefix" : { "prefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv4Address" : "10.1.0.0", "maskLength" : 24, "greaterEqual" : 24, "lessEqual" : 24 } ], "ipv6PrefixFilters" : [ { "id" : "00000000-0000-0000-0000-000000000000", "ipv6Address" : "fc00::", "maskLength" : 96, "greaterEqual" : 96, "lessEqual" : 96 } ] }, "siteIds" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "siteNames" : ["siteName1","siteName2"] }, "applyAction" : { "siteSource" : "tenant", "nextHops" : [ { "siteId" : "00000000-0000-0000-0000-000000000000", "siteName" : "Site Name", "preference" : 2 } ], "applyMode" : "additive", "mode" : "permit" } } ], "applyToSites" : ["00000000-0000-0000-0000-000000000000","00000000-0000-0000-0000-000000000001"], "applyToSiteNames" : ["siteName1","siteName2"] } ] } 返回状态码为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