自定义监控项
自定义监控项：创建
接口功能介绍
调用此接口可创建自定义监控项。
接口约束
资源池ID，监控项名称，单位，上报频率不能为空。
URI
POST /v4/monitor/create-custom-item
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 监控项名称，必须4-20个字符，支持中英文、数字、下划线，且不能以数字开头。同一用户在同一资源池下不能重复 | 我的CPU使用率 | |
| unit | 是 | String | 自定义监控项的单位 | % | |
| interval | 是 | Integer | 数据上报间隔，单位秒 | 60 | |
| dimensions | 否 | Array of Objects | 用于查询监控数据的维度，目前最多支持三个维度 | dimensions |
表 dimensions
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | uuid | 维度名称，支持英文、下划线 | |
| description | 否 | String | 主机的唯一标识 | 维度描述，支持中文、英文、下划线 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败），默认值：800 | 800 | |
| errorCode | String | 失败时的错误代码，参见公共错误码说明 | ||
| message | String | 失败时的错误描述，一般为英文描述 | Success | |
| msgDesc | String | 失败时的错误描述，一般为中文描述 | 成功 | |
| error | String | 错误码，请求成功时，不返回该字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回参数，参考returnObj对象结构 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| customItemID | String | 自定义监控项ID | ITEM793d5923652be6ce202306291409 |
请求示例
请求url
/v4/monitor/create-custom-item
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"name": "我的CPU使用率",
"unit": "%",
"interval": 60,
"dimensions": [
{
"name": "uuid",
"description": "主机的唯一标识"
},
{
"name": "usage",
"description": "主机用途"
}
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"customItemID":"ITEM793d5923652be6ce202306291409"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.CustomItem.NameAlreadyExist | 监控项名称已存在，不能重复 |
| 其他 | 参见公共错误码说明 |
