-
响应示例 返回状态码为201:创建成功,响应体参考LocalInterworkingPolicyResponse。 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" : "",
"success" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
],
"fail" : [
{
"errcode" : "0x00c8000c",
"errmsg" : "The parameter is invalid.",
"data" : {
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
}
],
"processInstanceId" : ""
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalInterworkingPolicyResponse。 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
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/local-interworking 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
{
"localInterworkingPolicies" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
]
}
-
响应参数 返回状态码为201:创建成功,响应体参考LocalInterworkingPolicyResponse。 表5 LocalInterworkingPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-2000个列表项,详细请参见表6。 成功的本地互访策略信息列表。 - fail ARRAY_REFERENCE 0-2000个列表项,详细请参见表8。 失败的本地互访策略信息列表。 - processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 - 表6 LocalInterworkingPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - 策略ID,修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" vpnId uuid - - VPN ID,创建或者更新的时候必填。 "00000000-0000-0000-0000-000000000000" siteId uuid - - 站点ID,创建的时候必填。 "00000000-0000-0000-0000-000000000000" siteName string 0~64个字符。 - 站点名称。 "site1" igwEnable boolean true false - 是否互访网关,创建的时候必填。 true enableUnderlayFirst boolean true false false 是否underlay优先功能,默认关闭。 false transportNetworkconfigs ARRAY_REFERENCE 0-6个列表项,详细请参见表7。 集中互访的出口链路配置。 创建的时候必填。 更新的时候,如果不传值,则保持更新前的配置内容不变;如果传值,需要填写所有已配置的链路配置,未填写的链路配置会被删除。 - 表7 LocalTransportNetworkConfig对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 transportNetworkPortId uuid - - TNP ID,创建或者更新的时候必填。 "00000000-0000-0000-0000-000000000000" transportNetworkPortName string 0~64个字符。 - 传输网络端口名称。 "ApSite" priority int32 - - 链路优先级,取值范围:1、2、3,1表示最高,创建或者更新的时候必填。 1 bandwidth int32 [0-99] - 本地互访占用部门带宽比,单位为百分比。 配置会联动修改本地上网的部门带宽比。 当配置为0表示关闭独立分配带宽功能。 FW网关设备不支持配置。 10 enableIpv6 boolean true false - 是否开启IPv6模式,IPv6模式选择开关。 true mtu int32 [46-9216] - mtu,取值范围46-9216,默认值1500。 1500 表8 FailLocalInterworkingPolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0x00c8000c" errmsg string - - 错误信息。 "The parameter is invalid." data REFERENCE 详细请参见表6。 失败的本地互访策略请求体 - 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalInterworkingPolicyResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 localInterworkingPolicyInfos 是 REFERENCE 详细请参见表2。 创建本地互访策略请求数据。 - 表2 LocalInterworkingPolicyInfos对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 localInterworkingPolicies 否 ARRAY_REFERENCE 0-2000个列表项,详细请参见表3。 本地互访策略添加或者更新的请求体。 - 表3 LocalInterworkingPolicyInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - 策略ID,修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" vpnId 否 uuid - - VPN ID,创建或者更新的时候必填。 "00000000-0000-0000-0000-000000000000" siteId 否 uuid - - 站点ID,创建的时候必填。 "00000000-0000-0000-0000-000000000000" siteName 否 string 0~64个字符。 - 站点名称。 "site1" igwEnable 否 boolean true false - 是否互访网关,创建的时候必填。 true enableUnderlayFirst 否 boolean true false false 是否underlay优先功能,默认关闭。 false transportNetworkconfigs 否 ARRAY_REFERENCE 0-6个列表项,详细请参见表4。 集中互访的出口链路配置。 创建的时候必填。 更新的时候,如果不传值,则保持更新前的配置内容不变;如果传值,需要填写所有已配置的链路配置,未填写的链路配置会被删除。 - 表4 LocalTransportNetworkConfig对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 transportNetworkPortId 是 uuid - - TNP ID,创建或者更新的时候必填。 "00000000-0000-0000-0000-000000000000" transportNetworkPortName 否 string 0~64个字符。 - 传输网络端口名称。 "ApSite" priority 否 int32 - - 链路优先级,取值范围:1、2、3,1表示最高,创建或者更新的时候必填。 1 bandwidth 否 int32 [0-99] - 本地互访占用部门带宽比,单位为百分比。 配置会联动修改本地上网的部门带宽比。 当配置为0表示关闭独立分配带宽功能。 FW网关设备不支持配置。 10 enableIpv6 否 boolean true false - 是否开启IPv6模式,IPv6模式选择开关。 true mtu 否 int32 [46-9216] - mtu,取值范围46-9216,默认值1500。 1500
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/local-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
{
"localInterworkingPolicies" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
]
}
-
响应示例 返回状态码为200:删除成功,响应体参考LocalInterworkingPolicyResponse。 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" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
],
"fail" : [
{
"errcode" : "0x00c8000c",
"errmsg" : "The parameter is invalid.",
"data" : {
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
}
],
"processInstanceId" : ""
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalInterworkingPolicyResponse。 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
返回状态码为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:删除成功,响应体参考LocalInterworkingPolicyResponse。 LocalInterworkingPolicyResponse对象的参数列表,详细请参见表5。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalInterworkingPolicyResponse。 返回状态码为204:执行成功,无响应体。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
响应参数 返回状态码为200:查询成功,响应体参考QueryLocalInterworkingPolicyResponse。 表2 QueryLocalInterworkingPolicyResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 data ARRAY_REFERENCE 0-10000个列表项,详细请参见表6。 站点本地互访策略信息。 - 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200:查询成功,响应体参考QueryLocalInterworkingPolicyResponse。 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" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
]
} 返回状态码为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-interworking?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
-
响应参数 返回状态码为200:修改成功,响应体参考LocalInterworkingPolicyResponse。 LocalInterworkingPolicyResponse对象的参数列表,详细请参见表5。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalInterworkingPolicyResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200:修改成功,响应体参考LocalInterworkingPolicyResponse。 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" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
],
"fail" : [
{
"errcode" : "0x00c8000c",
"errmsg" : "The parameter is invalid.",
"data" : {
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
}
],
"processInstanceId" : ""
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考LocalInterworkingPolicyResponse。 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
-
请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/traffic/local-interworking 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
{
"localInterworkingPolicies" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"vpnId" : "00000000-0000-0000-0000-000000000000",
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "site1",
"igwEnable" : true,
"enableUnderlayFirst" : false,
"transportNetworkconfigs" : [
{
"transportNetworkPortId" : "00000000-0000-0000-0000-000000000000",
"transportNetworkPortName" : "ApSite",
"priority" : 1,
"bandwidth" : 10,
"enableIpv6" : true,
"mtu" : 1500
}
]
}
]
}