批量创建本地上网策略
典型场景
用于批量创建本地上网策略。
接口功能
批量创建本地上网策略。
接口约束
1. 该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。
2. FW网关设备不支持。
调用方法
POST
URI
/controller/campus/v1/sdwan/policy/traffic/local-access
请求参数
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
localAccessPolicyInfos |
是 |
REFERENCE |
详细请参见表2。 |
创建本地上网策略请求数据。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
localAccessPolicies |
否 |
ARRAY_REFERENCE |
1-2000个列表项,详细请参见表3。 |
本地上网策略添加或者更新的请求体。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
id |
否 |
uuid |
- |
- |
策略ID,修改或删除的时候必填。 |
"000000-0000-0000-0000-000000000000" |
vpnId |
否 |
uuid |
0~36个字符。 |
- |
VPN ID,创建的时候必填。 |
"000000-0000-0000-0000-000000000000" |
vpnName |
否 |
string |
0~64个字符。 |
- |
VPN名称 |
"VPN1" |
siteId |
否 |
uuid |
0~36个字符。 |
- |
站点ID,创建或者更新的时候必填。 |
"000000-0000-0000-0000-000000000000" |
siteName |
否 |
string |
0~64个字符。 |
- |
站点名称。 |
"site1" |
trackIP |
否 |
string |
0~30个字符。 |
- |
基于站点的探测IP,与基于TNP的Track IP互斥。 |
"10.12.13.14" |
enableVas |
否 |
boolean |
|
- |
是否开启vas功能,当前API暂未端到端支持该功能,需要配置UI使用。 |
true |
classificationProfiles |
否 |
array<string> |
0-500 个列表项。 |
- |
流分类模板ID,ID为创建流分类模板返回的ID,当本地上网使用流分类模板的时候必填。 更新的时候,如果不传值,则保持更新前的配置内容不变;如果传值,需要填写所有已配置的流分类模板ID,未填写的流分类模板ID会被删除。 |
["000000-0000-0000-0000-000000000000"] |
enableLocalFirst |
否 |
boolean |
|
true |
是否开启本地上网优先功能,默认打开。 |
true |
masterSiteSource |
否 |
string |
|
- |
基于应用的集中上网主网关站点来源。取值范围是tenant、msp。tenant表示租户下Edge站点,msp表示MSP下GW站点。 不填、非枚举值时默认为tenant。 V600版本设备不支持配置。 |
"tenant" |
masterSiteId |
否 |
uuid |
- |
- |
基于应用的集中上网主网关站点ID。 V600版本设备不支持配置。 |
"000000-0000-0000-0000-000000000000" |
masterSiteName |
否 |
string |
0~64个字符。 |
- |
基于应用的集中上网主网关站点名称 |
"site1" |
backupSiteSource |
否 |
string |
|
- |
基于应用的集中上网备网关站点来源。取值范围是tenant、msp。tenant表示租户下Edge站点,msp表示MSP下GW站点。 不填、非枚举值时默认为tenant。 V600版本设备不支持配置。 |
"tenant" |
backupSiteId |
否 |
uuid |
- |
- |
基于应用的集中上网备网关站点ID。 V600版本设备不支持配置。 |
"000000-0000-0000-0000-000000000000" |
backupSiteName |
否 |
string |
0~64个字符。 |
- |
基于应用的集中上网备网关站点名称 |
"site1" |
internetAccessType |
否 |
string |
0~32个字符。 |
- |
基于应用的集中上网方式,该字段可以设置为以下几种: a) localAccess:本地上网,默认值 b) centralizedAccess:集中上网 |
"localAccess" |
transportNetworkConfigs |
否 |
ARRAY_REFERENCE |
0-6个列表项,详细请参见表4。 |
传输网络。 创建的时候必填。 更新的时候,如果不传值,则保持更新前的配置内容不变;如果传值,需要填写所有已配置的传输网络配置内容,未填写的配置会被删除。 |
- |
|
ipsecTunnelConfigs |
否 |
ARRAY_REFERENCE |
0-6个列表项,详细请参见表6。 |
ipsec配置 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
transportNetworkPortId |
否 |
uuid |
- |
- |
传输网络端口ID,创建或者更新的时候必填。 |
"000000-0000-0000-0000-000000000000" |
transportNetworkPortName |
否 |
string |
0~64个字符。 |
- |
传输网络端口名。 |
"internet1" |
transportNetworkPortVpnName |
否 |
string |
0~64个字符。 |
- |
传输网络端口绑定的VPN。 |
"underlay_1" |
enableNat |
否 |
boolean |
|
- |
是否在传输网络端口开启nat,enableNat和enableIpv6不能同时使能。 |
true |
enableIpv6 |
否 |
boolean |
|
- |
是否开启IPv6模式,IPv6模式选择开关,enableNat和enableIpv6不能同时使能。 |
true |
priority |
否 |
int32 |
[1-3] |
- |
链路优先级,只能是1,2,3,1表示最高,创建或者更新的时候必填。 |
"1" |
bandwidth |
否 |
int32 |
[0-99] |
- |
本地上网占用部门带宽比,单位为百分比。 配置会联动修改本地上网的部门带宽比。 当配置为0表示关闭独立分配带宽功能。 |
10 |
trackIP |
否 |
string |
0~30个字符。 |
- |
探测IP,单设备的Track IP要求配置一致,与基于站点的探测IP互斥。 |
"10.12.13.14" |
dhcpTrackIP |
否 |
string |
0~30个字符。 |
- |
DHCP场景下配置探测IP,仅基于全部类型策略配置时生效。 V600系列设备不支持。 |
"10.12.13.14" |
mtu |
否 |
int32 |
[46-9216] |
- |
mtu,取值范围46-9216,默认值1500。仅V300系列设备支持。 |
9000 |
downlinkBandwidth |
否 |
int64 |
[8-4294967295] |
- |
下行带宽容量(Kbps),取值范围:8-4294967295。仅V300系列设备支持。 |
1000 |
uplinkBandwidth |
否 |
int64 |
[8-4294967295] |
- |
上行带宽容量(Kbps),取值范围:8-4294967295。仅V300系列设备支持。 |
1000 |
downlinkQos |
否 |
ARRAY_REFERENCE |
0-128个列表项,详细请参见表5。 |
内环隧道下行QoS策略。仅V300系列设备支持。 |
- |
|
uplinkQos |
否 |
ARRAY_REFERENCE |
0-128个列表项,详细请参见表5。 |
内环隧道上行QoS策略。仅V300系列设备支持。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
ruleId |
否 |
string |
0~64个字符。 |
- |
QoSRule ID。 修改时,若qosRuleId为空,表示向Qos策略添加一条QosRule;若qosRuleId不为空,表示修改对应的QosRule。 |
"00000000-0000-0000-0000-000000000000" |
rulePriority |
否 |
int32 |
[1-5000] |
- |
策略优先级。 |
1 |
ruleClassificationId |
否 |
string |
0~64个字符。 |
- |
策略流分类模板ID,必填。 |
"00000000-0000-0000-0000-000000000000" |
ruleClassificationName |
否 |
string |
0~64个字符。 |
- |
策略流分类模板名称。 |
"qosClassificationName" |
ruleProfileId |
否 |
string |
0~64个字符。 |
- |
策略行为模板ID,必填 |
"00000000-0000-0000-0000-000000000000" |
ruleProfileName |
否 |
string |
0~64个字符。 |
- |
策略行为模板名称。 |
"templateName" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
trackIP |
否 |
string |
0~30个字符。 |
- |
探测IP,单设备的Track IP要求配置一致,与基于站点的探测IP互斥。 |
"10.12.13.14" |
wanLinkName |
否 |
string |
0~512个字符。 |
- |
链路名称。 |
"AR 104" |
deviceName |
否 |
string |
0~512个字符。 |
- |
对应设备的名称 |
"AR 104" |
id |
否 |
string |
0~256个字符。 |
- |
Ipsec Tunnel ID,更新,删除时必填。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
priority |
否 |
int32 |
[1-3] |
- |
链路优先级,只能是1,2,3,1表示最高,创建或者更新的时候必填。 |
"1" |
tunnelPortName |
否 |
string |
0~512个字符。 |
- |
Ipsec Tunnel端口名,不能重复。创建时必填。 |
"Tunnel0/0/400" |
wanLinkId |
否 |
string |
0~256个字符。 |
- |
Wan链路的ID。创建时必填。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
ipAddress |
否 |
string |
0~32个字符。 |
- |
Ipsec隧道IP地址。创建时必填。 |
"192.168.0.1/24" |
srcIpAddress |
否 |
string |
0~32个字符。 |
- |
Ipsec隧道源IP地址。创建时必填。 |
"192.168.1.1" |
srcType |
否 |
string |
0~32个字符。 |
- |
源接口类型,可选值:IP、WanLink、LoopBack。 |
"IP" |
srcInterfaceId |
否 |
string |
0~64个字符。 |
- |
源接口Id,对应LOOPBACK ID或者WANLINK ID;与SRCIPADDRESS二选一。 |
"00000000-0000-0000-0000-000000000000" |
dstIpAddress |
否 |
string |
0~32个字符。 |
- |
Ipsec隧道目的IP地址。创建时必填。 |
"192.168.1.2" |
ipsecProfileId |
否 |
string |
0~256个字符。 |
- |
IPSec模板ID。创建时必填。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
mtu |
否 |
int32 |
[46-9216] |
1500 |
MTU,取值范围:46-9216,默认1500。 |
1500 |
TCPmss |
否 |
int32 |
[230-2048] |
1200 |
TCP MSS, 取值范围:230-2048,默认1200。 |
1200 |
bandwidth |
否 |
int32 |
[0-99] |
- |
本地上网占用部门带宽比,单位为百分比。 配置会联动修改本地上网的部门带宽比。 当配置为0表示关闭独立分配带宽功能。 |
10 |
请求示例
POST /controller/campus/v1/sdwan/policy/traffic/local-access 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 { "localAccessPolicies" : [ { "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 } ] } ] }
响应参数
返回状态码为201:创建成功,响应体参考LocalAccessPolicyResponse。
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
- |
- |
错误码。 |
"0" |
errmsg |
string |
- |
- |
错误信息。 |
"" |
success |
ARRAY_REFERENCE |
0-2000个列表项,详细请参见表8。 |
成功的本地上网策略信息列表。 |
- |
|
fail |
ARRAY_REFERENCE |
0-2000个列表项,详细请参见表12。 |
失败的本地上网策略信息列表。 |
- |
|
processInstanceId |
string |
0~36个字符。 |
- |
编排流程实例ID,UUID格式。当接口返回码为202时非空。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
id |
uuid |
- |
- |
策略ID,修改或删除的时候必填。 |
"000000-0000-0000-0000-000000000000" |
vpnId |
uuid |
0~36个字符。 |
- |
VPN ID,创建的时候必填。 |
"000000-0000-0000-0000-000000000000" |
vpnName |
string |
0~64个字符。 |
- |
VPN名称 |
"VPN1" |
siteId |
uuid |
0~36个字符。 |
- |
站点ID,创建或者更新的时候必填。 |
"000000-0000-0000-0000-000000000000" |
siteName |
string |
0~64个字符。 |
- |
站点名称。 |
"site1" |
trackIP |
string |
0~30个字符。 |
- |
基于站点的探测IP,与基于TNP的Track IP互斥。 |
"10.12.13.14" |
enableVas |
boolean |
|
- |
是否开启vas功能,当前API暂未端到端支持该功能,需要配置UI使用。 |
true |
classificationProfiles |
array<string> |
0-500 个列表项。 |
- |
流分类模板ID,ID为创建流分类模板返回的ID,当本地上网使用流分类模板的时候必填。 更新的时候,如果不传值,则保持更新前的配置内容不变;如果传值,需要填写所有已配置的流分类模板ID,未填写的流分类模板ID会被删除。 |
["000000-0000-0000-0000-000000000000"] |
enableLocalFirst |
boolean |
|
true |
是否开启本地上网优先功能,默认打开。 |
true |
masterSiteSource |
string |
|
- |
基于应用的集中上网主网关站点来源。取值范围是tenant、msp。tenant表示租户下Edge站点,msp表示MSP下GW站点。 不填、非枚举值时默认为tenant。 V600版本设备不支持配置。 |
"tenant" |
masterSiteId |
uuid |
- |
- |
基于应用的集中上网主网关站点ID。 V600版本设备不支持配置。 |
"000000-0000-0000-0000-000000000000" |
masterSiteName |
string |
0~64个字符。 |
- |
基于应用的集中上网主网关站点名称 |
"site1" |
backupSiteSource |
string |
|
- |
基于应用的集中上网备网关站点来源。取值范围是tenant、msp。tenant表示租户下Edge站点,msp表示MSP下GW站点。 不填、非枚举值时默认为tenant。 V600版本设备不支持配置。 |
"tenant" |
backupSiteId |
uuid |
- |
- |
基于应用的集中上网备网关站点ID。 V600版本设备不支持配置。 |
"000000-0000-0000-0000-000000000000" |
backupSiteName |
string |
0~64个字符。 |
- |
基于应用的集中上网备网关站点名称 |
"site1" |
internetAccessType |
string |
0~32个字符。 |
- |
基于应用的集中上网方式,该字段可以设置为以下几种: a) localAccess:本地上网,默认值 b) centralizedAccess:集中上网 |
"localAccess" |
transportNetworkConfigs |
ARRAY_REFERENCE |
0-6个列表项,详细请参见表9。 |
传输网络。 创建的时候必填。 更新的时候,如果不传值,则保持更新前的配置内容不变;如果传值,需要填写所有已配置的传输网络配置内容,未填写的配置会被删除。 |
- |
|
ipsecTunnelConfigs |
ARRAY_REFERENCE |
0-6个列表项,详细请参见表11。 |
ipsec配置 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
transportNetworkPortId |
uuid |
- |
- |
传输网络端口ID,创建或者更新的时候必填。 |
"000000-0000-0000-0000-000000000000" |
transportNetworkPortName |
string |
0~64个字符。 |
- |
传输网络端口名。 |
"internet1" |
transportNetworkPortVpnName |
string |
0~64个字符。 |
- |
传输网络端口绑定的VPN。 |
"underlay_1" |
enableNat |
boolean |
|
- |
是否在传输网络端口开启nat,enableNat和enableIpv6不能同时使能。 |
true |
enableIpv6 |
boolean |
|
- |
是否开启IPv6模式,IPv6模式选择开关,enableNat和enableIpv6不能同时使能。 |
true |
priority |
int32 |
[1-3] |
- |
链路优先级,只能是1,2,3,1表示最高,创建或者更新的时候必填。 |
"1" |
bandwidth |
int32 |
[0-99] |
- |
本地上网占用部门带宽比,单位为百分比。 配置会联动修改本地上网的部门带宽比。 当配置为0表示关闭独立分配带宽功能。 |
10 |
trackIP |
string |
0~30个字符。 |
- |
探测IP,单设备的Track IP要求配置一致,与基于站点的探测IP互斥。 |
"10.12.13.14" |
dhcpTrackIP |
string |
0~30个字符。 |
- |
DHCP场景下配置探测IP,仅基于全部类型策略配置时生效。 V600系列设备不支持。 |
"10.12.13.14" |
mtu |
int32 |
[46-9216] |
- |
mtu,取值范围46-9216,默认值1500。仅V300系列设备支持。 |
9000 |
downlinkBandwidth |
int64 |
[8-4294967295] |
- |
下行带宽容量(Kbps),取值范围:8-4294967295。仅V300系列设备支持。 |
1000 |
uplinkBandwidth |
int64 |
[8-4294967295] |
- |
上行带宽容量(Kbps),取值范围:8-4294967295。仅V300系列设备支持。 |
1000 |
downlinkQos |
ARRAY_REFERENCE |
0-128个列表项,详细请参见表10。 |
内环隧道下行QoS策略。仅V300系列设备支持。 |
- |
|
uplinkQos |
ARRAY_REFERENCE |
0-128个列表项,详细请参见表10。 |
内环隧道上行QoS策略。仅V300系列设备支持。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
ruleId |
string |
0~64个字符。 |
- |
QoSRule ID。 修改时,若qosRuleId为空,表示向Qos策略添加一条QosRule;若qosRuleId不为空,表示修改对应的QosRule。 |
"00000000-0000-0000-0000-000000000000" |
rulePriority |
int32 |
[1-5000] |
- |
策略优先级。 |
1 |
ruleClassificationId |
string |
0~64个字符。 |
- |
策略流分类模板ID,必填。 |
"00000000-0000-0000-0000-000000000000" |
ruleClassificationName |
string |
0~64个字符。 |
- |
策略流分类模板名称。 |
"qosClassificationName" |
ruleProfileId |
string |
0~64个字符。 |
- |
策略行为模板ID,必填 |
"00000000-0000-0000-0000-000000000000" |
ruleProfileName |
string |
0~64个字符。 |
- |
策略行为模板名称。 |
"templateName" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
trackIP |
string |
0~30个字符。 |
- |
探测IP,单设备的Track IP要求配置一致,与基于站点的探测IP互斥。 |
"10.12.13.14" |
wanLinkName |
string |
0~512个字符。 |
- |
链路名称。 |
"AR 104" |
deviceName |
string |
0~512个字符。 |
- |
对应设备的名称 |
"AR 104" |
id |
string |
0~256个字符。 |
- |
Ipsec Tunnel ID,更新,删除时必填。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
priority |
int32 |
[1-3] |
- |
链路优先级,只能是1,2,3,1表示最高,创建或者更新的时候必填。 |
"1" |
tunnelPortName |
string |
0~512个字符。 |
- |
Ipsec Tunnel端口名,不能重复。创建时必填。 |
"Tunnel0/0/400" |
wanLinkId |
string |
0~256个字符。 |
- |
Wan链路的ID。创建时必填。 |
"fbb684c8-0d37-496f-bafa-4b06d515j7l6" |
ipAddress |
string |
0~32个字符。 |
- |
Ipsec隧道IP地址。创建时必填。 |
"192.168.0.1/24" |
srcIpAddress |
string |
0~32个字符。 |
- |
Ipsec隧道源IP地址。创建时必填。 |
"192.168.1.1" |
srcType |
string |
0~32个字符。 |
- |
源接口类型,可选值:IP、WanLink、LoopBack。 |
"IP" |
srcInterfaceId |
string |
0~64个字符。 |
- |
源接口Id,对应LOOPBACK ID或者WANLINK ID;与SRCIPADDRESS二选一。 |
"00000000-0000-0000-0000-000000000000" |
dstIpAddress |
string |
0~32个字符。 |
- |
Ipsec隧道目的IP地址。创建时必填。 |
"192.168.1.2" |
ipsecProfileId |
string |
0~256个字符。 |
- |
IPSec模板ID。创建时必填。 |
"fbb684c8-0d37-496f-bafa-4b06d5151e2e" |
mtu |
int32 |
[46-9216] |
1500 |
MTU,取值范围:46-9216,默认1500。 |
1500 |
TCPmss |
int32 |
[230-2048] |
1200 |
TCP MSS, 取值范围:230-2048,默认1200。 |
1200 |
bandwidth |
int32 |
[0-99] |
- |
本地上网占用部门带宽比,单位为百分比。 配置会联动修改本地上网的部门带宽比。 当配置为0表示关闭独立分配带宽功能。 |
10 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
- |
- |
错误码。 |
"0x00c8000c" |
errmsg |
string |
- |
- |
错误信息。 |
"The parameter is invalid." |
data |
REFERENCE |
详细请参见表8。 |
失败的本地上网策略请求体 |
- |
返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalAccessPolicyResponse。
返回状态码为400:请求参数错误,无响应体。
详细信息请参见实际响应消息体。
返回状态码为500:内部错误,无响应体。
详细信息请参见实际响应消息体。
响应示例
返回状态码为201:创建成功,响应体参考LocalAccessPolicyResponse。
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" : "", "success" : [ { "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 } ] } ], "fail" : [ { "errcode" : "0x00c8000c", "errmsg" : "The parameter is invalid.", "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 } ] } } ], "processInstanceId" : "" }
返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalAccessPolicyResponse。
HTTP/1.1 202 Accepted 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