資源分組：更新v4.1
更新時間 2024-11-29 18:48:29
最近更新時間: 2024-11-29 18:48:29
分享文章
資源分組
資源分組：更新
接口功能介紹
調用此接口可更新資源分組，支持全量字段修改。
接口約束
- 資源分組名稱不可重復。
- 其他參見請求參數說明。
URI
POST /v4.1/monitor/update-resource-group
路徑參數
無
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 資源池ID | 81f7728662dd11ec810800155d307d5b | |
| resGroupID | 是 | String | 資源分組ID | 95f7f0cb-b5d7-547e-8667-3fceeab177d5 | |
| name | 是 | String | 資源分組新名稱，長度2-40個字符。 | group_name | |
| desc | 否 | String | 資源分組新描述， 長度不超過100個字符，默認值為空字符。 | 描述 | |
| resourceList | 是 | Array of Objects | 資源列表，資源列表中的元素resourceListObj的個數不超過20個。 | resourceListObj |
表 resourceListObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| service | 是 | String | 云監控服務，具體服務參見云監控：查詢服務維度及監控項 | ecs | |
| dimension | 是 | String | 云監控維度，具體維度參見云監控：查詢服務維度及監控項 | ecs | |
| resources | 是 | Array of Objects | 資源信息列表 | resources |
表 resources
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| resource | 是 | Array of Objects | 資源信息 | resourceObj |
表 resourceObj
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| name | 是 | String | 實例標簽名 | uuid | |
| value | 是 | String | 實例標簽對應的值，無效值將無法正常產生告警。 | 000f0322-1f4d-8cc8-bb2e-1c30fb751aa5 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 返回狀態碼（800為成功，900為失敗），默認值：800 | 800 | |
| errorCode | String | 失敗時的錯誤代碼，參見公共錯誤碼說明 | ||
| message | String | 失敗時的錯誤描述，一般為英文描述 | Success | |
| msgDesc | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| description | String | 失敗時的錯誤描述，適配中英文 | 成功 | |
| error | String | 錯誤碼，請求成功時，不返回該字段 | Openapi.Parameter.Error | |
| returnObj | Object | 返回參數 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| success | Boolean | 更新成功標識 | true |
請求示例
請求url
/v4.1/monitor/update-resource-group
請求頭header
無
請求體body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"resGroupID": "95f7f0cb-b5d7-547e-8667-3fceeab177d5",
"name": "vm_res_group",
"resourceList": [
{
"service": "ecs",
"dimension": "ecs",
"resources": [
{
"resource": [
{
"name": "instancename",
"value": "ecm1"
},
{
"name": "uuid",
"value": "2e8ad126-3f08-11ed-95a4-acde48001100"
}
]
}
]
}
]
}
響應示例
{
"statusCode": 800,
"returnObj": {
"success": true
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
狀態碼
| 狀態碼 | 描述 |
|---|---|
| 200 | 請求成功 |
錯誤碼
| errorCode | 描述 |
|---|---|
| Monitor.ResourceGroup.ResourceGroupNotExist | 資源分組不存在 |
| Monitor.ResourceGroup.NameAlreadyExist | 資源分組名稱已存在 |
| 其他 | 參見公共錯誤碼說明 |
