Skip to content

AggTaskGroupProps

Properties for defining a AggTaskGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-cms2-aggtaskgroup

Initializer

using AlibabaCloud.SDK.ROS.CDK.Cms2;
new AggTaskGroupProps {
    object AggTaskGroupConfig,
    object AggTaskGroupName,
    object InstanceId,
    object TargetPrometheusId,
    object AggTaskGroupConfigType = null,
    object CronExpr = null,
    object Delay = null,
    object Description = null,
    object FromTime = null,
    object MaxRetries = null,
    object MaxRunTimeInSeconds = null,
    object OverrideIfExists = null,
    object PrecheckString = null,
    object ScheduleMode = null,
    object ScheduleTimeExpr = null,
    object Status = null,
    TagsProperty[] Tags = null,
    object ToTime = null
};

Properties

Name Type Description
AggTaskGroupConfig object Property aggTaskGroupConfig: The config of the agg task group.
AggTaskGroupName object Property aggTaskGroupName: The name of the agg task group.
InstanceId object Property instanceId: The ID of the source Prometheus instance the agg task group reads data from.
TargetPrometheusId object Property targetPrometheusId: The ID of the target Prometheus instance of the agg task group.
AggTaskGroupConfigType object Property aggTaskGroupConfigType: The config type of the agg task group.
CronExpr object Property cronExpr: The cron expression used when ScheduleMode is "Cron".
Delay object Property delay: The fixed delay of the schedule, in seconds.
Description object Property description: The description of the agg task group.
FromTime object Property fromTime: The second-level timestamp corresponding to the schedule start time.
MaxRetries object Property maxRetries: The maximum number of retries for executing the agg task.
MaxRunTimeInSeconds object Property maxRunTimeInSeconds: The maximum retry time for executing the agg task, in seconds.
OverrideIfExists object Property overrideIfExists: Whether to override and update an existing agg task group with the same name when creating.
PrecheckString object Property precheckString: The precheck config.
ScheduleMode object Property scheduleMode: The schedule mode, "Cron" or "FixedRate".
ScheduleTimeExpr object Property scheduleTimeExpr: The schedule time expression, "@s" or "@m" is recommended, indicating the rounding granularity of the schedule time window.
Status object Property status: The status of the agg task group, "Running" or "Stopped".
Tags TagsProperty[] Property tags: The tags of the agg task group.
ToTime object Property toTime: The second-level timestamp corresponding to the schedule end time.

AggTaskGroupConfigRequired

public object AggTaskGroupConfig { get; set; }
  • Type: object

Property aggTaskGroupConfig: The config of the agg task group.

Only "RecordingRuleYaml" format is supported, which must conform to the RecordingRule format of the open source Prometheus.


AggTaskGroupNameRequired

public object AggTaskGroupName { get; set; }
  • Type: object

Property aggTaskGroupName: The name of the agg task group.


InstanceIdRequired

public object InstanceId { get; set; }
  • Type: object

Property instanceId: The ID of the source Prometheus instance the agg task group reads data from.


TargetPrometheusIdRequired

public object TargetPrometheusId { get; set; }
  • Type: object

Property targetPrometheusId: The ID of the target Prometheus instance of the agg task group.


AggTaskGroupConfigTypeOptional

public object AggTaskGroupConfigType { get; set; }
  • Type: object

Property aggTaskGroupConfigType: The config type of the agg task group.

Default: "RecordingRuleYaml".


CronExprOptional

public object CronExpr { get; set; }
  • Type: object

Property cronExpr: The cron expression used when ScheduleMode is "Cron".

For example, "0/1 * * * *" means scheduling every 1 minute starting from minute 0.


DelayOptional

public object Delay { get; set; }
  • Type: object

Property delay: The fixed delay of the schedule, in seconds.

Default: 30.


DescriptionOptional

public object Description { get; set; }
  • Type: object

Property description: The description of the agg task group.


FromTimeOptional

public object FromTime { get; set; }
  • Type: object

Property fromTime: The second-level timestamp corresponding to the schedule start time.


MaxRetriesOptional

public object MaxRetries { get; set; }
  • Type: object

Property maxRetries: The maximum number of retries for executing the agg task.

Default: 20.


MaxRunTimeInSecondsOptional

public object MaxRunTimeInSeconds { get; set; }
  • Type: object

Property maxRunTimeInSeconds: The maximum retry time for executing the agg task, in seconds.

Default: 600.


OverrideIfExistsOptional

public object OverrideIfExists { get; set; }
  • Type: object

Property overrideIfExists: Whether to override and update an existing agg task group with the same name when creating.

Create-only, cannot be updated.


PrecheckStringOptional

public object PrecheckString { get; set; }
  • Type: object

Property precheckString: The precheck config.

Not configured by default.


ScheduleModeOptional

public object ScheduleMode { get; set; }
  • Type: object

Property scheduleMode: The schedule mode, "Cron" or "FixedRate".

Default: "FixedRate".


ScheduleTimeExprOptional

public object ScheduleTimeExpr { get; set; }
  • Type: object

Property scheduleTimeExpr: The schedule time expression, "@s" or "@m" is recommended, indicating the rounding granularity of the schedule time window.

Default: "@m".


StatusOptional

public object Status { get; set; }
  • Type: object

Property status: The status of the agg task group, "Running" or "Stopped".

Default: Running.


TagsOptional

public TagsProperty[] Tags { get; set; }

Property tags: The tags of the agg task group.


ToTimeOptional

public object ToTime { get; set; }
  • Type: object

Property toTime: The second-level timestamp corresponding to the schedule end time.

0 means the schedule never stops.