资源分组
资源分组：创建
接口功能介绍
调用此接口可创建一个资源分组。
接口约束
- 资源分组名称不可重复。
- 可创建的资源分组数量不能超出配额数量。
- 其他参见请求参数说明。
URI
POST /v4.1/monitor/create-resource-group
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池ID | 81f7728662dd11ec810800155d307d5b | |
| name | 是 | String | 资源分组名称，长度2-40个字符。 | group_name | |
| createType | 否 | String | 本参数表示创建方式。取值范围：instance：实例创建。根据以上范围取值。默认值：instance。 | instance | |
| 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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resGroupID | String | 资源分组ID | d8fc344b-06d1-57dd-bb3b-f17a52fca09f |
请求示例
请求url
/v4.1/monitor/create-resource-group
请求头header
无
请求体body
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"createType": "instance",
"name": "vm_res_group",
"desc": "this is desc",
"resourceList": [
{
"service": "ecs",
"dimension": "ecs",
"resources": [
{
"resource": [
{
"name": "instancename",
"value": "ecm1"
},
{
"name": "uuid",
"value": "2e8ad126-3f08-11ed-95a4-acde48001100"
}
]
}
]
}
]
}
响应示例
{
"statusCode": 800,
"returnObj": {
"resGroupID": "acda5922-526a-5482-bd1a-ed13da9d1a54"
},
"errorCode": "",
"message": "Success",
"msgDesc": "成功",
"description": "成功"
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
错误码
| errorCode | 描述 |
|---|---|
| Monitor.ResourceGroup.NameAlreadyExist | 资源分组名称已存在 |
| Monitor.ResourceGroup.QuotaLimit | 资源分组配额不足 |
| 其他 | 参见公共错误码说明 |
