查询应用分组列表。

调试

前往【API Explorer】在线调试,API Explorer 提供在线调用 API、动态生成 SDK Example 代码和快速检索接口等能力,能显著降低使用云 API 的难度,强烈推荐使用。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMonitorGroups

系统规定参数。取值:DescribeMonitorGroups。

SelectContactGroups Boolean true

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

PageNumber Integer 1

分页页码, 默认1 。

PageSize Integer 10

分页大小,默认10。

Keyword String test

应用分组名称。可根据应用分组名称模糊查询。

InstanceId String xxx-1

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

GroupName String 我的组

应用分组名称。

返回参数

名称 类型 示例值 描述
Code Integer 200

状态码,200表示成功。

Message String success

状态描述信息,Code为”200”时,Message一般为空。

PageNumber Integer 1

页码。

PageSize Integer 10

每页记录条数。

RequestId String 3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42

请求ID,用于排查问题。

Resources

关联资源。

  └BindUrl String http://xxx

从k8s同步过来的URL地址。

  └ContactGroups

报警联系组。

    └Name String 默认报警联系组

报警联系组名。

  └GmtCreate Long 1510286840000

创建时间, 范围为一个整形,距离1970年1月1日 0点的毫秒数。

  └GmtModified Long 1540370711000

修改时间, 范围为一个整形,距离1970年1月1日 0点的毫秒数。

  └GroupId Long 12345

组ID。

  └GroupName String 应用分组1

应用组的名称。

  └ServiceId String service-1

服务ID。

  └Type String custom

组的类型, 共有三种:

  • custom:为用户自己创建的,
  • ehpc_cluster:为从ehpc集群同步的,
  • kubernetes:为从k8s同步的。
Success Boolean true

是否成功。

Total Integer 10

总记录条数。

示例

请求示例


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

正常返回示例

XML 格式

<DescribeMonitorGroupListResponse>
  <PageNumber>1</PageNumber>
  <PageSize>30</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>xxx</Name>
        </ContactGroup>
      </ContactGroups>
      <ServiceId>49922</ServiceId>
      <GmtCreate>1489043796000</GmtCreate>
      <GmtModified>1525183537000</GmtModified>
      <GroupId>13263</GroupId>
    </Resource>
  </Resources>
</DescribeMonitorGroupListResponse>

JSON 格式

{
	"PageNumber":1,
	"PageSize":30,
	"RequestId":"31BC7201-00F2-47B2-B7B9-6A173076ACE8",
	"Success":true,
	"Code":200,
	"Total":1,
	"Resources":{
		"Resource":[
			{
				"GroupName":"demo",
				"Type":"custom",
				"ServiceId":49922,
				"ContactGroups":{
					"ContactGroup":[
						{
							"Name":"xxx"
						}
					]
				},
				"GmtCreate":1489043796000,
				"GroupId":13263,
				"GmtModified":1525183537000
			}
		]
	}
}

错误码

查看本产品错误码