应用聚合任务组。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| cms:UpdateAggTaskGroup | update | *AggTaskGroup acs:cms:{#regionId}:{#accountId}:prometheusinstance/{#sourcePrometheusId}/aggtaskgroup/{#aggTaskGroupId} |
| 无 |
请求语法
PUT /prometheus-instances/{instanceId}/agg-task-groups/{groupId} HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| instanceId | string | 是 | 聚合任务组所属的 Prometheus 实例 ID，聚合任务从这个实例中读取数据。 | rw-pq4apob9jm |
| groupId | string | 是 | 聚合任务组 ID。 | aggTaskGroup-xxxx |
| body | object | 否 | 入参结构体。 | |
| aggTaskGroupConfig | string | 是 | 聚合任务组配置。目前仅支持 “RecordingRuleYaml” 格式，要求符合开源 Prometheus 的 RecordingRule 的格式要求。 | 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)" |
| aggTaskGroupConfigType | string | 否 | 聚合任务组配置类型，默认 “RecordingRuleYaml”（开源 Prometheus 的 RecordingRule 格式）。 | RecordingRuleYaml |
| aggTaskGroupName | string | 否 | 聚合任务组名称。 | test-group |
| cronExpr | string | 否 | 调度模式选择“Cron”情况下，具体的调度表达式。例如“0/1 * * * *”，表示从 0 分开始，每隔 1 分钟调度一次。 | 0/1 * * * * |
| delay | integer | 否 | 调度的固定延迟时间，单位：秒，默认 30。 | 30 |
| description | string | 否 | 聚合任务组描述。 | desc |
| fromTime | long | 否 | 调度开始时间对应的的秒级时间戳。 | 1724996015 |
| maxRetries | integer | 否 | 执行聚合任务的最大重试次数，默认 20。 | 20 |
| maxRunTimeInSeconds | integer | 否 | 执行聚合任务的最大重试时间，单位：秒，默认 600。 | 600 |
| precheckString | string | 否 | 预检测配置，默认不配置。输入的字符串需要能被正确 JSON 解析。 | {"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\"_arms/kubelet/cadvisor\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"} |
| scheduleMode | string | 否 | 调度模式，“Cron” 或 “FixedRate”，默认 “FixedRate”。 | FixedRate |
| scheduleTimeExpr | string | 否 | 调度时间表达式，推荐 “@s” 或者 “@m”，表示调度时间窗口对齐的粒度，默认 “@m”。 | @m |
| status | string | 否 | 聚合任务组状态，“Running” 或者 “Stopped”。默认 Running。 | Running |
| tags | array<object> | 否 | 资源组标签。 | |
| object | 否 | 标签。 | ||
| key | string | 否 | 资源组标签的键。 | |
| value | string | 否 | 资源组标签的值。 | |
| targetPrometheusId | string | 是 | 聚合任务组的目标 Prometheus 实例 ID。 | rw-pq4apob9jm |
| toTime | long | 否 | 调度结束时间对应的秒级时间戳，0 表示不停止调度。 | 0 |
返回参数
示例
正常返回示例
JSON格式
{
"aggTaskGroupConfigHash": "a54136014dc386a92c83a6ef1e97ff22",
"aggTaskGroupId": "aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8",
"aggTaskGroupName": "pipeline-aggtask-group",
"requestId": "8FDE2569-626B-5176-9844-28877A*****",
"sourcePrometheusId": "rw-083e17834e279f8c627fe91a2d72",
"status": "Running"
}错误码
访问错误中心查看更多错误码。