接口功能介绍
调用此接口可清空资源分组中某些类型资源。
接口约束
资源分组已存在。
URI
POST /v4/monitor/trancate-resource-group
请求参数
请求体body参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
resGroupID | String | 是 | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | 资源分组ID | |
deviceTypeList | Array of String | 是 | ["vm"] | 要清空的设备类型列表 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回参数 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
success | Boolean | 是否成功 | true |
请求示例
POST /v4/monitor/trancate-resource-group
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"resGroupID": "5ce993cb-71c6-5ef0-a386-879b6f183979",
"deviceTypeList": ["vm"]
]
}
响应示例
{
"statusCode":800,
"returnObj":{
"success":true
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
Monitor.ResourceGroup.ResourceGroupNotFoundError | 资源分组不存在错误 |
其他 | 参见公共错误码说明 |