文档中心

云监控

对象分组

ListObjectGroups

查询对象分组列表。

请求说明

请求方式：POST

请求地址：https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListObjectGroups&Version=2018-01-01

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListObjectGroups	接口名称。当前 API 的名称为 ListObjectGroups。
Version	String	是	2018-01-01	接口版本。当前 API 的版本为 2018-01-01。
PageSize	Integer	否	20	分页查询时每页的行数，默认值为10。
PageNumber	Integer	否	1	列表的页码，取值 > 0，默认值为1。要查询的列表范围为：实际起始位置 = (PageNumber-1) * PageSize 实际终止位置 = PageNumber * PageSize
Ids	Array of String	否	["1744977683943******"]	对象分组 ID 列表。
Name	String	否	object_group	对象分组名称的关键字，支持模糊查询。
AlertTemplateIds	Array of String	否	['1963447872315***']	告警模版 ID，支持基于告警模板 ID 列表查询。

请求示例

POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListObjectGroups&Version=2018-01-01​
Content-Type: application/json​
{​
    "Ids": [​
        "1744977683943******"​
    ],​
    "Name": "object_group",​
    "AlertTemplateIds": [​
        "1963447872315***"​
    ],​
    "PageNumber": 1,​
    "PageSize": 20​
}​

返回参数

参数	类型	示例值	描述
Data	Array of ObjectGroupVO	-	符合条件的对象分组详细信息。

ObjectGroupVO

参数	类型	示例值	描述
Id	String	1744977683943******	对象分组 ID。
Name	String	object_group_demo	对象分组名称。
Objects	Array of Object	-	对象分组下的云产品资源列表。
CreatedAt	String	2021-10-25T18:27:24+08:00	对象分组的创建时间。
UpdatedAt	String	2021-10-25T18:49:43+08:00	对象分组的更新时间。
AlertTemplateId	String	1744971093943******	对象分组关联的告警模板 ID。注意该字段即将废弃，建议使用TemplateDetails字段。
AlertTemplateName	String	告警模版	对象分组关联的告警模板名称。注意该字段即将废弃，建议使用TemplateDetails字段。
TemplateDetails	Array of TemplateDetail	-	对象分组管理的全部告警模版。

Object

参数	类型	示例值	描述
Id	String	1763465351913******	对象分组 ID。
Namespace	String	VCM_ECS	云产品在云监控中所属的产品空间。详情请参见云产品监控指标下各产品的 Namespace。
Dimensions	JSON Map	-	云产品资源 ID 集合。
Region	String	cn-beijing	当前资源合集下云产品所属可用区。当Type为enum时，只支持选择一个 Region。当Type为dynamic时，支持选择多个 Region，不同 Region 之间通过英文逗号,分隔。
Type	String	enum	资源合集类型。 enum：手动选择。如果定义为 enum，则Dimensions不能为空。 dynamic：通过资源名称、项目和标签选择。如果定义为 dynamic，则DimensionConditions不能为空。
Rules	Array of BindRules	-	关联的告警策略。
DimensionConditions	Object of DimensionConditions	-	Dimension 配置。

TemplateDetail

参数	类型	示例值	描述
AlertTemplateId	String	1963498169788***	告警模版 ID。
AlertTemplateName	String	alert-template-demo	告警模版名称。

Dimensions

参数	类型	示例值	描述
key	String	ResourceID	检索指标的 KEY。
value	Array of String	i-es***	检索指标 KEY 对应的 Value。

BindRules

参数	类型	示例值	描述
Id	String	1354766247190******	关联的告警策略 ID。
Name	String	rule1	关联的告警策略的名称。
TemplateRuleId	String	1963498169788***	关联的告警策略模版 ID。
AlertTemplateId	String	1963498169788***	关联的告警模版 ID。

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：部分资源。

ProjectCondition

参数	类型	示例值	描述
Projects	Array of String	["testDefault1", "testDefault2"]	项目名称列表。数组形式。多个值之间使用英文半角逗号,分割。

KVComparator

参数	类型	示例值	描述
Key	String	testKey	标签的键（Key）。
Values	Array of String	["testValues", "testValues2"]	标签的值（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	资源名称。目前仅支持配置为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：不等于

返回示例

{​
    "ResponseMetadata": {​
        "Action": "ListObjectGroups",​
        "Region": "cn-beijing",​
        "Service": "cloudmonitor",​
        "Version": "2018-01-01",​
        "RequestId": "20230604110420****100232280022D31"​
    },​
    "Result": {​
        "Data": [​
            {​
                "Id": "1744977683943******",​
                "Name": "object_group_demo",​
                "Objects": [​
                    {​
                        "Id": "1763465351913******",​
                        "Type": "enum",​
                        "Rules": [​
                            {​
                                "Id": "1354766247190******",​
                                "Name": "rule1",​
                                "TemplateRuleId": "1963498169788***",​
                                "AlertTemplateId": "1963498169788***"​
                            }​
                        ],​
                        "Region": "cn-beijing",​
                        "Namespace": "VCM_ECS",​
                        "DimensionConditions": {​
                            "Type": "meta",​
                            "TagCondition": {​
                                "Tags": [​
                                    {​
                                        "Key": "testKey",​
                                        "Values": [​
                                            "testValues",​
                                            "testValues2"​
                                        ],​
                                        "Comparator": "equal"​
                                    }​
                                ],​
                                "Condition": "and"​
                            },​
                            "MetaCondition": {​
                                "Metas": [​
                                    {​
                                        "Key": "ResourceName",​
                                        "Values": [​
                                            "testResource1",​
                                            "testResource2"​
                                        ],​
                                        "Comparator": "equal"​
                                    }​
                                ],​
                                "Condition": "or",​
                                "AllDimensions": true​
                            },​
                            "ProjectCondition": {​
                                "Projects": [​
                                    "testDefault1",​
                                    "testDefault2"​
                                ]​
                            }​
                        }​
                    }​
                ],​
                "CreatedAt": "2021-10-25T18:27:24+08:00",​
                "UpdatedAt": "2021-10-25T18:49:43+08:00",​
                "AlertTemplateId": "1744971093943******",​
                "AlertTemplateName": "告警模版",​
                "TemplateDetails": [​
                    {​
                        "AlertTemplateId": "1963498169788***",​
                        "AlertTemplateName": "alert-template-demo"​
                    }​
                ]​
            }​
        ]​
    }​
}​

错误码

本接口无特有的错误码。更多信息请参见错误码。

最近更新时间：2026.08.11 20:28:01

这个页面对您有帮助吗？

有用

无用