自定义监控项
自定义监控项:修改
接口功能介绍
调用此接口可修改自定义监控项。
接口约束
自定义监控项ID ,监控项名称
URI
POST /v4/monitor/modify-custom-item
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
customItemID | 是 | String | 自定义监控项ID,必须是已存在的自定义监控项ID | ITEM793d5923652be6ce202306291409 | |
name | 是 | String | 修改后的监控项名称,必须4-20个字符,支持中英文、数字、下划线,且不能以数字开头 | 我的新CPU使用率 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
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/modify-custom-item
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"customItemID": "ITEM793d5923652be6ce202306291409",
"name": "我的新CPU使用率"
}
响应示例
{
"statusCode":800,
"returnObj":{
"customItemID":"ITEM793d5923652be6ce202306291409"
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.CustomItem.NameAlreadyExist | 监控项名称已存在,不能重复 |
Monitor.CustomItem.ItemIDNotFound | 监控项ID不存在 |
其他 | 参见公共错误码说明 |