-
请求示例 HTTP的示例 PUT /controller/campus/v1/sdwan/policy/bind-policy 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
{
"policyId" : "00000000-0000-0000-0000-000000000000",
"policyType" : "qos",
"effectImmediate" : true,
"sites" : [
{
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "Site1",
"tnpIds" : [
"00000000-0000-0000-0000-000000000000"
],
"externalPortIds" : [
"00000000-0000-0000-0000-000000000000"
],
"lanPortIds" : [
"00000000-0000-0000-0000-000000000000"
],
"devicePortTypes" : [
{
"deviceId" : "00000000-0000-0000-0000-000000000000",
"portType" : "EvpnTunnel"
}
],
"destSites" : [
"00000000-0000-0000-0000-000000000000"
]
}
],
"status" : "committing"
}
-
响应参数 返回状态码为200:配置成功,响应体参考ApplyPolicyResponse。 ApplyPolicyResponse对象的参数列表,详细请参见表6。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ApplyPolicyResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
响应示例 返回状态码为200:配置成功,响应体参考ApplyPolicyResponse。 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" : "",
"errparam" : "["policyName"]",
"processInstanceId" : ""
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ApplyPolicyResponse。 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、该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。 2、当policyType为vpn bandwidth时,接口返回202,表示请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功;接口返回其他状态码,表示请求已处理完成。当policyType为其他类型时,接口在提交之后立即返回,实际业务还在执行中,可通过对应策略的查询接口查询执行状态。 3、当policyType为traffic filter、vpn bandwidth、qos时,不支持绑定策略到FW网关站点。
-
响应参数 返回状态码为200:配置成功,响应体参考ApplyPolicyResponse。 ApplyPolicyResponse对象的参数列表,详细请参见表6。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ApplyPolicyResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
接口约束 1、该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。 2、当policyType为vpn bandwidth时,接口返回202,表示请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功;接口返回其他状态码,表示请求已处理完成。当policyType为其他类型时,接口在提交之后立即返回,实际业务还在执行中,可通过对应策略的查询接口查询执行状态。 3、当policyType为traffic filter、vpn bandwidth、qos时,不支持绑定策略到FW网关站点。
-
响应示例 返回状态码为200:配置成功,响应体参考ApplyPolicyResponse。 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" : "",
"errparam" : "["policyName"]",
"processInstanceId" : ""
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ApplyPolicyResponse。 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/bind-policy 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
{
"policyId" : "00000000-0000-0000-0000-000000000000",
"policyType" : "qos",
"effectImmediate" : true,
"sites" : [
{
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "Site1",
"tnpIds" : [
"00000000-0000-0000-0000-000000000000"
],
"externalPortIds" : [
"00000000-0000-0000-0000-000000000000"
],
"lanPortIds" : [
"00000000-0000-0000-0000-000000000000"
],
"devicePortTypes" : [
{
"deviceId" : "00000000-0000-0000-0000-000000000000",
"portType" : "EvpnTunnel"
}
],
"destSites" : [
"00000000-0000-0000-0000-000000000000"
]
}
],
"status" : "committing"
}
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/apply-policy?policyId=00000000-0000-0000-0000-000000000000&policyType=qos&siteId=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
-
响应示例 返回状态码为200:查询成功,响应体参考QueryApplyPolicResponse。 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" : [
{
"policyId" : "00000000-0000-0000-0000-000000000000",
"policyType" : "qos",
"effectImmediate" : true,
"sites" : [
{
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "Site1",
"tnpIds" : [
"00000000-0000-0000-0000-000000000000"
],
"externalPortIds" : [
"00000000-0000-0000-0000-000000000000"
],
"lanPortIds" : [
"00000000-0000-0000-0000-000000000000"
],
"devicePortTypes" : [
{
"deviceId" : "00000000-0000-0000-0000-000000000000",
"portType" : "EvpnTunnel"
}
],
"destSites" : [
"00000000-0000-0000-0000-000000000000"
]
}
],
"status" : "committing"
}
]
} 返回状态码为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:配置成功,响应体参考ApplyPolicyResponse。 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" : "",
"errparam" : "["policyName"]",
"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的示例 POST /controller/campus/v1/sdwan/policy/revoke 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
{
"policyType" : "qos",
"time" : "1676008846",
"policyIds" : ["00000000-0000-0000-0000-000000000000"]
}
-
接口约束 1、该接口仅支持租户视图或msp代维视图下,角色为“Open Api Operator”的用户访问,必须在用户会话建立后使用。 2、当policyType为vpn bandwidth时,接口返回202,表示请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功;接口返回其他状态码,表示请求已处理完成。当policyType为其他类型时,接口在提交之后立即返回,实际业务还在执行中,可通过对应策略的查询接口查询执行状态。
-
响应参数 返回状态码为200:配置成功,响应体参考ApplyPolicyResponse。 ApplyPolicyResponse对象的参数列表,详细请参见表6。 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考ApplyPolicyResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/unbind-policy 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
{
"policyId" : "00000000-0000-0000-0000-000000000000",
"policyType" : "qos",
"effectImmediate" : true,
"sites" : [
{
"siteId" : "00000000-0000-0000-0000-000000000000",
"siteName" : "Site1",
"tnpIds" : [
"00000000-0000-0000-0000-000000000000"
],
"externalPortIds" : [
"00000000-0000-0000-0000-000000000000"
],
"lanPortIds" : [
"00000000-0000-0000-0000-000000000000"
],
"devicePortTypes" : [
{
"deviceId" : "00000000-0000-0000-0000-000000000000",
"portType" : "EvpnTunnel"
}
],
"destSites" : [
"00000000-0000-0000-0000-000000000000"
]
}
],
"status" : "committing"
}