ListObjectGroups--云监控-火山引擎

文档中心

导航

ListObjectGroups

最近更新时间：2024.10.17 11:36:40首次发布时间：2024.03.18 17:01:10

获取对象分组列表，支持搜索对象分组名称的关键字进行模糊查询。

请求说明

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

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

调试

API Explorer

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

去调试

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
PageSize	Integer	否	`20`	分页查询时每页的行数，默认值为10。
PageNumber	Integer	否	`1`	列表的页码，取值>0，默认值为1。要查询的列表范围为：实际起始位置 = (PageNumber-1) * PageSize 实际终止位置 = PageNumber * PageSize
Ids	Array of String	否	`["1744977683943******"]`	对象分组ID列表。
Name	String	否	`测试`	对象分组名称的关键字，支持模糊查询。

返回参数

参数	类型	示例值	描述
Data	Array of ObjectGroupVO	`-`	符合条件的对象分组的详细信息。
PageSize	Integer	`30`	分页查询参数，用于设置每页行数。默认值：30。
PageNumber	Integer	`1`	分页查询参数，用于设置当前页码。默认值：1。
TotalCount	Integer	`2`	符合条件的对象分组总数。

ObjectGroupVO

参数	类型	示例值	描述
Id	String	`1744977683943******`	对象分组ID。
Name	String	`testgroup`	对象分组名称。
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。
AlertTemplateName	String	`测试模板`	对象分组关联的告警模板名称。

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配置。

Dimensions

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

BindRules

参数	类型	示例值	描述
Id	String	`*******`	关联的告警策略ID。
Name	String	`rule1`	关联的告警策略的名称。

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 - 标签列表。

参数	类型	示例值	描述
Tags	Array of KVComparator	`-`	标签列表。
Condition	String	`and`	判断条件。 and：全部满足 or：任意满足

Condition

String

and

判断条件。

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

MetaCondition

参数类型示例值描述

Metas Array of MetaKVComparator - 资源列表。

参数	类型	示例值	描述
Metas	Array of MetaKVComparator	`-`	资源列表。
Condition	String	`or`	判断条件。 and：全部满足 or：任意满足
AllDimensions	Boolean	`true`	是否为全量资源。 true：全量资源 false：不是全量资源

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"] 标签的key对应的value。

参数	类型	示例值	描述
Key	String	`testKey`	标签的key。
Values	Array of String	`["testValues", "testValues2"]`	标签的key对应的value。
Comparator	String	`equal`	比较符。 contain：包含 not_contain：不包含 prefix_match：前缀匹配 suffix_match：后缀匹配 equal：等于 not_equal：不等于 exist：存在

Comparator

String

equal

比较符。

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

MetaKVComparator

参数类型示例值描述

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

Values Array of String ["testResource1", "testResource2"] 资源的Values。

参数	类型	示例值	描述
Key	String	`ResourceName`	资源的Key。目前只能配置为ResourceName。
Values	Array of String	`["testResource1", "testResource2"]`	资源的Values。
Comparator	String	`equal`	比较符。 contain：包含 not_contain：不包含 prefix_match：前缀匹配 suffix_match：后缀匹配 equal：等于 not_equal：不等于

Comparator

String

equal

比较符。

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

请求示例

POST https://open.volcengineapi.com?Action=ListObjectGroups&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "PageSize": 10,
    "PageNumber": 1,
    "Ids": [
        "1744977683943******"
    ],
    "Name": "测试"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240305103452FC6A6F66C17C7D******",
        "Action": "ListObjectGroups",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": ""
    },
    "Result": {
        "Data": [
            {
                "Id": "1744977683943******",
                "Name": "测试",
                "CreatedAt": "2024-01-10T15:01:15+08:00",
                "UpdatedAt": "2024-03-01T16:52:18+08:00",
                "Objects": [
                    {
                        "Id": "1763465351913******",
                        "Namespace": "VCM_ECS",
                        "ResourceType": "云服务器",
                        "Region": "cn-beijing",
                        "Dimensions": {
                            "ResourceID": [
                                "i-ycsa9lvgu8cva4******",
                                "i-ycr7e0gmwwcva4******"
                            ]
                        },
                        "Type": "enum"
                    }
                ],
                "AlertTemplateId": "",
                "AlertTemplateName": ""
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "OrderBy": "",
        "Asc": false
    }
}

错误码

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

云监控

请求说明

Header

调试

请求参数

Query

Body

返回参数

ObjectGroupVO

Object

Dimensions

BindRules

DimensionConditions

TagCondition

MetaCondition

ProjectCondition

KVComparator

MetaKVComparator

请求示例

返回示例

错误码