@alicloud/cms20240330 6.0.1 → 6.2.0

package/src/models/AlertRuleNotification.ts

@@ -4,15 +4,54 @@ import { AlertRuleTimeSpan } from "./AlertRuleTimeSpan";
 
 
 export class AlertRuleNotification extends $dara.Model {
+  /**
+   * @remarks
+   * List of contact IDs.
+   */
   contacts?: string[];
+  /**
+   * @remarks
+   * List of custom webhook notification object IDs.
+   */
   customWebhooks?: string[];
   dingCoolAppWebhooks?: string[];
+  /**
+   * @remarks
+   * List of DingTalk webhook notification object IDs.
+   */
   dingWebhooks?: string[];
+  /**
+   * @remarks
+   * List of Feishu webhook notification object IDs.
+   */
   fsWebhooks?: string[];
+  /**
+   * @remarks
+   * List of contact group IDs.
+   */
   groups?: string[];
+  /**
+   * @remarks
+   * Notification time window; notifications are sent only during this period.
+   */
   notifyTime?: AlertRuleTimeSpan;
+  /**
+   * @remarks
+   * Notification silence duration, in seconds.
+   * 
+   * @example
+   * 86400
+   */
   silenceTime?: number;
+  /**
+   * @remarks
+   * List of Slack webhook notification object IDs.
+   */
   slackWebhooks?: string[];
+  /**
+   * @remarks
+   * List of WeChat webhook notification object IDs.
+   */
   wxWebhooks?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AlertRuleQuery.ts

@@ -30,8 +30,29 @@ export class AlertRuleQueryEntityFields extends $dara.Model {
 }
 
 export class AlertRuleQueryEntityFilterFilters extends $dara.Model {
+  /**
+   * @remarks
+   * 字段
+   * 
+   * @example
+   * instanceId
+   */
   field?: string;
+  /**
+   * @remarks
+   * 比较运算符。
+   * 
+   * @example
+   * =
+   */
   operator?: string;
+  /**
+   * @remarks
+   * 匹配的值。
+   * 
+   * @example
+   * wait_throw
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -59,8 +80,26 @@ export class AlertRuleQueryEntityFilterFilters extends $dara.Model {
 }
 
 export class AlertRuleQueryEntityFilter extends $dara.Model {
+  /**
+   * @remarks
+   * 资源类型域。
+   * 
+   * @example
+   * rum
+   */
   domain?: string;
+  /**
+   * @remarks
+   * 过滤条件列表，用于进一步筛选资源。
+   */
   filters?: AlertRuleQueryEntityFilterFilters[];
+  /**
+   * @remarks
+   * 资源类型。
+   * 
+   * @example
+   * apm
+   */
   type?: string;
   static names(): { [key: string]: string } {
     return {
@@ -120,8 +159,34 @@ export class AlertRuleQueryLabelFilters extends $dara.Model {
 }
 
 export class AlertRuleQueryQueriesApmFilters extends $dara.Model {
+  /**
+   * @remarks
+   * Dimension in APM metrics.
+   * 
+   * @example
+   * rpcType
+   */
   dim?: string;
+  /**
+   * @remarks
+   * Filter operation types:
+   * 
+   * - eq: equals.
+   * - neq: not equals.
+   * - match: regular expression match.
+   * - nmatch: regular expression not match.
+   * 
+   * @example
+   * eq
+   */
   type?: string;
+  /**
+   * @remarks
+   * The corresponding value for the filter operation.
+   * 
+   * @example
+   * h3ji7a0y9i@2ac80e27fdfd0a2
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -149,33 +214,84 @@ export class AlertRuleQueryQueriesApmFilters extends $dara.Model {
 }
 
 export class AlertRuleQueryQueries extends $dara.Model {
+  /**
+   * @remarks
+   * Applicable query type: APM_MULTI_QUERY.
+   * ID of the APM predefined metric.
+   * 
+   * @example
+   * appstat.jvm.ThreadNewCount
+   */
   apmAlertMetricId?: string;
+  /**
+   * @remarks
+   * Applicable query type: ARMS_MULTI_QUERY.
+   * Dimension filter configuration for APM metrics. Must be used in conjunction with apmAlertMetricId.
+   */
   apmFilters?: AlertRuleQueryQueriesApmFilters[];
+  /**
+   * @remarks
+   * Applicable query type: ARMS_MULTI_QUERY.
+   * List of aggregation dimensions for the query, i.e., the dimensions by which the metric is aggregated.
+   */
   apmGroupBy?: string[];
+  /**
+   * @remarks
+   * Applicable query type: ARMS_MULTI_QUERY.
+   * Alert (data) duration.
+   * 
+   * @example
+   * 120
+   */
   duration?: number;
   /**
    * @remarks
-   * 时间偏移结束时间(相对)，如果指定了start、end，则不指定window。
+   * Applicable query type: SLS_MULTI_QUERY.
+   * Time offset end time (relative).
+   * If start and end are specified, do not specify window.
+   * 
+   * @example
+   * 0
    */
   end?: number;
   /**
    * @remarks
-   * 查询表达式
+   * Applicable query types: APM_MULTI_QUERY, SLS_MULTI_QUERY.
+   * Query expression.
+   * 
+   * - For APM_MULTI_QUERY, this field is optional and contains the PromQL generated for predefined metrics (used for data preview).
+   * - For SLS_MULTI_QUERY, this field contains the SQL query statement.
+   * 
+   * @example
+   * sum by (rpc,acs_arms_service_id,pid,rpcType) (sum_over_time_lorc(arms_app_requests_count_ign_destid_endpoint_parent_ppid_prpc{callKind=~\\"http|rpc|custom_entry|server|consumer\\",pid=\\"gaddp9ap8q@cb005ffdf44b8ac\\",source=\\"apm\\"}[1m]))
    */
   expr?: string;
   /**
    * @remarks
-   * sls查询的时间偏移开始时间(相对)，如果指定了start、end，则不指定window。  例如：start=15， timeUnit=minute，表示15分钟前
+   * Applicable query type: SLS_MULTI_QUERY.
+   * SLS query time offset start time (relative).
+   * If start and end are specified, do not specify window. For example: start=15, timeUnit=minute, which means 15 minutes ago.
+   * 
+   * @example
+   * 15
    */
   start?: number;
   /**
    * @remarks
-   * start和end、window的时间单位： day/hour/minute/second
+   * Applicable query type: SLS_MULTI_QUERY.
+   * Time units for the start, end, and window parameters: day/hour/minute/second.
+   * 
+   * @example
+   * hour
    */
   timeUnit?: string;
   /**
    * @remarks
-   * 整点时间查询区间。  如果指定了window则不指定start、end
+   * Applicable query type: SLS_MULTI_QUERY.
+   * Exact-hour time query interval. If window is specified, start and end should not be specified.
+   * 
+   * @example
+   * 1
    */
   window?: number;
   static names(): { [key: string]: string } {
@@ -222,30 +338,168 @@ export class AlertRuleQueryQueries extends $dara.Model {
 }
 
 export class AlertRuleQuery extends $dara.Model {
+  /**
+   * @remarks
+   * Applicable query type: PROMQL_QUERY.
+   * Whether to perform alert evaluation only after data completeness is ensured.
+   * 
+   * @example
+   * true
+   */
   checkAfterDataComplete?: boolean;
+  /**
+   * @remarks
+   * Applicable query type: CMS_BASIC_QUERY.
+   * List of filtering dimensions for the resource.
+   */
   dimensions?: { [key: string]: string }[];
+  /**
+   * @remarks
+   * 资源所属的领域。
+   * 
+   * @example
+   * rum
+   */
   domain?: string;
+  /**
+   * @remarks
+   * Applicable query type: PROMQL_QUERY.
+   * Duration of alert data, in seconds.
+   * 
+   * @example
+   * 60
+   */
   duration?: number;
   entityFields?: AlertRuleQueryEntityFields[];
+  /**
+   * @remarks
+   * 资源过滤器，用于筛选目标资源。
+   */
   entityFilter?: AlertRuleQueryEntityFilter;
+  /**
+   * @remarks
+   * Applicable query type: PROMQL_QUERY.
+   * Query expression (PromQL).
+   * 
+   * @example
+   * sum(sum(max_over_time(kube_pod_status_phase{phase=~\\"Pending\\",job=\\"_kube-state-metrics\\"}[5m])) by (pod)) > 1000
+   */
   expr?: string;
+  /**
+   * @remarks
+   * Applicable query type: SLS_MULTI_QUERY.
+   * Configuration for the set join operation between the results of subquery 1 (queries[0]) and subquery 2 (queries[1]).
+   */
   firstJoin?: AlertRuleSlsQueryJoin;
+  /**
+   * @remarks
+   * Applicable query type: SLS_MULTI_QUERY.
+   * List of grouping field names.
+   */
   groupFieldList?: string[];
+  /**
+   * @remarks
+   * Applicable query type: CMS_BASIC_QUERY.
+   * Associated application group ID, valid only when relationType = GROUP.
+   * 
+   * @example
+   * 23423
+   */
   groupId?: string;
+  /**
+   * @remarks
+   * Applicable query type: SLS_MULTI_QUERY.
+   * Grouping type, with the following possible values:
+   * 
+   * - none: No grouping.
+   * - label: Automatic label grouping.
+   * - custom: Custom label grouping.
+   * 
+   * @example
+   * label
+   */
   groupType?: string;
   labelFilters?: AlertRuleQueryLabelFilters[];
+  /**
+   * @remarks
+   * 指标名。
+   * 
+   * @example
+   * memory
+   */
   metric?: string;
+  /**
+   * @remarks
+   * 监控指标集合。
+   * 
+   * @example
+   * cpu_usage
+   */
   metricSet?: string;
+  /**
+   * @remarks
+   * Applicable query type: CMS_BASIC_QUERY.
+   * Namespace of the metric.
+   * 
+   * @example
+   * acs_ecs_dashboard
+   */
   namespace?: string;
+  /**
+   * @remarks
+   * Applicable query types: SLS_MULTI_QUERY, APM_MULTI_QUERY.
+   * List of subqueries.
+   * 
+   * For the SLS_MULTI_QUERY type, the list can contain up to three subqueries, and the number and order of subqueries must match the sub-datasource configurations in datasource.dsList.
+   */
   queries?: AlertRuleQueryQueries[];
+  /**
+   * @remarks
+   * Applicable query type: CMS_BASIC_QUERY.
+   * Resource scope for the rule query, with the following allowed values:
+   * - USER: All resources under the user\\"s UID.
+   * - GROUP: Application group.
+   * - INSTANCE: Specified list of instances.
+   * 
+   * @example
+   * USER
+   */
   relationType?: string;
+  /**
+   * @remarks
+   * Applicable query type: SLS_MULTI_QUERY.
+   * Configuration for the set join operation between the results of subquery 2 (queries[2]) and subquery 3 (queries[3]).
+   */
   secondJoin?: AlertRuleSlsQueryJoin;
+  /**
+   * @remarks
+   * Service ID list.
+   */
   serviceIds?: string[];
   /**
    * @remarks
-   * 查询类型
+   * Query type.
+   * 
+   * Valid values:
+   * 
+   * - PROMQL_QUERY: PromQL query
+   * - SLS_MULTI_QUERY: SLS query
+   * - APM_MULTI_QUERY: APM query
+   * - CMS_BASIC_QUERY: Basic CloudMonitor query
+   * 
+   * The valid fields within the query object vary depending on the query type. Refer to the "Applicable query type" description in each field\\"s documentation for details.
+   * 
+   * The query type must match the data source type, with the following correspondences:
+   * 
+   * - Prometheus data source (PROMETHEUS_DS): PROMQL_QUERY
+   * - APM data source (APM_DS): APM_MULTI_QUERY
+   * - SLS data source (SLS_MULTI_DS): SLS_MULTI_QUERY
+   * - Basic CloudMonitor data source (CMS_BASIC_DS): CMS_BASIC_QUERY.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * PROMQL_QUERY
    */
   type?: string;
   static names(): { [key: string]: string } {

package/src/models/AlertRuleRcaConfig.ts

@@ -0,0 +1,30 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class AlertRuleRcaConfig extends $dara.Model {
+  digitalEmployeeName?: string;
+  enableRca?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      digitalEmployeeName: 'digitalEmployeeName',
+      enableRca: 'enableRca',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      digitalEmployeeName: 'string',
+      enableRca: 'boolean',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/AlertRuleSend.ts

@@ -2,18 +2,36 @@
 import * as $dara from '@darabonba/typescript';
 import { AlertRuleAction } from "./AlertRuleAction";
 import { AlertRuleNotification } from "./AlertRuleNotification";
+import { AlertRuleRcaConfig } from "./AlertRuleRcaConfig";
 
 
 export class AlertRuleSend extends $dara.Model {
+  /**
+   * @remarks
+   * Alert Action Integration Configuration.
+   */
   action?: AlertRuleAction;
+  /**
+   * @remarks
+   * Alert Notification Configuration.
+   */
   notification?: AlertRuleNotification;
   notifyStrategies?: string[];
+  rcaConfig?: AlertRuleRcaConfig;
+  /**
+   * @remarks
+   * Whether to deliver alert events to ARMS Alert Management.
+   * 
+   * @example
+   * true
+   */
   sendToArms?: boolean;
   static names(): { [key: string]: string } {
     return {
       action: 'action',
       notification: 'notification',
       notifyStrategies: 'notifyStrategies',
+      rcaConfig: 'rcaConfig',
       sendToArms: 'sendToArms',
     };
   }
@@ -23,6 +41,7 @@ export class AlertRuleSend extends $dara.Model {
       action: AlertRuleAction,
       notification: AlertRuleNotification,
       notifyStrategies: { 'type': 'array', 'itemType': 'string' },
+      rcaConfig: AlertRuleRcaConfig,
       sendToArms: 'boolean',
     };
   }
@@ -37,6 +56,9 @@ export class AlertRuleSend extends $dara.Model {
     if(Array.isArray(this.notifyStrategies)) {
       $dara.Model.validateArray(this.notifyStrategies);
     }
+    if(this.rcaConfig && typeof (this.rcaConfig as any).validate === 'function') {
+      (this.rcaConfig as any).validate();
+    }
     super.validate();
   }
 

package/src/models/AlertRuleSlsQueryJoin.ts

@@ -5,17 +5,26 @@ import * as $dara from '@darabonba/typescript';
 export class AlertRuleSlsQueryJoinConditions extends $dara.Model {
   /**
    * @remarks
-   * 条件的左操作参数，格式为$<query_idx>.<结果集字段名>
+   * Left-hand operand of the condition, formatted as $<query_idx>.<result_set_field_name>.
+   * 
+   * @example
+   * $0.__topic__
    */
   firstField?: string;
   /**
    * @remarks
-   * <, >, ==, !=, <=, >=
+   * Comparison operator; valid values: <, >, ==, !=, <=, >=.
+   * 
+   * @example
+   * ==
    */
   oper?: string;
   /**
    * @remarks
-   * 条件的右操作参数，格式为$<query_idx>.<结果集字段名>
+   * Right-hand operand of the condition, formatted as $<query_idx>.<result_set_field_name>.
+   * 
+   * @example
+   * $0.__topic__
    */
   secondField?: string;
   static names(): { [key: string]: string } {
@@ -44,22 +53,30 @@ export class AlertRuleSlsQueryJoinConditions extends $dara.Model {
 }
 
 export class AlertRuleSlsQueryJoin extends $dara.Model {
+  /**
+   * @remarks
+   * List of connection conditions.
+   */
   conditions?: AlertRuleSlsQueryJoinConditions[];
   /**
    * @remarks
-   * 集合操作类型。
-   *   ● CrossJoin： 笛卡尔积
-   *   ● FullJoin：全联
-   *   ● InnerJoin：内联
-   *   ● LeftExclude： 左斥
-   *   ● RightExclude：右斥
-   *   ● LeftJoin：左联
-   *   ● RightJoin：右联
-   *   ● NoJoin：不合并
-   *   ● Concat： 拼接
-   *   https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement
+   * Set operation type.
+   * CrossJoin: Cartesian product
+   * FullJoin: Full outer join
+   * InnerJoin: Inner join
+   * LeftExclude: Left anti join
+   * RightExclude: Right anti join
+   * LeftJoin: Left outer join
+   * RightJoin: Right outer join
+   * NoJoin: No merge
+   * Concat: Concatenation
+   * 
+   * See also: https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement
    * 
    * This parameter is required.
+   * 
+   * @example
+   * CrossJoin
    */
   type?: string;
   static names(): { [key: string]: string } {

package/src/models/AlertRuleTimeSpan.ts

@@ -3,9 +3,34 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AlertRuleTimeSpan extends $dara.Model {
+  /**
+   * @remarks
+   * Day of the week.
+   */
   dayOfWeek?: number[];
+  /**
+   * @remarks
+   * End time, in HH:mm format.
+   * 
+   * @example
+   * 23:00
+   */
   endTime?: string;
+  /**
+   * @remarks
+   * Default time zone is Beijing Time: +0800.
+   * 
+   * @example
+   * +0800
+   */
   gmtOffset?: string;
+  /**
+   * @remarks
+   * Start time, in HH:mm format.
+   * 
+   * @example
+   * 09:00
+   */
   startTime?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/CmsEventForView.ts

@@ -4,27 +4,111 @@ import { EventResourceForEventView } from "./EventResourceForEventView";
 
 
 export class CmsEventForView extends $dara.Model {
+  /**
+   * @example
+   * { "description": "High load detected on server", "operator": "auto" }
+   */
   annotations?: { [key: string]: any };
+  /**
+   * @example
+   * { "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }
+   */
   data?: any;
+  /**
+   * @example
+   * "application/json"
+   */
   datacontenttype?: string;
+  /**
+   * @example
+   * "https://schema.alibabacloud.com/cms/alert/v1"
+   */
   dataschema?: string;
+  /**
+   * @example
+   * "dedup-abc123"
+   */
   dedupId?: string;
+  /**
+   * @example
+   * "event-1234567890"
+   */
   id?: string;
+  /**
+   * @example
+   * "integration-xyz"
+   */
   integrationUuid?: string;
+  /**
+   * @example
+   * {\\"source\\": \\"system\\"}
+   */
   labels?: { [key: string]: any };
+  /**
+   * @example
+   * 1743846610000
+   */
   receiveTime?: number;
   resource?: EventResourceForEventView;
+  /**
+   * @example
+   * "CRITICAL"
+   */
   severity?: string;
+  /**
+   * @example
+   * "ECS"
+   */
   source?: string;
+  /**
+   * @example
+   * "CloudMonitor"
+   */
   sourcetype?: string;
+  /**
+   * @example
+   * Running
+   */
   status?: string;
+  /**
+   * @example
+   * "Instance cpu usage exceeds threshold"
+   */
   subject?: string;
+  /**
+   * @example
+   * "HighCPUUsage"
+   */
   subtype?: string;
+  /**
+   * @example
+   * "sys-event-987654321"
+   */
   sysId?: string;
+  /**
+   * @example
+   * "2025-04-05T10:30:00Z"
+   */
   time?: string;
+  /**
+   * @example
+   * 1743846600000
+   */
   timestamp?: number;
+  /**
+   * @example
+   * "Alert"
+   */
   type?: string;
+  /**
+   * @example
+   * "ws-abc123"
+   */
   workspace?: string;
+  /**
+   * @example
+   * { "department": "finance", "project": "payment-gateway" }
+   */
   workspaceTags?: { [key: string]: any };
   static names(): { [key: string]: string } {
     return {