You need to enable JavaScript to run this app.
导航
ListObjectGroups
最近更新时间:2024.06.26 12:08:54首次发布时间:2024.03.18 17:01:10

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

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=ListObjectGroups&Version=2018-01-01
ServiceName : Volc_Observe 
Region : cn-beijing 
AccessKey : xxx 
SecretKey : xxx

调试

请求参数

Query

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

Body

参数类型是否必选示例值描述
PageSizeInteger20分页查询时每页的行数,默认值为10。

PageNumber

Integer

1

列表的页码,取值>0,默认值为1。要查询的列表范围为:

  • 实际起始位置 = (PageNumber-1) * PageSize
  • 实际终止位置 = PageNumber * PageSize
IdsArray of String["1744977683943******"]对象分组ID列表。
NameString测试对象分组名称的关键字,支持模糊查询。

返回参数

参数类型示例值描述
DataArray of ObjectGroupVO-符合条件的对象分组的详细信息。
PageSizeInteger10当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger2符合条件的对象分组总数。

ObjectGroupVO

参数类型示例值描述
IdString1744977683943******对象分组ID。
NameStringtestgroup对象分组名称。
ObjectsArray of Object-对象分组下的云产品资源列表。
CreatedAtString2021-10-25T18:27:24+08:00对象分组的创建时间。
UpdatedAtString2021-10-25T18:49:43+08:00对象分组的更新时间。
AlertTemplateIdString1744971093943******对象分组关联的告警模板ID。
AlertTemplateNameString测试模板对象分组关联的告警模板名称。

Object

参数类型示例值描述
IdString1763465351913******对象分组ID。
NamespaceStringVCM_ECS云产品在云监控中所属的产品空间。具体请参见云产品监控指标下各产品的Namespace。
DimensionsJSON Map-云产品资源ID集合。
RegionStringcn-beijing当前Object下云产品所属可用区。
TypeStringenum资源合集类型,当前只支持enum。

Dimensions

参数类型示例值描述
keyStringResourceID检索指标的KEY。
valueArray of Stringi-ycsa9lvgu8cva4******KEY对应的值。

请求示例

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

错误码

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