接口功能介绍
查看指定资源池内的所有监控面板的具体内容，或者查看某一指定监控面板的内容。
接口约束
regionID（资源池）存在，如果查询指定监控面板内容，则需要templateID（监控面板）存在。
URI
GET /v4/monitor/describe-monitor
请求参数
Query参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
|---|---|---|---|---|---|
| regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
| templateID | String | 否 | 0bf803e8-5049-11ed-8fb7-005056897257 | 监控面板ID | |
| pageNo | Integer | 否 | 1 | 页码，默认为1 | |
| page | Integer | 否 | 1 | 页码，默认为1，建议使用pageNo，该参数后续会下线 | |
| pageSize | Integer | 否 | 2 | 页大小，默认为10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| returnObj | Object | 返回对象 | returnObj |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| templateList | Array of Objects | 监控面板具体内容 | templateList | |
| totalCount | Integer | 查询到的监控面板个数 | 1 | |
| page | Integer | 页码，建议参考请求参数pageNo，该参数后续会下线 | 1 | |
| pageSize | Integer | 页大小，建议参考请求参数pageSize，该参数后续会下线 | 10 | |
| totalPage | Integer | 总页数 | 1 | |
| currentCount | Integer | 当前页记录数 | 14 |
表templateList
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| templateID | String | 监控面板ID | 0bf803e8-5049-11ed-8fb7-005056897257 | |
| name | String | 监控面板名称 | whGHk | |
| regionCtyunID | String | 监控面板所属资源池ID | 81f7728662dd11ec810800155d307d5b | |
| fuserLastUpdated | String | 上次更新时间 | 2022-10-20T07:30:19Z | |
| list | Array of Objects | 监控视图具体内容 | list |
表list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| title | String | 监控视图名称 | testViewName | |
| content | Array of Objects | 监控项具体内容，为key-value格式 | content | |
| viewID | String | 监控视图ID | 4cb790ae-4894-11ed-b386-005056897257 |
表content
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| {itemName} | String | 监控项名称 | dim | |
| {value} | Object | 监控项值，与监控项名称组成key-value格式，可以为任意内容 | turn-test8 |
请求示例
GET /v4/monitor/describe-monitor?regionID=81f7728662dd11ec810800155d307d5b&templateID=d9f53eb4-616f-11ed-80c4-005056897257&page=1&pageSize=3
响应示例
{
"statusCode": 800,
"returnObj": {
"templateList": [
{
"templateID": "d9f53eb4-616f-11ed-80c4-005056897257",
"name": "new_template2022-11-11 11:20:52.515426",
"regionCtyunID": "81f7728662dd11ec810800155d307d5b",
"fuserLastUpdated": "2022-11-21T07:42:26Z",
"list": [
{
"viewID": "0b21c108-6970-11ed-aa29-005056897257",
"title": "测试2",
"content": [
{
"dim": "site_monitor",
"ser": "site_monitor",
"regionid": "81f7728662dd11ec810800155d307d5b",
"uuidName": "turn-test8",
"item": "ping_average_response_ms",
"selectedOptions": [
"6d3867dd-5884-1e08-01e8-f4a7cc711f04"
],
"uuid": "6d3867dd-5884-1e08-01e8-f4a7cc711f04"
}
]
}
]
}
],
"totalCount": 1,
"page": 1,
"pageSize": 3,
"totalPage": 1,
"currentCount": 1
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.Template.NotExist | 监控面板不存在 |
| 其他 | 参见公共错误码说明 |
