-
响应示例 返回状态码为200：查询成功，响应体参考AppDetailResponse。 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" : [
{
"linkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"linkName" : "link",
"appId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"appName" : "app",
"metricDatas" : [
{
"name" : "***",
"value" : [
{
"timestamp" : "1985-04-12T23:20:50.52Z",
"value" : 50
}
]
}
]
}
]
} 返回状态码为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、返回数据类型与用户查询时间范围以及查询开始时间有关： *查询开始时间小于等于7天，且查询时间范围小于等于24H时，返回原始分钟级数据，时间范围大于24H时，返回小时级别数据； *查询开始时间大于7天，小于等于60天，且查询时间范围小于等于7天时，返回小时级别数据，时间范围大于7天时，返回天级别数据； *查询开始时间大于60天时，返回天级别数据； *查询应用质量数据时，不包含链路信息，同时查询流量与质量数据，分开返回应用信息； *查询流量指标（netstream）时，后台只返回netstream_upward流量数据。
-
URI /controller/campus/v1/sdwan/performance/intersite/app/list 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 sourceSiteId 是 string 0~36个字符。 - 源站点标识，UUID格式，可由网络侧提供接口获取。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" destSiteId 是 string 0~36个字符。 - 目的站点标识，UUID格式，可由网络侧提供接口获取。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" metric 是 string - - 查询指标，该字段可以设置为以下几种： a) netstream：流量，单位是字节（Byte）。 b) packetloss：丢包，单位是百分比（%）。 c) delay：时延，单位是毫秒（ms）。 如果查询多个指标用逗号分隔（如：netstream,delay）。 "packetloss" startTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的开始时间，UTC时间，直接调用URL，特殊符号参数需要手动转义，如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z" endTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的结束时间，UTC时间，直接调用URL，特殊符号参数需要手动转义，如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z"
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/performance/intersite/app/list?sourceSiteId=fbb684c8-0d37-496f-bafa-4b06d515j7l6&destSiteId=fbb684c8-0d37-496f-bafa-4b06d515j7l6&metric=packetloss&startTime=1985-04-12T23:20:50.052Z&endTime=1985-04-12T23:20:50.052Z 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
-
响应示例 返回状态码为200：查询成功，响应体参考DeviceDetailsResponse。 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" : [
{
"deviceId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"deviceName" : "device1",
"metricDatas" : [
{
"name" : "***",
"value" : [
{
"timestamp" : "1985-04-12T23:20:50.52Z",
"value" : 50
}
]
}
]
}
]
} 返回状态码为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：查询成功，响应体参考DeviceDetailsResponse。 表2 DeviceDetailsResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-100000000个列表项，详细请参见表3。 设备信息。 - 表3 DeviceInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 deviceId string 36个字符。 - 设备ID。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" deviceName string 0~128个字符。 - 设备名称。 "device1" metricDatas ARRAY_REFERENCE 0-100000000个列表项，详细请参见表4。 指标返回值，包括CPU、温度、内存、硬盘。 - 表4 MetricObject对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 name string - - 指标名称，具体名称对应根据metric而定。 "***" value ARRAY_REFERENCE 0-100000000个列表项，详细请参见表5。 - - 表5 MetricValue对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 timestamp string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[\+\-]\d{2}:\d{2})。 - UTC时间。 "1985-04-12T23:20:50.52Z" value double - - 返回值。指标CPU（cpu）对应设备CPU利用率数据，单位为百分比%；内存（memory）对应设备内存利用率数据，单位为百分比%；温度（temperature）对应设备温度数据，单位为摄氏度C；硬盘（harddisk）对应设备硬盘利用率数据，单位为百分比%；丢包（packetloss）对应链路（应用）的丢包率数据，单位是百分比%；时延（delay）对应链路（应用）的时延数据，单位是毫秒（ms）；抖动（jitter）对应应用的抖动数据，单位是毫秒（ms）；流量（netstream）对应链路（应用）的流量数据，单位是字节（Byte）。 50 返回状态码为400：校验异常 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误。 详细信息请参见实际响应消息体。
-
URI /controller/campus/v1/sdwan/performance/site/device/list 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点标识，UUID格式，可由网络侧提供接口获取。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" metric 是 string - - 查询指标，该字段可以设置为以下几种： a) cpu：CPU，单位是百分比（%）。 b) memory：内存，单位是百分比（%）。 c) temperature：温度，单位是摄氏度（℃）。 d) harddisk：硬盘，单位是百分比（%）。 如果查询多个指标用逗号分隔（如：cpu,memory）。 "cpu" startTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的开始时间，UTC时间，直接调用URL，特殊符号参数需要手动转义，如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z" endTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的结束时间，UTC时间，直接调用URL，特殊符号参数需要手动转义，如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z"
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/performance/site/device/list?siteId=fbb684c8-0d37-496f-bafa-4b06d515j7l6&metric=cpu&startTime=1985-04-12T23:20:50.052Z&endTime=1985-04-12T23:20:50.052Z 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：查询成功，响应体参考AppDetailResponse。 表2 AppDetailResponse对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 errcode string 0~64个字符。 - 错误码。 "0" errmsg string 0~256个字符。 - 错误信息。 "" data ARRAY_REFERENCE 0-100000000个列表项，详细请参见表3。 - - 表3 AppInfo对象的参数列表 参数名称 类型 参数值域 默认值 参数说明 参数示例 linkId string 36个字符。 - 链路长ID。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" linkName string 0~128个字符。 - 链路名称。 "link" appId string 36个字符。 - 应用长ID。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" appName string 0~128个字符。 - 应用名称。 "app" metricDatas ARRAY_REFERENCE 0-100000000个列表项，详细请参见表4。 指标返回值，包括流量、丢包、时延。 - 返回状态码为400：校验异常 详细信息请参见实际响应消息体。 返回状态码为500：内部服务器错误。 详细信息请参见实际响应消息体。
-
请求示例 HTTP的示例 GET /controller/campus/v1/sdwan/performance/site/app/list?siteId=fbb684c8-0d37-496f-bafa-4b06d515j7l6&metric=packetloss&startTime=1985-04-12T23:20:50.052Z&endTime=1985-04-12T23:20:50.052Z 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：查询成功，响应体参考AppDetailResponse。 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" : [
{
"linkId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"linkName" : "link",
"appId" : "fbb684c8-0d37-496f-bafa-4b06d515j7l6",
"appName" : "app",
"metricDatas" : [
{
"name" : "***",
"value" : [
{
"timestamp" : "1985-04-12T23:20:50.52Z",
"value" : 50
}
]
}
]
}
]
} 返回状态码为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、返回数据类型与用户查询时间范围以及查询开始时间有关： *查询开始时间小于等于7天（站点应用流量数据为40天），且查询时间范围小于等于24H时，返回原始分钟级数据，时间范围大于24H时，返回小时级别数据； *查询开始时间大于7天（站点应用流量数据为40天），小于等于60天，且查询时间范围小于等于7天时，返回小时级别数据，时间范围大于7天时，返回天级别数据； *查询开始时间大于60天时，返回天级别数据； *查询流量指标（netstream）时，后台返回两种流量数据（netstream_upward，netstream_downward）； *流量包含netstream的Overlay流量和Local Breakout流量之和； *查询应用质量数据时，不包含链路信息，同时查询流量与质量数据，分开返回应用信息。
-
URI /controller/campus/v1/sdwan/performance/site/app/list 表1 query参数列表 参数名称 必选 类型 参数值域 默认值 参数说明 参数示例 siteId 是 string 0~36个字符。 - 站点标识，UUID格式，可由网络侧提供接口获取。 "fbb684c8-0d37-496f-bafa-4b06d515j7l6" metric 是 string - - 查询指标，该字段可以设置为以下几种： a) netstream：流量，单位是字节（Byte）。 b) packetloss：丢包，单位是百分比（%）。 c) delay：时延，单位是毫秒（ms）。 如果查询多个指标用逗号分隔（如：netstream,delay）。 "packetloss" startTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的开始时间，UTC时间，直接调用URL，特殊符号参数需要手动转义，如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z" endTime 是 string 满足正则表达\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})(Z|[\+\-]\d{2}:\d{2})。 - 查询的结束时间，UTC时间，直接调用URL，特殊符号参数需要手动转义，如"+"使用"%2B"代替。 "1985-04-12T23:20:50.052Z"
