You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /
  • 云监控

ListObjectGroups

最近更新时间：2024.04.09 15:14:24

首次发布时间：2024.03.18 17:01:10

我的收藏

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

Request

POST https://open.volcengineapi.com?Action=ListObjectGroups&Version=2018-01-01


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

请求参数

参数

类型

是否必填

示例值

描述

PageSize

Integer

否

20

分页查询时每页的行数，默认值为10。

PageNumber

Integer

否

1

列表的页码，取值>0，默认值为1。要查询的列表范围为：
实际起始位置 = (PageNumber-1) * PageSize
实际终止位置 = PageNumber * PageSize

Ids

Array

否

["1744977683943******"]

对象分组ID列表。

Name

String

否

测试

对象分组名称的关键字，支持模糊查询。

返回数据

参数

类型

示例值

描述

Data

Array

-

符合条件的对象分组的详细信息。具体请参见Data数据结构。

PageNumber

Integer

1

当前页码。

PageSize

Integer

10

当前分页的行数。

TotalCount

Integer

4

符合条件的对象分组总数。

Data数据结构

参数

类型

示例值

描述

Id

String

1744977683943******

对象分组ID。

Name

String

testgroup

对象分组名称。

Objects

Array

-

对象分组下的云产品资源列表。具体请参见Object数据结构。

CreateAt

String

2021-10-25T18:27:24+08:00

对象分组的创建时间。

UpdateAt

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

Map

-

云产品资源ID集合。具体请参见Dimensions数据结构。

Region

String

cn-beijing

当前Object下云产品所属可用区。

Type

String

enum

资源合集类型，当前只支持enum。

Dimensions数据结构

参数

类型

示例值

描述

Key

String

ResourceID

云产品资源的Dimensions名称。例如：ResourceID、NodeName等。

Value

Array

["i-ycsa9lvgu8cva4******","i-ycr7e0gmwwcva4******"]

云产品资源的Dimension的值列表。

请求示例

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
    }
}