调用GetAggTaskGroup查询聚合任务组-云监控-阿里云

查询聚合任务组详情。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:GetAggTaskGroup

get

*AggTaskGroup

acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}

无

请求语法

GET /prometheus-instances/{instanceId}/agg-task-groups/{groupId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
instanceId	string	是	聚合任务组所属的 Prometheus 实例 ID。	rw-xxx
groupId	string	是	聚合任务组 ID。	aggTaskGroup-xxx

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object	出参结构体。
aggTaskGroup	object	聚合任务组。
aggTaskGroupConfig	string	聚合任务组配置。	groups: - name: "node.rules" interval: "60s" rules: - record: "node_namespace_pod:kube_pod_info:" expr: "max(label_replace(kube_pod_info{job=\"kubernetes-pods-kube-state-metrics\"\ }, \"pod\", \"$1\", \"pod\", \"(.*)\")) by (node, namespace, pod, cluster)"
aggTaskGroupConfigHash	string	聚合任务组配置的摘要。	a54136xxx
aggTaskGroupId	string	聚合任务组 ID。	aggTaskGroup-xx
aggTaskGroupName	string	聚合任务组名称。	pipeline-aggtask-group
cronExpr	string	调度模式选择“Cron”情况下，聚合任务组的调度表达式。	0 1 3 * * ? *
delay	integer	调度的固定延迟时间（秒）。	2
description	string	聚合任务组描述。	test
fromTime	integer	调度开始时间对应的的秒级时间戳（暂未生效）。	1757409495
maxRetries	integer	执行聚合任务的最大重试次数。	2
maxRunTimeInSeconds	integer	执行聚合任务的最大重试时间。	50
precheckString	string	预检测配置。	{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}
regionId	string	地域 ID。	cn-zhangjiakou
scheduleMode	string	调度模式。	FixedRate
scheduleTimeExpr	string	调度时间表达式。	@m
sourcePrometheusId	string	聚合任务组的源 Prometheus 实例 ID。	rw-xxx
status	string	聚合任务组状态。	Running
tags	array<object>	资源组标签。
	object	标签。
key	string	资源组标签的键。	key1
value	string	资源组标签的值。	value1
targetPrometheusId	string	聚合任务组的目标 Prometheus 实例 ID。	rw-xxx
toTime	integer	调度结束时间对应的秒级时间戳。	1757409495
updateTime	string	聚合任务组的更新时间（时间戳）。	1757409499000
userId	string	聚合任务组所属用户。	123xxx
requestId	string	请求 id	68DAF543-35DF-5762-BE90-F5C00B5DC036
success	boolean	请求是否成功	True

示例

正常返回示例

JSON格式

{
  "aggTaskGroup": {
    "aggTaskGroupConfig": "groups:\n- name: \"node.rules\"\n  interval: \"60s\"\n  rules:\n  - record: \"node_namespace_pod:kube_pod_info:\"\n    expr: \"max(label_replace(kube_pod_info{job=\\\"kubernetes-pods-kube-state-metrics\\\"\\\n      }, \\\"pod\\\", \\\"$1\\\", \\\"pod\\\", \\\"(.*)\\\")) by (node, namespace, pod, cluster)\"",
    "aggTaskGroupConfigHash": "a54136xxx",
    "aggTaskGroupId": "aggTaskGroup-xx",
    "aggTaskGroupName": "pipeline-aggtask-group",
    "cronExpr": "0 1 3 * * ? *",
    "delay": 2,
    "description": "test",
    "fromTime": 1757409495,
    "maxRetries": 2,
    "maxRunTimeInSeconds": 50,
    "precheckString": "{\"policy\":\"skip\",\"prometheusId\":\"rw-xx\",\"query\":\"noPrecheck\",\"threshold\":0.5,\"timeout\":15,\"type\":\"none\"}",
    "regionId": "cn-zhangjiakou",
    "scheduleMode": "FixedRate",
    "scheduleTimeExpr": "@m",
    "sourcePrometheusId": "rw-xxx",
    "status": "Running",
    "tags": [
      {
        "key": "key1",
        "value": "value1"
      }
    ],
    "targetPrometheusId": "rw-xxx",
    "toTime": 1757409495,
    "updateTime": "1757409499000",
    "userId": "123xxx"
  },
  "requestId": "68DAF543-35DF-5762-BE90-F5C00B5DC036",
  "success": true
}

错误码

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

变更历史

更多信息，参考变更详情。