-
响应示例 返回状态码为201:创建成功,响应体参考VpnQosGroupInfoResponse。 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",
"name" : "VPN-Group1",
"description" : "**********",
"vpnList" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN1"
}
]
}
],
"fail" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN-Group1",
"description" : "**********",
"vpnList" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN1"
}
]
}
],
"processInstanceId" : "00000000-0000-0000-0000-000000000000"
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考VpnQosGroupInfoResponse。 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
-
响应参数 返回状态码为201:创建成功,响应体参考VpnQosGroupInfoResponse。 表4 VpnQosGroupInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" success ARRAY_REFERENCE 0-1000个列表项,详细请参见表5。 成功的VPN QoS组信息列表。 - fail ARRAY_REFERENCE 0-1000个列表项,详细请参见表5。 失败的VPN QoS组信息列表。 - processInstanceId string 0~36个字符。 - 编排流程实例ID,UUID格式。当接口返回码为202时非空。 "00000000-0000-0000-0000-000000000000" 表5 VpnQosGroupInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - VPN QoS组 ID,主键字段,修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" name string 1~64个字符。 - VPN QoS组名称,创建或修改时候必填,值唯一。 "VPN-Group1" description string 0~256个字符。 - VPN QoS组描述。 "**********" vpnList ARRAY_REFERENCE 0-300个列表项,详细请参见表6。 VPN QoS组关联的VPN列表,创建和修改VPN QoS组时可以为空。创建时为空则默认创建一个不包含任何VPN的空组。修改时为空则默认不修改VPN成员。 - 表6 VpnInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - VPN ID,不可以为空。 "00000000-0000-0000-0000-000000000000" name string 0~64个字符。 - VPN 名称,查询VPN QoS组时候接口返回。结构体作为接口入参场景不需要传入。 "VPN1" 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考VpnQosGroupInfoResponse。 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 POST /controller/campus/v1/sdwan/policy/traffic/vpn-qosgroup 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
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN-Group1",
"description" : "**********",
"vpnList" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN1"
}
]
}
-
请求参数 表1 body参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 vpnQosGroupInfo 是 REFERENCE 详细请参见表2。 创建VPN QoS组的请求参数。 - 表2 VpnQosGroupInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - VPN QoS组 ID,主键字段,修改或删除的时候必填。 "00000000-0000-0000-0000-000000000000" name 否 string 1~64个字符。 - VPN QoS组名称,创建或修改时候必填,值唯一。 "VPN-Group1" description 否 string 0~256个字符。 - VPN QoS组描述。 "**********" vpnList 否 ARRAY_REFERENCE 0-300个列表项,详细请参见表3。 VPN QoS组关联的VPN列表,创建和修改VPN QoS组时可以为空。创建时为空则默认创建一个不包含任何VPN的空组。修改时为空则默认不修改VPN成员。 - 表3 VpnInfo对象的参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 id 否 uuid - - VPN ID,不可以为空。 "00000000-0000-0000-0000-000000000000" name 否 string 0~64个字符。 - VPN 名称,查询VPN QoS组时候接口返回。结构体作为接口入参场景不需要传入。 "VPN1"
-
响应示例 返回状态码为200:查询成功,响应体参考VpnInfoResponse。 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,
"vpnList" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN1"
}
]
} 返回状态码为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/vpn-qosgroup/vpn?id=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:查询成功,响应体参考VpnInfoResponse。 表2 VpnInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 vpnList ARRAY_REFERENCE 0-1000个列表项,详细请参见表6。 VPN QoS组信息。 - 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/vpn-qosgroup/unconfiged/vpn?policyFilter=false 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:查询成功,响应体参考VpnInfoResponse。 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,
"vpnList" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN1"
}
]
} 返回状态码为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:查询成功,响应体参考QueryVpnQosGroupInfoResponse。 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",
"name" : "VPN-Group1",
"description" : "**********",
"vpnNumbers" : 10,
"policyNumbers" : 10
}
]
} 返回状态码为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/vpn-qosgroup/list?name=VPN-Group1 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:查询成功,响应体参考PolicyInfoResponse。 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,
"policyList" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "policyName",
"type" : "qos"
}
]
} 返回状态码为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:查询成功,响应体参考PolicyInfoResponse。 表2 PolicyInfoResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string - - 错误码。 "0" errmsg string - - 错误信息。 "" totalRecords int32 - - 总的数据条数。 1 pageSize int32 - - 每页显示数量。 10 pageIndex int32 - - 当前页数。 1 policyList ARRAY_REFERENCE 0-1000个列表项,详细请参见表3。 VPN QoS组信息。 - 表3 PolicyInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 id uuid - - policy ID,不可以为空。 "00000000-0000-0000-0000-000000000000" name string 1~64个字符。 - 关联policy名称 "policyName" type string - - 关联policy类型,包含qos,traffic,bandwidthMgr "qos" 返回状态码为400:请求参数错误,无响应体。 详细信息请参见实际响应消息体。 返回状态码为500:内部错误,无响应体。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/policy/traffic/vpn-qosgroup/policy?id=00000000-0000-0000-0000-000000000000&keyword=policy1 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:删除成功,响应体参考VpnQosGroupInfoResponse。 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",
"name" : "VPN-Group1",
"description" : "**********",
"vpnList" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN1"
}
]
}
],
"fail" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN-Group1",
"description" : "**********",
"vpnList" : [
{
"id" : "00000000-0000-0000-0000-000000000000",
"name" : "VPN1"
}
]
}
],
"processInstanceId" : "00000000-0000-0000-0000-000000000000"
} 返回状态码为202:请求正在处理中,请求处理详情请通过“查询业务编排结果”接口,确认是否处理成功。响应体参考VpnQosGroupInfoResponse。 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