GetAggTaskGroup - 查询聚合任务组

查询聚合任务组详情。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:GetAggTaskGroupget
*AggTaskGroup
acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId}

请求语法

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

请求参数

名称类型必填描述示例值
instanceIdstring

聚合任务组所属的 Prometheus 实例 ID。

rw-xxx
groupIdstring

聚合任务组 ID。

aggTaskGroup-xxx

返回参数

名称类型描述示例值
object

出参结构体。

aggTaskGroupobject

聚合任务组。

aggTaskGroupConfigstring

聚合任务组配置。

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)"
aggTaskGroupConfigHashstring

聚合任务组配置的摘要。

a54136xxx
aggTaskGroupIdstring

聚合任务组 ID。

aggTaskGroup-xx
aggTaskGroupNamestring

聚合任务组名称。

pipeline-aggtask-group
cronExprstring

调度模式选择“Cron”情况下,聚合任务组的调度表达式。

0 1 3 * * ? *
delayinteger

调度的固定延迟时间(秒)。

2
descriptionstring

聚合任务组描述。

test
fromTimelong

调度开始时间对应的的秒级时间戳(暂未生效)。

1757409495
maxRetriesinteger

执行聚合任务的最大重试次数。

2
maxRunTimeInSecondsinteger

执行聚合任务的最大重试时间。

50
precheckStringstring

预检测配置。

{"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}
regionIdstring

地域 ID。

cn-zhangjiakou
scheduleModestring

调度模式。

FixedRate
scheduleTimeExprstring

调度时间表达式。

@m
sourcePrometheusIdstring

聚合任务组的源 Prometheus 实例 ID。

rw-xxx
statusstring

聚合任务组状态。

Running
tagsarray<object>

资源组标签

tagsobject

标签。

keystring

资源组标签的键。

key1
valuestring

资源组标签的值。

value1
targetPrometheusIdstring

聚合任务组的目标 Prometheus 实例 ID。

rw-xxx
toTimelong

调度结束时间对应的秒级时间戳。

1757409495
updateTimestring

聚合任务组的更新时间(时间戳)。

1757409499000
userIdstring

聚合任务组所属用户。

123xxx
requestIdstring

请求 id

68DAF543-35DF-5762-BE90-F5C00B5DC036
successboolean

请求是否成功

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
}

错误码

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