接口功能介绍
智能选路策略详情查询
接口约束
输入参数名称类长度不超过64位，描述类长度不超过128位
URI
GET /v4/sdwan/edge-policy/query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| policyID | 是 | String | 策略ID | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| edgeID | 是 | String | 智能网关ID | 2893f150-19b5-11eb-8e79-824da1059800 |
请求参数
请求header参数
无
请求body参数
无
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| statusCode | 否 | Integer | 返回状态码(800为成功，900为失败) ，默认值:800 | 800 | |
| errorCode | 否 | String | 业务细分码，为product.module.code三段式码 | ||
| message | 否 | String | 失败时的错误描述，一般为英文描述 | ||
| description | 否 | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | 否 | Object | 返回参数 | returnObj |
表returnObj
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| totalCount | 否 | Integer | 总数 | 1 | |
| currentCount | 否 | Integer | 当前页数量 | 1 | |
| result | 否 | Array of Objects | 列表 | result |
表result
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| policyID | 否 | String | 策略id | be012e8f-ea32-4a2c-89da-7db35eedb334 | |
| policyName | 否 | String | 策略名称 | policy-001 | |
| selectType | 否 | String | 本参数表示方式 取值范围: priority:优先级 quality:质量 weight:权重 quality:质量 |
priority | |
| protocol | 否 | String | 本参数表示协议类型 取值范围： tcp：tcp协议 udp：udp协议 icmp：icmp协议 |
tcp | |
| priority | 否 | Integer | 优先级（取值范围：1~500） | 50 | |
| srcCidr | 否 | String | 源网段 | 10.20.0.0/16 | |
| srcPort | 否 | String | 源端口范围（例如1-200， -1/-1为默认值，表示1-65535，范围1-65535） | -1/-1 | |
| dstCidr | 否 | String | 目的网段 | 10.10.0.0/16 | |
| dstPort | 否 | String | 目的端口范围（例如1-200， -1/-1为默认值，表示1-65535，范围1-65535） | -1/-1 | |
| linkList | 否 | Array of Objects | 链路列表 | linkList | |
| linkQualityID | 否 | String | 链路探测业务id,selectType选quality必填 | 12352e8f-ea32-4a2c-89da-7db35eedb334 | |
| linkQualityName | 否 | String | 链路探测业务名称,selectType选quality必填 | link_001 | |
| appList | 否 | Array of Objects | 应用列表 | appList | |
| quality | 否 | Object | 链路质量参数 | quality |
表linkList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| linkPort | 否 | String | 本参数表示端口名称 取值范围: WAN1:WAN1 WAN2:WAN2 LAN:LAN LTE:LTE |
WAN1 | |
| linkValue | 否 | Integer | 当selectType为priority和quality时，取值为1，2，3，当selectType为weight时，取值为1~10 | 2 |
表appList
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appID | 否 | Integer | 应用ID | 57001 |
表quality
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| delay | 否 | Integer | 时延（时延，抖动，丢包率三者相加为100） | 10 | |
| jitter | 否 | Integer | 抖动（时延，抖动，丢包率三者相加为100） | 50 | |
| lost | 否 | Integer | 丢包率（时延，抖动，丢包率三者相加为100） | 40 |
请求示例
请求url
/v4/sdwan/edge-policy/query?policyID=be012e8f-ea32-4a2c-89da-7db35eedb334&edgeID=2893f150-19b5-11eb-8e79-824da1059800
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 1,
"currentCount": 1,
"result": [
{
"policyID": "be012e8f-ea32-4a2c-89da-7db35eedb334",
"policyName": "policy-001",
"selectType": "quality",
"protocol": "tcp",
"priority": 50,
"srcCidr": "10.20.0.0/16",
"srcPort": "-1/-1",
"dstCidr": "10.10.0.0/16",
"dstPort": "-1/-1",
"linkList": [
{
"linkPort": "WAN1",
"linkValue": 2
}
],
"linkQualityID": "12352e8f-ea32-4a2c-89da-7db35eedb334",
"linkQualityName": "link-quality-001",
"appList": [
{
"appID": 57001
}
],
"quality": {
"delay": 10,
"jitter": 30,
"lost": 30
}
}
]
},
"errorCode": "",
"message": "",
"description": ""
}
状态码
| 状态码 | 含义 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 含义 |
|---|---|
| Openapi.PatternCheck.NotValid | 请求参数无效 |
