CreateAlertRule

On success, this API returns the following response structure.

• uuid

  String

  Unique identifier of the alert rule

  Example: rule-abc123-def456

• name

  String

  Human-readable name of the alert rule

  Example: High CPU Usage

• description

  String

  Detailed description of what this rule monitors

  Example: Triggers when CPU usage exceeds 90% for 5 minutes

• resourceType

  String

  Type of resource being monitored (e.g. vm, host, volume)

  Example: vm

• metricName

  String

  Name of the metric to evaluate

  Example: cpu_usage_percent

• operator

  String

  Comparison operator for threshold evaluation

  Example: >

• threshold

  Long

  Threshold value that triggers the alert

  Example: 90

• duration

  Integer

  Duration in seconds the condition must hold before firing

  Example: 300

• severity

  String

  Alert severity level (critical, warning, info)

  Example: critical

• state

  String

  Current state of the rule (enabled, disabled, firing)

  Example: enabled

• notifyUrl

  String

  Webhook URL for delivery notifications

  Example: https://example.com/callback

• platformUuid

  String

  UUID of the platform this rule belongs to

  Example: plat-001-abc

• type

  String

  Stored rule type. New rules use metric; log_keyword is retained for historical read compatibility

  Example: metric

• logQuery

  String

  Deprecated historical log-keyword query retained for read compatibility

  Example: level=error AND service=payment

• logWindow

  Integer

  Deprecated historical log-keyword evaluation window retained for read compatibility

  Example: 600

• category

  String

  Category grouping for the rule (e.g. infrastructure, application)

  Example: infrastructure

• labelSelectors

  List

  Scope selectors with In/NotIn operators and one or more values per key.

  Example: (nested array)

  Show child properties
  • key

    String

    Metric label key used to narrow the rule scope.

    Example: value

  • operator

    String

    Match operator. Supported values are In and NotIn.

    Example: value

  • values

    List

    One or more label values matched by the operator.

    Example: item1,item2

• source

  String

  Source of the rule (builtin or custom)

  Example: builtin

• impactScope

  String

  Scope of impact when this alert fires

  Example: cluster

• createDate

  String

  Timestamp when the rule was created

  Example: 2026-01-15T08:00:00Z

• lastOpDate

  String

  Timestamp of the last modification to this rule

  Example: 2026-01-15T08:00:00Z

• adapterType

  String

  Adapter type for the monitoring backend

  Example: prometheus

• userModified

  Boolean

  Whether the user has manually modified this rule

  Example: false

• deprecated

  Boolean

  Whether this rule is deprecated and should not be used

  Example: false

• createdBy

  String

  Account ID of the user who created this rule

  Example: admin

• lastModifiedBy

  String

  Account ID of the user who last modified this rule

  Example: admin

• actions

  List

  Actions attached to this rule (FIX-02: RI-AA-V02)

  Example: (nested array)

  Show child properties
  • uuid

    String

    Unique identifier of the action

    Example: action-001

  • ruleUuid

    String

    UUID of the parent alert rule

    Example: rule-abc123-def456

  • type

    String

    Action type: command_snippet, link, or text_suggestion

    Example: command_snippet

  • label

    String

    Display label for the action button

    Example: Restart Service

  • content

    String

    Action content (command, URL, or suggestion text)

    Example: systemctl restart nginx

  • orderIndex

    Integer

    Display order index for multiple actions

    Example: 1

  • createDate

    String

    Timestamp when the action was created

    Example: 2026-01-15T08:00:00Z

• productType

  String

  Product type for this resource

  Example: value

• resourceSubType

  String

  Resource sub type for this resource

  Example: value

• sourceSystem

  String

  Source system for this resource

  Example: value

• sourceAlarmUuid

  String

  Source alarm uuid for this resource

  Example: value

• sourceAlarmName

  String

  Source alarm name for this resource

  Example: value

• sourceNamespace

  String

  Source namespace for this resource

  Example: value

• sourceMetricName

  String

  Source metric name for this resource

  Example: value

• sourceLabels

  String

  Source labels for this resource

  Example: value

• filterRules

  String

  Filter rules for this resource

  Example: value

• conditionType

  String

  Condition type for this resource

  Example: value

• thresholdUnit

  String

  Threshold unit for this resource

  Example: value

• rawPeriod

  Integer

  Raw period for this resource

  Example: 10

• rawEmergencyLevel

  String

  Raw emergency level for this resource

  Example: value

• ruleStatus

  String

  Rule status for this resource

  Example: value

• prometheusMetricStatus

  String

  Prometheus metric status for this resource

  Example: value

• defaultConfigSnapshot

  String

  Default config snapshot for this resource

  Example: value

• sourceRawPayload

  String

  Source raw payload for this resource

  Example: value

• ruleId

  String

  Rule id for this resource

  Example: value

• resourceTypeDisplayName

  String

  Localized display label for resourceType; resourceType remains the stable code

  Example: 组件实例

• metricDisplayName

  String

  Localized display label for metricName; metricName remains the stable code

  Example: 组件重启频率

• scopeFiltersDisplay

  List

  Read-only configured scope display for rule detail; field names and system enums follow Accept-Language, resource names remain original

  Example: (nested array)

  Show child properties
  • key

    String

    Original configured scope filter key, such as platform_uuid, preserved unchanged alongside its localized display name.

    Example: value

  • displayName

    String

    Display name for this resource

    Example: value

  • operator

    String

    Operator for this resource

    Example: value

  • values

    List

    Values for this resource

    Example: (nested array)

    Show child properties
    • value

      String

      Value for this resource

      Example: value

    • label

      String

      Label for this resource

      Example: value