CreateObjectGroup--云监控-火山引擎

文档中心

立即注册

导航

CreateObjectGroup

最近更新时间：2024.10.17 19:07:49首次发布时间：2024.03.18 17:01:10

创建一个对象分组。

使用限制

一个账户最多创建100个对象分组。
一个对象分组最多包含100个云产品，每个云产品最多包含1000个资源；一个对象分组最多包含5000个云产品资源。
一个对象分组只能绑定一个告警模板。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=CreateObjectGroup&Version=2018-01-01

ServiceName : Volc_Observe 
Region : cn-beijing 
AccessKey : xxx 
SecretKey : xxx

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateObjectGroup`	接口名称。当前 API 的名称为 `CreateObjectGroup`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Name	String	是	`testgroup`	对象分组名称。只能包含中英文或者下划线长度限制在1~64字符
Objects	Array of Object	是	`-`	需要分组的云产品资源列表，列表长度最大值`100`。

Name

String

是

testgroup

对象分组名称。

只能包含中英文或者下划线
长度限制在1~64字符

Objects Array of Object 是 - 需要分组的云产品资源列表，列表长度最大值100。

Object

参数	类型	是否必选	示例值	描述
Namespace	String	是	`VCM_EIP`	云产品在云监控中所属的产品空间。具体请参见云产品监控指标下各产品的Namespace。
Dimensions	JSON Map	是	`-`	云产品资源ID集合。
Region	String	是	`cn-beijing,cn-shanghai`	当前资源合集下云产品所属可用区。当Type为enum时，只支持选择一个region。当Type为dynamic时，支持选择多个region，不同region之间通过英文逗号（,）分隔。
Type	String	是	`enum`	资源合集类型。 enum：手动选择。如果定义为enum，则`Dimensions`不能为空。 dynamic：通过资源名称、项目和标签选择。如果定义为dynamic，则`DimensionConditions`不能为空。
DimensionConditions	Object of DimensionConditions	否	`-`	dimension配置。

Dimensions

参数	类型	是否必选	示例值	描述
key	String	是	`ResourceID`	检索指标的Key。
value	Array of String	是	`*`	检索指标的Key对应的value。

DimensionConditions

参数	类型	是否必选	示例值	描述
Type	String	否	`meta`	Dimensions类型。 project：根据标签配置告警对象 tag：根据标签配置告警对象 meta：根据资源名称配置告警对象
TagCondition	Object of TagCondition	否	`-`	Type为tag时必填，标签的匹配条件。
MetaCondition	Object of MetaCondition	否	`-`	Type为meta时必填，资源名称的匹配条件。
ProjectCondition	Object of ProjectCondition	否	`-`	Type为project时必填，项目的匹配条件。

TagCondition

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Tags	Array of KVComparator	否	`-`	标签列表。最多支持配置 10 个标签列表。标签值不能超过 50 个字符。
Condition	String	否	`and`	判断条件。 and：全部满足 or：任意满足

MetaCondition

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Metas	Array of MetaKVComparator	否	`-`	资源列表。最多支持配置 10 个资源名称列表。当 Comparator 配置为`equal`或者`not_equal`时，输入的资源名称字符长度没有限制。当 Comparator 配置为`contain`、`not_contain`、`prefix_match` 或者 `suffix_match`时，输入的资源名称不能超过 100 个字符。
Condition	String	否	`or`	判断条件。 and：全部满足 or：任意满足
AllDimensions	Boolean	否	`true`	是否为全量资源。 true：全部资源 false：部分资源

Metas

Array of MetaKVComparator

否

-

资源列表。

最多支持配置 10 个资源名称列表。
当 Comparator 配置为equal或者not_equal时，输入的资源名称字符长度没有限制。
当 Comparator 配置为contain、not_contain、prefix_match 或者 suffix_match时，输入的资源名称不能超过 100 个字符。

Condition

String

否

or

判断条件。

and：全部满足
or：任意满足

AllDimensions

Boolean

否

true

是否为全量资源。

true：全部资源
false：部分资源

ProjectCondition

参数	类型	是否必选	示例值	描述
Projects	Array of String	否	`["testDefault1", "testDefault2"]`	项目名称列表。

KVComparator

参数类型是否必选示例值描述

Key String 否 testKey 标签的key。

参数	类型	是否必选	示例值	描述
Key	String	否	`testKey`	标签的key。
Values	Array of String	否	`["testValues", "testValues2"]`	标签的key对应的value。当 Comparator 配置为`exist`时，包含 Key 对应的所有 Value，不支持输入。当 Comparator 配置为`equal`或者`not_equal`时，支持输入多个 Value。当 Comparator 配置为`contain`、`not_contain`、`prefix_match` 或者 `suffix_match`时，支持输入 1 个 Value。
Comparator	String	否	`equal`	比较符。 contain：包含 not_contain：不包含 prefix_match：前缀匹配 suffix_match：后缀匹配 equal：等于 not_equal：不等于 exist：存在

Values

Array of String

否

["testValues", "testValues2"]

标签的key对应的value。

当 Comparator 配置为exist时，包含 Key 对应的所有 Value，不支持输入。
当 Comparator 配置为equal或者not_equal时，支持输入多个 Value。
当 Comparator 配置为contain、not_contain、prefix_match 或者 suffix_match时，支持输入 1 个 Value。

Comparator

String

否

equal

比较符。

contain：包含
not_contain：不包含
prefix_match：前缀匹配
suffix_match：后缀匹配
equal：等于
not_equal：不等于
exist：存在

MetaKVComparator

参数类型是否必选示例值描述

Key String 否 ResourceName 资源的Key。目前只能配置为ResourceName。

参数	类型	是否必选	示例值	描述
Key	String	否	`ResourceName`	资源的Key。目前只能配置为ResourceName。
Values	Array of String	否	`["testResource1", "testResource2"]`	资源的Values。当 Comparator 配置为`equal`或者`not_equal`时，支持多个 Value。当 Comparator 配置为`contain`、`not_contain`、`prefix_match` 或者 `suffix_match`时，支持输入 1 个 Value。
Comparator	String	否	`equal`	比较符。 contain：包含 not_contain：不包含 prefix_match：前缀匹配 suffix_match：后缀匹配 equal：等于 not_equal：不等于

Values

Array of String

否

["testResource1", "testResource2"]

资源的Values。

当 Comparator 配置为equal或者not_equal时，支持多个 Value。
当 Comparator 配置为contain、not_contain、prefix_match 或者 suffix_match时，支持输入 1 个 Value。

Comparator

String

否

equal

比较符。

contain：包含
not_contain：不包含
prefix_match：前缀匹配
suffix_match：后缀匹配
equal：等于
not_equal：不等于

返回参数

参数	类型	示例值	描述
Data	String	`1764547228734******`	创建对象分组的ID。

请求示例

POST https://open.volcengineapi.com?Action=CreateObjectGroup&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "Name": "OpenAPI测试",
    "Objects": [
        {
            "Namespace": "VCM_ECS",
            "Dimensions": {
                "ResourceID": [
                    "i-ycsa9lvgu8cva4******",
                    "i-ycr7e0gmwwcva4******"
                ]
            },
            "Region": "cn-beijing",
            "Type":"enum"
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240304150337F609773DD7E2C2******",
        "Action": "CreateObjectGroup",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": ""
    },
    "Result": {
        "Data": "1764547228734******"
    }
}

云监控

使用限制

请求说明

Header

调试

请求参数

Query

Body

Object

Dimensions

DimensionConditions

TagCondition

MetaCondition

ProjectCondition

KVComparator

MetaKVComparator

返回参数

请求示例

返回示例