调用DescribeMonitorGroups接口查询应用分组列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
GroupName String demo

应用分组的名称。

说明 您可以根据应用分组名称进行精确查询。
Keyword String test

要搜索的关键字。

说明 您可以根据应用分组名称进行模糊查询或精确查询。
PageSize Integer 10

分页大小,默认为10。

PageNumber Integer 1

分页页码, 默认为1。

InstanceId String xxx-1

资源实例ID。查询指定实例所在的应用分组。

SelectContactGroups Boolean true

返回结果中是否需要包含报警联系人组。

  • true:包含
  • false:不包含
IncludeTemplateHistory Boolean true

查询的结果里是否包含了应用报警模板的历史。

  • true:包含
  • false:不包含
Tag.N.Key String testKey1

标签键。

N的取值范围为1~5。

Tag.N.Value String testValue1

标签值。

N的取值范围为1~5。

Type String custom

应用分组的类型。

  • custom:自建组。
  • ehpc_cluster:EHPC集群同步的组。
  • kubernetes:Kubernetes同步的组。
DynamicTagRuleId String 055995c1-4625-4dc0-8338-******376950

智能标签规则ID。

GroupId String 123456

应用组ID。

返回数据

名称 类型 示例值 描述
RequestId String 31BC7201-00F2-47B2-B7B9-6A173076ACE8

请求ID。

Success Boolean true

请求是否成功。

Code Integer 200

状态码。

Message String success

错误信息。

说明 如果状态码是200,通常表示没有错误信息。
PageNumber Integer 1

应用分组列表的页码。

PageSize Integer 10

分页查询时设置的每页行数。

Total Integer 10

总记录条数。

Resources Array

关联资源。

GroupId Long 12345

应用分组的ID。

GroupName String demo

应用分组的名称。

ServiceId String 49922

服务ID。

Type String custom

应用分组的类型。

  • custom:自建组。
  • ehpc_cluster:EHPC集群同步的组。
  • kubernetes:Kubernetes同步的组。
GmtModified Long 1525183537000

修改时间。

格式为Unix时间戳,即从1970年1月1日开始所经过的秒数。

GmtCreate Long 1489043796000

创建时间。

格式为Unix时间戳,即从1970年1月1日开始所经过的秒数。

BindUrl String http://xxx

从Kubernetes同步过来的URL地址。

DynamicTagRuleId String 055995c1-4625-4dc0-8338-******376950

智能标签规则ID。

GroupFounderTagKey String portalGroup

创建者的标签键。

说明 如果应用分组是智能标签同步创建的,该参数表示应用分组是从哪个标签键同步创建的。
GroupFounderTagValue String portalJP

创建者的标签值。

说明 如果应用分组是智能标签同步创建的,该参数表示应用分组是从哪个标签值同步创建的。
ContactGroups Array

报警联系组。

Name String 默认报警联系组

报警联系组名。

Tags Array

该应用分组被绑定过的标签列表。

Key String tagKey1

标签键。

Value String tagValue1

标签值。

TemplateIds List 123

该应用分组应用过的报警模板。

说明 如果IncludeTemplateHistory参数设置为true,则返回结果会包含这个字段。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeMonitorGroups
&<公共请求参数>

正常返回示例

XML 格式

<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<RequestId>31BC7201-00F2-47B2-B7B9-6A173076ACE8</RequestId>
<Success>true</Success>
<Code>200</Code>
<Total>1</Total>
<Resources>
    <Resource>
        <GroupName>demo</GroupName>
        <Type>custom</Type>
        <ContactGroups>
            <ContactGroup>
                <Name>默认报警联系组</Name>
            </ContactGroup>
        </ContactGroups>
        <ServiceId>49922</ServiceId>
        <GmtCreate>1489043796000</GmtCreate>
        <GmtModified>1525183537000</GmtModified>
        <GroupId>12345</GroupId>
        <Tags>
            <Tag>
                <Value>tagValue1</Value>
                <Key>tagKey1</Key>
            </Tag>
        </Tags>
        <TemplateIds>
        </TemplateIds>
    </Resource>
</Resources>

JSON 格式

{
    "PageNumber": 1,
    "PageSize": 10,
    "RequestId": "31BC7201-00F2-47B2-B7B9-6A173076ACE8",
    "Success": true,
    "Code": 200,
    "Total": 1,
    "Resources": {
        "Resource": [
            {
                "GroupName": "demo",
                "Type": "custom",
                "ContactGroups": {
                    "ContactGroup": [
                        {
                            "Name": "默认报警联系组"
                        }
                    ]
                },
                "ServiceId": 49922,
                "GmtCreate": 1489043796000,
                "GmtModified": 1525183537000,
                "GroupId": 12345,
                "Tags": {
					"Tag": [
						{
							"Value": "tagValue1",
							"Key": "tagKey1"
						}
					]
				},
                "TemplateIds": {
					"TemplateId": []
				}
            }
        ]
    }
}

错误码

访问错误中心查看更多错误码。