@alicloud/cms20240330 6.2.4 → 6.4.0

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

@@ -3,15 +3,8 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AlertRuleLabelFilter extends $dara.Model {
-  /**
-   * @remarks
-   * 标签过滤器
-   */
   labels?: { [key: string]: string };
   /**
-   * @remarks
-   * 多个标签之间的关系操作符
-   * 
    * @example
    * AND
    */

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/AlertRuleNotificationFilter.ts

@@ -3,40 +3,12 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AlertRuleNotificationFilter extends $dara.Model {
-  /**
-   * @remarks
-   * 联系人ID过滤
-   */
   contacts?: string[];
-  /**
-   * @remarks
-   * 自定义webhook ID过滤
-   */
   customWebhooks?: string[];
-  /**
-   * @remarks
-   * 钉钉webhook ID过滤
-   */
   dingWebhooks?: string[];
-  /**
-   * @remarks
-   * 飞书webhook ID过滤
-   */
   fsWebhooks?: string[];
-  /**
-   * @remarks
-   * 联系人组过滤配置
-   */
   groups?: string[];
-  /**
-   * @remarks
-   * slack webhook ID过滤列表
-   */
   slackWebhooks?: string[];
-  /**
-   * @remarks
-   * 微信webhook ID过滤
-   */
   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 {
@@ -146,8 +185,34 @@ export class AlertRuleQueryMarkTags 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 {
@@ -175,33 +240,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 } {
@@ -248,31 +364,169 @@ 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[];
   markTags?: AlertRuleQueryMarkTags[];
+  /**
+   * @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/AlertRuleSend.ts

@@ -6,10 +6,25 @@ 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 {

package/src/models/AlertRuleSlsQueryJoin.ts

@@ -5,7 +5,7 @@ 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__
@@ -13,7 +13,7 @@ export class AlertRuleSlsQueryJoinConditions extends $dara.Model {
   firstField?: string;
   /**
    * @remarks
-   * 比较操作符，取值范围：<, >, ==, !=, <=, >=
+   * Comparison operator; valid values: <, >, ==, !=, <=, >=.
    * 
    * @example
    * ==
@@ -21,7 +21,7 @@ export class AlertRuleSlsQueryJoinConditions extends $dara.Model {
   oper?: string;
   /**
    * @remarks
-   * 条件的右操作参数，格式为$<query_idx>.<结果集字段名>
+   * Right-hand operand of the condition, formatted as $<query_idx>.<result_set_field_name>.
    * 
    * @example
    * $0.__topic__
@@ -55,25 +55,23 @@ export class AlertRuleSlsQueryJoinConditions extends $dara.Model {
 export class AlertRuleSlsQueryJoin extends $dara.Model {
   /**
    * @remarks
-   * 连接条件列表
+   * List of connection conditions.
    */
   conditions?: AlertRuleSlsQueryJoinConditions[];
   /**
    * @remarks
-   * 集合操作类型。
+   * 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
    * 
-   * - CrossJoin： 笛卡尔积
-   * - FullJoin：全联
-   * - InnerJoin：内联
-   * - LeftExclude： 左斥
-   * - RightExclude：右斥
-   * - LeftJoin：左联
-   * - RightJoin：右联
-   * - NoJoin：不合并
-   * - Concat： 拼接
-   * 
-   * 参见：
-   *   https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement
+   * See also: https://help.aliyun.com/zh/sls/user-guide/set-query-statistics-statement
    * 
    * This parameter is required.
    * 

package/src/models/AlertRuleTimeSpan.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class AlertRuleTimeSpan extends $dara.Model {
   /**
    * @remarks
-   * 每周的星期几
+   * Day of the week.
    */
   dayOfWeek?: number[];
   /**
    * @remarks
-   * 结束时间，格式HH:mm
+   * End time, in HH:mm format.
    * 
    * @example
    * 23:00
@@ -18,7 +18,7 @@ export class AlertRuleTimeSpan extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * 默认北京时间： +0800
+   * Default time zone is Beijing Time: +0800.
    * 
    * @example
    * +0800
@@ -26,7 +26,7 @@ export class AlertRuleTimeSpan extends $dara.Model {
   gmtOffset?: string;
   /**
    * @remarks
-   * 开始时间，格式HH:mm
+   * Start time, in HH:mm format.
    * 
    * @example
    * 09:00