接口说明
调用 listApp 接口分页获取应用监控任务列表。
请求头
该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。
请求语法
GET /paasopenapi/api/cmparmsadmin/cmparms/app/list HTTP/1.1
请求参数(修改Apifox类型)
名称 | 类型 | 位置 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|---|
regionCode | String | Query | 是 | bbd132b51e942ac1100 | 资源池编码 |
name | String | Query | 否 | test-name | 应用名称 |
sort | String | Query | 否 | time | 排序字段(time:接入时间,avgDuration:平均耗时,qps:错误数,errorRate:错误率),默认:time |
order | String | Query | 否 | desc | 排序方式(desc/asc),默认:desc |
startTime | Long | Query | 是 | 1689038853000 | 开始时间(ms) |
endTime | Long | Query | 否 | 1689039853000 | 结束时间(ms) |
pageNum | Integer | Query | 否 | 1 | 页码 |
pageSize | Integer | Query | 否 | 10 | 每页记录数 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Integer | 0 | 响应状态码。0:成功,-1:失败 |
msg | String | "" | 响应描述 |
data | Object | 应用监控任务分页列表。 |
data数据结构如下:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
List | Object | 应用监控任务分页列表。 |
ApplicationDTO的数据结构如下:
名称 | 类型 | 示例 | 描述 |
---|---|---|---|
id | String | 10001 | ID |
name | String | test_name | 应用名称 |
serviceName | String | test_serviceName | arms的服务名称 |
projectCode | String | carms | edas的项目编码,arms默认是“carms” |
deployment | String | carms | edas的部署环境编码,arms默认是“carms” |
appLanguage | String | java,go | 接入应用开发语言 java、go、python、php,多个以逗号分隔 |
示例
请求示例
GET /paasopenapi/api/cmparmsadmin/cmparms/app/list?regionCode=bbd132b51e942ac1100&startTime= HTTP/1.1
Content-Type:application/json
正常返回示例
HTTP/1.1200 OK
{
"code":0,
"data":[
{
"agentType":"",
"appLanguage":"java,go",
"avgDuration":0,
"avgDurations":[
{
"timestamp":0,
"value":0
}
],
"deployment":"_carms_",
"errorRate":0,
"id":10001,
"intervalInMillSec":0,
"name":"test_name",
"projectCode":"_carms_",
"qps":0,
"serviceName":"test_serviceName"
}
]
"msg":""
}
错误码
Http状态码 | 错误码 | 错误码描述 |
---|---|---|
400 | MissingParameter | 缺少必要的请求参数 |
400 | InvalidParameterValue | 请求参数取值错误 |
500 | FailedOperation | 操作失败 |