@alicloud/cms20240330 6.0.1 → 6.2.0

package/src/models/AlertRuleAlertMetricParamDef.ts

@@ -4,7 +4,15 @@ import * as $dara from '@darabonba/typescript';
 
 export class AlertRuleAlertMetricParamDefValues extends $dara.Model {
   labelCn?: string;
+  /**
+   * @example
+   * Staging
+   */
   labelEn?: string;
+  /**
+   * @example
+   * staging
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -32,12 +40,36 @@ export class AlertRuleAlertMetricParamDefValues extends $dara.Model {
 }
 
 export class AlertRuleAlertMetricParamDef extends $dara.Model {
+  /**
+   * @example
+   * 200
+   */
   maxWidth?: number;
+  /**
+   * @example
+   * 100
+   */
   minWidth?: number;
+  /**
+   * @example
+   * env
+   */
   name?: string;
   placeholderCn?: string;
+  /**
+   * @example
+   * Enter value
+   */
   placeholderEn?: string;
+  /**
+   * @example
+   * TEXT_PARAM
+   */
   type?: string;
+  /**
+   * @example
+   * staging
+   */
   value?: string;
   values?: AlertRuleAlertMetricParamDefValues[];
   static names(): { [key: string]: string } {

package/src/models/AlertRuleCondition.ts

@@ -3,9 +3,44 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AlertRuleConditionCaseList extends $dara.Model {
+  /**
+   * @remarks
+   * Matching expression, example: logLevel: error.
+   * 
+   * @example
+   * logLevel: error
+   */
   condition?: string;
+  /**
+   * @remarks
+   * Count matching expression, examples: range combination: count >= 3 && count <= 10; single range: count >= 3.
+   * 
+   * @example
+   * count >= 3
+   */
   countCondition?: string;
+  /**
+   * @remarks
+   * Alert severity level after condition is met.
+   * 
+   * @example
+   * INFO
+   */
   level?: string;
+  /**
+   * @remarks
+   * Matching type: Has data / Has a specific number of data entries / Has matching data / Has a specific number of matching entries.
+   * 
+   * Valid values:
+   * 
+   * - HasData: Has data.
+   * - HasDataCount: Has a specific number of data entries.
+   * - HasDataMatch: Has matching data.
+   * - HasDataMatchCount: Has a specific number of matching entries.
+   * 
+   * @example
+   * HasData
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -35,7 +70,21 @@ export class AlertRuleConditionCaseList extends $dara.Model {
 }
 
 export class AlertRuleConditionCompareListValueLevelList extends $dara.Model {
+  /**
+   * @remarks
+   * Severity level corresponding to the threshold.
+   * 
+   * @example
+   * INFO
+   */
   level?: string;
+  /**
+   * @remarks
+   * Comparison threshold.
+   * 
+   * @example
+   * 120
+   */
   value?: number;
   static names(): { [key: string]: string } {
     return {
@@ -61,13 +110,82 @@ export class AlertRuleConditionCompareListValueLevelList extends $dara.Model {
 }
 
 export class AlertRuleConditionCompareList extends $dara.Model {
+  /**
+   * @remarks
+   * Time series post-aggregation functions:
+   * - count
+   * -  sum 
+   * -  avg
+   * -  min
+   * -  max
+   * -  p90
+   * -  p95
+   * -  p99
+   * 
+   * @example
+   * count
+   */
   aggregate?: string;
+  /**
+   * @remarks
+   * Data unit.
+   * 
+   * @example
+   * %
+   */
   baseUnit?: string;
+  /**
+   * @remarks
+   * Display unit.
+   * 
+   * @example
+   * %
+   */
   displayUnit?: string;
+  /**
+   * @remarks
+   * Comparison operations to determine whether it is year-over-year (YoY) or month-over-month (MoM):
+   * - Greater than (GT),
+   * - Greater than or equal to (GTE),
+   * - Less than (LT),
+   * - Less than or equal to (LTE),
+   * - Equal to (EQ),
+   * - Not equal to (NE),
+   * - Year-over-year increase (YOY_UP),
+   * - Year-over-year decrease (YOY_DOWN).
+   * 
+   * @example
+   * GT
+   */
   oper?: string;
+  /**
+   * @remarks
+   * Comparison threshold.
+   * 
+   * @example
+   * 50
+   */
   value?: number;
+  /**
+   * @remarks
+   * List of alert severity levels for different values.
+   */
   valueLevelList?: AlertRuleConditionCompareListValueLevelList[];
+  /**
+   * @remarks
+   * Year-over-year time unit (only applicable when oper=YOY_UP/YOY_DOWN): minute, hour, day, week, month.
+   * 
+   * @example
+   * month
+   */
   yoyTimeUnit?: string;
+  /**
+   * @remarks
+   * Year-over-year time value, used in conjunction with yoyTimeUnit.
+   * 
+   * @example
+   * 1
+   */
   yoyTimeValue?: number;
   static names(): { [key: string]: string } {
     return {
@@ -108,10 +226,62 @@ export class AlertRuleConditionCompareList extends $dara.Model {
 }
 
 export class AlertRuleConditionCompositeEscalationEscalations extends $dara.Model {
+  /**
+   * @remarks
+   * Threshold comparison operator, valid values:
+   * - GreaterThanOrEqualToThreshold: greater than or equal to.
+   * - GreaterThanThreshold: greater than.
+   * - LessThanOrEqualToThreshold: less than or equal to.
+   * - LessThanThreshold: less than.
+   * - NotEqualToThreshold: not equal to.
+   * - EqualToThreshold: equal to.
+   * - GreaterThanYesterday: increased compared to the same time yesterday.
+   * - LessThanYesterday: decreased compared to the same time yesterday.
+   * - GreaterThanLastWeek: increased compared to the same time last week.
+   * - LessThanLastWeek: decreased compared to the same time last week.
+   * - GreaterThanLastPeriod: increased compared to the previous period (MoM).
+   * - LessThanLastPeriod: decreased compared to the previous period (MoM).
+   * 
+   * @example
+   * GreaterThanOrEqualToThreshold
+   */
   comparisonOperator?: string;
+  /**
+   * @remarks
+   * Metric name.
+   * 
+   * @example
+   * cpu_total
+   */
   metricName?: string;
+  /**
+   * @remarks
+   * Metric time window.
+   * 
+   * @example
+   * 60
+   */
   period?: number;
+  /**
+   * @remarks
+   * Statistical method; the value of this parameter is determined by the Statistics column corresponding to the specified cloud product\\"s MetricName. This represents the statistical method for the monitoring metric. Example values:
+   * - $Maximum: maximum value.
+   * - $Minimum: minimum value.
+   * - $Average: average value.
+   * - $Availability: availability (typically used for site monitoring).
+   * Note: "$" is a unified prefix symbol for monitoring metrics.
+   * 
+   * @example
+   * $Maximum
+   */
   statistics?: string;
+  /**
+   * @remarks
+   * Alert threshold.
+   * 
+   * @example
+   * 50
+   */
   threshold?: number;
   static names(): { [key: string]: string } {
     return {
@@ -143,9 +313,34 @@ export class AlertRuleConditionCompositeEscalationEscalations extends $dara.Mode
 }
 
 export class AlertRuleConditionCompositeEscalation extends $dara.Model {
+  /**
+   * @remarks
+   * List of multi-metric composite conditions.
+   */
   escalations?: AlertRuleConditionCompositeEscalationEscalations[];
+  /**
+   * @remarks
+   * Alert severity level triggered when the condition is met (multi-metric composite alerts support only one level).
+   * 
+   * @example
+   * INFO
+   */
   level?: string;
+  /**
+   * @remarks
+   * Relationship between multiple metric conditions; valid values are "and" or "or".
+   * 
+   * @example
+   * and
+   */
   relation?: string;
+  /**
+   * @remarks
+   * Number of times the condition must be met to trigger an alert.
+   * 
+   * @example
+   * 3
+   */
   times?: number;
   static names(): { [key: string]: string } {
     return {
@@ -178,8 +373,33 @@ export class AlertRuleConditionCompositeEscalation extends $dara.Model {
 }
 
 export class AlertRuleConditionExpressEscalation extends $dara.Model {
+  /**
+   * @remarks
+   * Alert severity level triggered when the condition is met (expression-based alerts support only one level): 
+   * 
+   * - CRITICAL 
+   * - WARNING 
+   * - INFO
+   * 
+   * @example
+   * INFO
+   */
   level?: string;
+  /**
+   * @remarks
+   * Alert condition expression.
+   * 
+   * @example
+   * @cpu_total[60].$Average > 60
+   */
   rawExpression?: string;
+  /**
+   * @remarks
+   * Number of times the condition must be met to trigger an alert.
+   * 
+   * @example
+   * 3
+   */
   times?: number;
   static names(): { [key: string]: string } {
     return {
@@ -207,10 +427,61 @@ export class AlertRuleConditionExpressEscalation extends $dara.Model {
 }
 
 export class AlertRuleConditionSimpleEscalationEscalations extends $dara.Model {
+  /**
+   * @remarks
+   * Threshold comparison operator, valid values:
+   * 
+   * - GreaterThanOrEqualToThreshold: greater than or equal to.
+   * - GreaterThanThreshold: greater than.
+   * - LessThanOrEqualToThreshold: less than or equal to.
+   * - LessThanThreshold: less than.
+   * - NotEqualToThreshold: not equal to.
+   * - EqualToThreshold: equal to.
+   * - GreaterThanYesterday: increased compared to the same time yesterday.
+   * - LessThanYesterday: decreased compared to the same time yesterday.
+   * - GreaterThanLastWeek: increased compared to the same time last week.
+   * - LessThanLastWeek: decreased compared to the same time last week.
+   * - GreaterThanLastPeriod: increased compared to the previous period (MoM).
+   * - LessThanLastPeriod: decreased compared to the previous period (MoM).
+   * 
+   * @example
+   * GreaterThanOrEqualToThreshold
+   */
   comparisonOperator?: string;
+  /**
+   * @remarks
+   * Alert severity level triggered when the condition is met (expression-based alerts support only one level): 
+   * - CRITICAL 
+   * - WARNING 
+   * - INFO
+   * 
+   * @example
+   * INFO
+   */
   level?: string;
+  /**
+   * @remarks
+   * Statistical method; the value of this parameter is determined by the Statistics column corresponding to the specified cloud product\\"s MetricName, for example: Maximum, Minimum, and Average.
+   * 
+   * @example
+   * Average
+   */
   statistics?: string;
+  /**
+   * @remarks
+   * Alert threshold.
+   * 
+   * @example
+   * 100
+   */
   threshold?: number;
+  /**
+   * @remarks
+   * Number of times the condition must be met to trigger an alert.
+   * 
+   * @example
+   * 3
+   */
   times?: number;
   static names(): { [key: string]: string } {
     return {
@@ -242,8 +513,27 @@ export class AlertRuleConditionSimpleEscalationEscalations extends $dara.Model {
 }
 
 export class AlertRuleConditionSimpleEscalation extends $dara.Model {
+  /**
+   * @remarks
+   * List of conditions; for an alert rule with multiple severity levels, each level corresponds to one condition object.
+   */
   escalations?: AlertRuleConditionSimpleEscalationEscalations[];
+  /**
+   * @remarks
+   * Applicable condition type: CMS_BASIC_CONDITION.
+   * Metric associated with the alert condition.
+   * 
+   * @example
+   * cpu_total
+   */
   metricName?: string;
+  /**
+   * @remarks
+   * Metric time window, in seconds.
+   * 
+   * @example
+   * 60
+   */
   period?: number;
   static names(): { [key: string]: string } {
     return {
@@ -276,35 +566,133 @@ export class AlertRuleConditionSimpleEscalation extends $dara.Model {
 export class AlertRuleCondition extends $dara.Model {
   /**
    * @remarks
-   * type=SLS_CONDITION时指定，满足条件几次后告警，默认为1
+   * Applicable condition type: SLS_CONDITION.
+   * Number of times the condition must be met before triggering an alert, default is 1.
+   * 
+   * @example
+   * 1
    */
   alertCount?: number;
   /**
    * @remarks
-   * type=SLS_CONDITION时指定
+   * Applicable condition type: SLS_CONDITION.
+   * SLS alert condition list.
    */
   caseList?: AlertRuleConditionCaseList[];
+  /**
+   * @remarks
+   * Applicable condition type: APM_CONDITION.
+   * APM alert comparison condition list.
+   */
   compareList?: AlertRuleConditionCompareList[];
+  /**
+   * @remarks
+   * Applicable condition type: CMS_BASIC_CONDITION.
+   * Valid only when escalationType=composite; composite metric alert condition.
+   */
   compositeEscalation?: AlertRuleConditionCompositeEscalation;
+  /**
+   * @remarks
+   * Applicable condition type: CMS_BASIC_CONDITION.
+   * Valid values:
+   * - simple: Simple metric condition,
+   * - composite: Composite metric condition,
+   * - express: Expression condition.
+   * 
+   * @example
+   * simple
+   */
   escalationType?: string;
+  /**
+   * @remarks
+   * Applicable condition type: CMS_BASIC_CONDITION.
+   * Valid only when escalationType=composite; multi-metric composite alert condition.
+   */
   expressEscalation?: AlertRuleConditionExpressEscalation;
   /**
    * @remarks
-   * 无数据时按什么级别告警，不指定则不对无数据报警
+   * Applicable condition type: APM_CONDITION.
+   * Alert severity level when no data is available; if not specified, no alert will be triggered for missing data.
+   * 
+   * @example
+   * INFO
    */
   noDataAlertLevel?: string;
+  /**
+   * @remarks
+   * Applicable condition type: APM_CONDITION.
+   * Fallback value when no data is available.
+   * 
+   * @example
+   * 1
+   */
   noDataAppendValue?: string;
+  /**
+   * @remarks
+   * Applicable condition type: CMS_BASIC_CONDITION.
+   * Handling method when no monitoring data is available. Valid values:
+   * 
+   * - KEEP_LAST_STATE (default): No action is taken.
+   * - INSUFFICIENT_DATA: Alert with "insufficient data" message.
+   * - OK: Treat as normal.
+   * 
+   * @example
+   * KEEP_LAST_STATE
+   */
   noDataPolicy?: string;
+  /**
+   * @remarks
+   * Comparison operations to determine whether it is year-over-year (YoY) or month-over-month (MoM):
+   * 
+   * - Greater than (GT),
+   * - Greater than or equal to (GTE),
+   * - Less than (LT),
+   * - Less than or equal to (LTE),
+   * - Equal to (EQ),
+   * - Not equal to (NE),
+   * - Year-over-year increase (YOY_UP),
+   * - Year-over-year decrease (YOY_DOWN).
+   * 
+   * @example
+   * LT
+   */
   oper?: string;
+  /**
+   * @remarks
+   * Applicable condition type: APM_CONDITION.
+   * Logical relationship between multiple conditions. Valid values: and, or.
+   * 
+   * @example
+   * and
+   */
   relation?: string;
+  /**
+   * @remarks
+   * Applicable condition type: CMS_BASIC_CONDITION.
+   * Only valid when escalationType=simple; specifies the alert condition for a single metric.
+   */
   simpleEscalation?: AlertRuleConditionSimpleEscalation;
   /**
    * @remarks
-   * 规则条件类型，可选值：SLS_CONDITION
+   * Rule condition type, valid values:
+   * 
+   * SLS_CONDITION (SLS alert condition),
+   * APM_CONDITION (APM alert condition),
+   * CMS_BASIC_CONDITION (Basic Cloud Monitoring alert condition).
    * 
    * This parameter is required.
+   * 
+   * @example
+   * SLS_CONDITION
    */
   type?: string;
+  /**
+   * @remarks
+   * Alert triggering threshold.
+   * 
+   * @example
+   * 60
+   */
   value?: number;
   static names(): { [key: string]: string } {
     return {

package/src/models/AlertRuleDataSource.ts

@@ -3,9 +3,40 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AlertRuleDataSourceDsList extends $dara.Model {
+  /**
+   * @remarks
+   * SLS project
+   * 
+   * @example
+   * mySlsProject
+   */
   project?: string;
+  /**
+   * @remarks
+   * The region where the SLS project is located.
+   * 
+   * @example
+   * cn-hangzhou
+   */
   regionId?: string;
+  /**
+   * @remarks
+   * LogStore/MetricStore name.
+   * 
+   * @example
+   * mySlsLogStore
+   */
   store?: string;
+  /**
+   * @remarks
+   * Type of SLS data sub-source:
+   * 
+   * - SLS_LOG_DS: LogStore data source.
+   * - SLS_METRIC_DS: MetricStore data source.
+   * 
+   * @example
+   * SLS_LOG_DS
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -35,20 +66,64 @@ export class AlertRuleDataSourceDsList extends $dara.Model {
 }
 
 export class AlertRuleDataSource extends $dara.Model {
+  /**
+   * @remarks
+   * Applicable data source type: APM_DS.
+   * Application type: 
+   * 
+   * - apm.
+   * 
+   * @example
+   * apm
+   */
   appType?: string;
+  /**
+   * @remarks
+   * Applicable data source type: SLS_MULTI_DS.
+   * List of sub-data sources.
+   */
   dsList?: AlertRuleDataSourceDsList[];
   /**
    * @remarks
-   * 实例id，当type=PROMETHEUS_DS/ENTERPRISE_DS时必填，为prometheus实例的clusterId或指标仓库名称
+   * Applicable data source type: PROMETHEUS_DS.
+   * Prometheus instance ID.
+   * 
+   * @example
+   * rw-bbe8961b4a59be0
    */
   instanceId?: string;
+  /**
+   * @remarks
+   * Applicable data source type: ENTERPRISE_DS.
+   * Name of the enterprise cloud monitoring metric repository.
+   * 
+   * @example
+   * aliyun-default
+   */
   namespace?: string;
+  /**
+   * @remarks
+   * Applicable data source types: APM_DS, PROMETHEUS_DS.
+   * The regionId to which the data source belongs.
+   * 
+   * @example
+   * cn-hangzhou
+   */
   regionId?: string;
   /**
    * @remarks
-   * 数据源类型
+   * Data source type.
+   * Valid values:
+   * - PROMETHEUS_DS: Prometheus data source.
+   * - SLS_MULTI_DS: SLS data source.
+   * - APM_DS: Application monitoring data source.
+   * - CMS_BASIC_DS: Basic cloud monitoring data source.
+   * - ENTERPRISE_DS: Enterprise cloud monitoring data source.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * PROMETHEUS_DS
    */
   type?: string;
   static names(): { [key: string]: string } {

package/src/models/AlertRuleLabelFilter.ts

@@ -4,6 +4,10 @@ import * as $dara from '@darabonba/typescript';
 
 export class AlertRuleLabelFilter extends $dara.Model {
   labels?: { [key: string]: string };
+  /**
+   * @example
+   * AND
+   */
   opt?: string;
   static names(): { [key: string]: string } {
     return {