-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/internet/00000000-0000-0000-0000-000000000000/centralized-access/inherit 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
{
"inheritSwitchEnable" : true
}
-
请求参数 表2 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 inheritSwitchInfo 是 REFERENCE 详细请参见表3。 继承LAN侧路由使能开关 - 表3 InheritSwitchInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 inheritSwitchEnable 是 boolean true false false 是否使能继承LAN侧路由。 true
-
响应参数 返回状态码为201:更改成功。 表4 InheritSwitchResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" data REFERENCE 详细请参见表5。 - - processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 - 表5 InheritSwitchInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 inheritSwitchEnable boolean true false false 是否使能继承LAN侧路由。 true 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考InheritSwitchResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为201:更改成功。 HTTP/1.1 201 Created
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" : {
"inheritSwitchEnable" : true
},
"processInstanceId" : ""
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考InheritSwitchResponse。 HTTP/1.1 202 Accepted
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
-
接口约束 1:该接口仅支持租户视图,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用; 2:使能此开关后,对于当前VN下的集中网关,不指定网关优先级,统一继承LAN侧默认路由优先级; 3:暂不支持同一VN下部分集中网关配置优先级,部分继承LAN侧优先级; 4:开关默认关闭,已配置集中网关的情况下,使能开关会使原有集中网关统一修改为继承LAN侧默认路由优先级; 5:开关关闭时默认删除已配置的集中上网策略,需要重新配置,请谨慎操作。
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/internet/00000000-0000-0000-0000-000000000000/centralized-access/inherit 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,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" : {
"inheritSwitchEnable" : true
},
"processInstanceId" : ""
} 返回状态码为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:查询成功,响应体参考QueryCentralizedAccessPolicyResponse。 表2 QueryCentralizedAccessPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 data ARRAY_REFERENCE 0-1000个列表项,详细请参见表6。 站点集中地上网策略信息。 - 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200:查询成功,响应体参考QueryCentralizedAccessPolicyResponse。 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" : [
{
"areaId" : "00000000-0000-0000-0000-000000000000",
"areaName" : "area_1",
"description" : "centralized access",
"centralizedSiteInfos" : [
{
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"priority" : "1"
}
],
"enableIpv6" : 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/policy/traffic/internet/00000000-0000-0000-0000-000000000000/centralized-access/batch 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/policy/traffic/internet/{vpnId}/centralized-access 表1 path参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnId 是 uuid - - VPN ID。 "00000000-0000-0000-0000-000000000000" 表2 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 areaId 否 uuid - - Area ID。 不填表示查询全局集中上网信息; 填写areaId表明查询指定区域的集中上网信息。 "00000000-0000-0000-0000-000000000000"
-
响应示例 返回状态码为200:查询成功,响应体参考CentralizedAccessResponse。 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" : {
"areaId" : "00000000-0000-0000-0000-000000000000",
"areaName" : "area_1",
"description" : "centralized access",
"centralizedSiteInfos" : [
{
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"priority" : "1"
}
],
"enableIpv6" : false
},
"processInstanceId" : ""
} 返回状态码为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/internet/00000000-0000-0000-0000-000000000000/centralized-access?areaId=00000000-0000-0000-0000-000000000000 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
-
响应示例 返回状态码为201:创建成功,响应体参考CentralizedAccessResponse。 HTTP/1.1 201 Created
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" : {
"areaId" : "00000000-0000-0000-0000-000000000000",
"areaName" : "area_1",
"description" : "centralized access",
"centralizedSiteInfos" : [
{
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"priority" : "1"
}
],
"enableIpv6" : false
},
"processInstanceId" : ""
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考CentralizedAccessResponse。 HTTP/1.1 202 Accepted
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 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 centralizedAccessInfo 是 REFERENCE 详细请参见表3。 创建集中上网配置请求数据。 - 表3 CentralizedAccessInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 areaId 否 uuid - - 集中上网站点服务的区域。 主键字段,不填表明是全局的集中上网站点; 指定areaId表明是指定区域的集中上网站点。 "00000000-0000-0000-0000-000000000000" areaName 否 string 1~32个字符。 - 区
域名 称。 "area_1" description 否 string 0~64个字符。 - 集中上网描述。 "centralized access" centralizedSiteInfos 是 ARRAY_REFERENCE 0-16个列表项,详细请参见表4。 集中上网的站点列表,最多支持16个,站点需要在URL路径中指定的VPN下。 - enableIpv6 否 boolean true false false 集中上网是否开启IPv6,非必填,默认为false。仅VPN开启了IPv6并且主备网关都是V600设备时,才支持ipv6集中上网。 false 表4 CentralizedAccessSiteInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 uuid - - 站点ID,必填,站点必须先加入拓扑。 "00000000-0000-0000-0000-000000000000" siteName 否 string 0~64个字符。 - 站点名称。 "site1" priority 否 string 0~10个字符。 - 站点优先级,支持以下两种配置方式。 a) priority赋值active、standby,主备网关,仅支持配置2个站点。 b) priority赋值1-16的数字,最多支持配置16个站点。 不支持两种方式混用,开启继续LAN侧路由开关优先级时priority必须为空。 "1"