@alicloud/cms20240330 9.2.2 → 10.0.0

package/src/models/AlertRuleDataSource.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class AlertRuleDataSourceDsList extends $dara.Model {
   /**
    * @remarks
-   * SLS project
+   * The SLS project.
    * 
    * @example
    * mySlsProject
@@ -21,7 +21,7 @@ export class AlertRuleDataSourceDsList extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * LogStore/MetricStore name.
+   * The name of the LogStore or MetricStore.
    * 
    * @example
    * mySlsLogStore
@@ -29,10 +29,11 @@ export class AlertRuleDataSourceDsList extends $dara.Model {
   store?: string;
   /**
    * @remarks
-   * Type of SLS data sub-source:
+   * The type of the SLS sub-data source. Valid values:
    * 
-   * - SLS_LOG_DS: LogStore data source.
-   * - SLS_METRIC_DS: MetricStore data source.
+   * - SLS_LOG_DS: A LogStore data source.
+   * 
+   * - SLS_METRIC_DS: A MetricStore data source.
    * 
    * @example
    * SLS_LOG_DS
@@ -68,10 +69,11 @@ export class AlertRuleDataSourceDsList extends $dara.Model {
 export class AlertRuleDataSource extends $dara.Model {
   /**
    * @remarks
-   * Applicable data source type: APM_DS.
-   * Application type: 
+   * Applies to the APM_DS data source type.
+   * 
+   * The type of the application. Valid value:
    * 
-   * - apm.
+   * - apm
    * 
    * @example
    * apm
@@ -79,14 +81,16 @@ export class AlertRuleDataSource extends $dara.Model {
   appType?: string;
   /**
    * @remarks
-   * Applicable data source type: SLS_MULTI_DS.
-   * List of sub-data sources.
+   * Applies to the SLS_MULTI_DS data source type.
+   * 
+   * A list of sub-data sources.
    */
   dsList?: AlertRuleDataSourceDsList[];
   /**
    * @remarks
-   * Applicable data source type: PROMETHEUS_DS.
-   * Prometheus instance ID.
+   * Applies to the PROMETHEUS_DS data source type.
+   * 
+   * The ID of the Prometheus instance.
    * 
    * @example
    * rw-bbe8961b4a59be0
@@ -94,8 +98,9 @@ export class AlertRuleDataSource extends $dara.Model {
   instanceId?: string;
   /**
    * @remarks
-   * Applicable data source type: ENTERPRISE_DS.
-   * Name of the enterprise cloud monitoring metric repository.
+   * Applies to the ENTERPRISE_DS data source type.
+   * 
+   * The name of the Hybrid Cloud Monitoring metric repository.
    * 
    * @example
    * aliyun-default
@@ -103,8 +108,9 @@ export class AlertRuleDataSource extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * Applicable data source types: APM_DS, PROMETHEUS_DS.
-   * The regionId to which the data source belongs.
+   * Applies to the APM_DS and PROMETHEUS_DS data source types.
+   * 
+   * The ID of the region where the data source is located.
    * 
    * @example
    * cn-hangzhou
@@ -113,13 +119,19 @@ export class AlertRuleDataSource extends $dara.Model {
   tenantId?: string;
   /**
    * @remarks
-   * Data source type.
+   * The 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.
+   * 
+   * - PROMETHEUS_DS: A Prometheus data source.
+   * 
+   * - SLS_MULTI_DS: An SLS data source.
+   * 
+   * - APM_DS: An Application Monitoring data source.
+   * 
+   * - CMS_BASIC_DS: A basic Cloud Monitor data source.
+   * 
+   * - ENTERPRISE_DS: A Hybrid Cloud Monitoring data source.
    * 
    * This parameter is required.
    * 

package/src/models/AlertRuleLabelFilter.ts

@@ -3,8 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AlertRuleLabelFilter extends $dara.Model {
+  /**
+   * @remarks
+   * The label filter.
+   */
   labels?: { [key: string]: string };
   /**
+   * @remarks
+   * The relationship operator between multiple labels.
+   * 
    * @example
    * AND
    */

package/src/models/AlertRuleNotification.ts

@@ -6,39 +6,43 @@ import { AlertRuleTimeSpan } from "./AlertRuleTimeSpan";
 export class AlertRuleNotification extends $dara.Model {
   /**
    * @remarks
-   * List of contact IDs.
+   * A list of contact IDs.
    */
   contacts?: string[];
   /**
    * @remarks
-   * List of custom webhook notification object IDs.
+   * A list of custom webhook notification object IDs.
    */
   customWebhooks?: string[];
+  /**
+   * @remarks
+   * A list of DingTalk Cool App webhook notification object IDs.
+   */
   dingCoolAppWebhooks?: string[];
   /**
    * @remarks
-   * List of DingTalk webhook notification object IDs.
+   * A list of DingTalk webhook notification object IDs.
    */
   dingWebhooks?: string[];
   /**
    * @remarks
-   * List of Feishu webhook notification object IDs.
+   * A list of Lark webhook notification object IDs.
    */
   fsWebhooks?: string[];
   /**
    * @remarks
-   * List of contact group IDs.
+   * A list of contact group IDs.
    */
   groups?: string[];
   /**
    * @remarks
-   * Notification time window; notifications are sent only during this period.
+   * The notification period. Notifications are sent only within this period.
    */
   notifyTime?: AlertRuleTimeSpan;
   qwencloudContacts?: { [key: string]: {[key: string]: any} };
   /**
    * @remarks
-   * Notification silence duration, in seconds.
+   * The notification silence period. Unit: seconds.
    * 
    * @example
    * 86400
@@ -46,12 +50,12 @@ export class AlertRuleNotification extends $dara.Model {
   silenceTime?: number;
   /**
    * @remarks
-   * List of Slack webhook notification object IDs.
+   * A list of Slack webhook notification object IDs.
    */
   slackWebhooks?: string[];
   /**
    * @remarks
-   * List of WeChat webhook notification object IDs.
+   * A list of WeChat webhook notification object IDs.
    */
   wxWebhooks?: string[];
   static names(): { [key: string]: string } {

package/src/models/AlertRuleNotificationFilter.ts

@@ -3,12 +3,40 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AlertRuleNotificationFilter extends $dara.Model {
+  /**
+   * @remarks
+   * A list of contact IDs for filtering.
+   */
   contacts?: string[];
+  /**
+   * @remarks
+   * A list of custom webhook IDs for filtering.
+   */
   customWebhooks?: string[];
+  /**
+   * @remarks
+   * A list of DingTalk webhook IDs for filtering.
+   */
   dingWebhooks?: string[];
+  /**
+   * @remarks
+   * A list of Lark webhook IDs for filtering.
+   */
   fsWebhooks?: string[];
+  /**
+   * @remarks
+   * A list of contact group IDs for filtering.
+   */
   groups?: string[];
+  /**
+   * @remarks
+   * A list of Slack webhook IDs for filtering.
+   */
   slackWebhooks?: string[];
+  /**
+   * @remarks
+   * A list of WeChat webhook IDs for filtering.
+   */
   wxWebhooks?: string[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AlertRuleQuery.ts

@@ -4,7 +4,21 @@ import { AlertRuleSlsQueryJoin } from "./AlertRuleSlsQueryJoin";
 
 
 export class AlertRuleQueryEntityFields extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the entity field.
+   * 
+   * @example
+   * instanceId
+   */
   field?: string;
+  /**
+   * @remarks
+   * The value of the field.
+   * 
+   * @example
+   * i-abc123
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -32,7 +46,7 @@ export class AlertRuleQueryEntityFields extends $dara.Model {
 export class AlertRuleQueryEntityFilterFilters extends $dara.Model {
   /**
    * @remarks
-   * 字段
+   * The field.
    * 
    * @example
    * instanceId
@@ -40,7 +54,7 @@ export class AlertRuleQueryEntityFilterFilters extends $dara.Model {
   field?: string;
   /**
    * @remarks
-   * 比较运算符。
+   * The comparison operator.
    * 
    * @example
    * =
@@ -48,7 +62,7 @@ export class AlertRuleQueryEntityFilterFilters extends $dara.Model {
   operator?: string;
   /**
    * @remarks
-   * 匹配的值。
+   * The value to match.
    * 
    * @example
    * wait_throw
@@ -82,7 +96,7 @@ export class AlertRuleQueryEntityFilterFilters extends $dara.Model {
 export class AlertRuleQueryEntityFilter extends $dara.Model {
   /**
    * @remarks
-   * 资源类型域。
+   * The domain of the resource type.
    * 
    * @example
    * rum
@@ -90,12 +104,12 @@ export class AlertRuleQueryEntityFilter extends $dara.Model {
   domain?: string;
   /**
    * @remarks
-   * 过滤条件列表，用于进一步筛选资源。
+   * A list of filter conditions to further screen resources.
    */
   filters?: AlertRuleQueryEntityFilterFilters[];
   /**
    * @remarks
-   * 资源类型。
+   * The resource type.
    * 
    * @example
    * apm
@@ -130,8 +144,29 @@ export class AlertRuleQueryEntityFilter extends $dara.Model {
 }
 
 export class AlertRuleQueryLabelFilters extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the label.
+   * 
+   * @example
+   * app
+   */
   name?: string;
+  /**
+   * @remarks
+   * The comparison operator that determines how to match the label value.
+   * 
+   * @example
+   * =
+   */
   operator?: string;
+  /**
+   * @remarks
+   * The value of the label.
+   * 
+   * @example
+   * web
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -187,7 +222,7 @@ export class AlertRuleQueryMarkTags extends $dara.Model {
 export class AlertRuleQueryQueriesApmFilters extends $dara.Model {
   /**
    * @remarks
-   * Dimension in APM metrics.
+   * The dimension in the APM metric.
    * 
    * @example
    * rpcType
@@ -195,12 +230,15 @@ export class AlertRuleQueryQueriesApmFilters extends $dara.Model {
   dim?: string;
   /**
    * @remarks
-   * Filter operation types:
+   * The filter operation type:
    * 
-   * - eq: equals.
-   * - neq: not equals.
-   * - match: regular expression match.
-   * - nmatch: regular expression not match.
+   * - eq: Equal to
+   * 
+   * - neq: Not equal to
+   * 
+   * - match: Regular expression match
+   * 
+   * - nmatch: Regular expression non-match
    * 
    * @example
    * eq
@@ -208,7 +246,7 @@ export class AlertRuleQueryQueriesApmFilters extends $dara.Model {
   type?: string;
   /**
    * @remarks
-   * The corresponding value for the filter operation.
+   * The value that corresponds to the filter operation.
    * 
    * @example
    * h3ji7a0y9i@2ac80e27fdfd0a2
@@ -243,7 +281,8 @@ export class AlertRuleQueryQueries extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: APM_MULTI_QUERY.
-   * ID of the APM predefined metric.
+   * 
+   * The ID of the predefined Application Performance Management (APM) metric.
    * 
    * @example
    * appstat.jvm.ThreadNewCount
@@ -252,19 +291,22 @@ export class AlertRuleQueryQueries extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: ARMS_MULTI_QUERY.
-   * Dimension filter configuration for APM metrics. Must be used in conjunction with apmAlertMetricId.
+   * 
+   * The dimension filter configuration for the APM metric. This parameter must be used 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.
+   * 
+   * A list of aggregation dimensions for the query. This specifies the metric dimensions to use for aggregation.
    */
   apmGroupBy?: string[];
   /**
    * @remarks
    * Applicable query type: ARMS_MULTI_QUERY.
-   * Alert (data) duration.
+   * 
+   * The duration of the alert data.
    * 
    * @example
    * 120
@@ -273,8 +315,10 @@ export class AlertRuleQueryQueries extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: SLS_MULTI_QUERY.
-   * Time offset end time (relative).
-   * If start and end are specified, do not specify window.
+   * 
+   * The relative end time of the time offset.
+   * 
+   * If you specify start and end, do not specify window.
    * 
    * @example
    * 0
@@ -282,11 +326,13 @@ export class AlertRuleQueryQueries extends $dara.Model {
   end?: number;
   /**
    * @remarks
-   * Applicable query types: APM_MULTI_QUERY, SLS_MULTI_QUERY.
-   * Query expression.
+   * Applicable query types: APM_MULTI_QUERY and SLS_MULTI_QUERY.
    * 
-   * - 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.
+   * The query expression.
+   * 
+   * - For APM_MULTI_QUERY, this parameter is optional. It is the PromQL expression generated for a predefined metric, used for data preview.
+   * 
+   * - For SLS_MULTI_QUERY, this parameter is the SQL search 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]))
@@ -297,8 +343,10 @@ export class AlertRuleQueryQueries extends $dara.Model {
   /**
    * @remarks
    * 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.
+   * 
+   * The relative start time of the time offset for an SLS query.
+   * 
+   * If you specify start and end, do not specify window. For example, if start is 15 and timeUnit is minute, the time offset starts 15 minutes ago.
    * 
    * @example
    * 15
@@ -307,7 +355,8 @@ export class AlertRuleQueryQueries extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: SLS_MULTI_QUERY.
-   * Time units for the start, end, and window parameters: day/hour/minute/second.
+   * 
+   * The time unit for the start, end, and window parameters. Valid values: day, hour, minute, and second.
    * 
    * @example
    * hour
@@ -316,7 +365,8 @@ export class AlertRuleQueryQueries extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: SLS_MULTI_QUERY.
-   * Exact-hour time query interval. If window is specified, start and end should not be specified.
+   * 
+   * The query interval for a time frame. If you specify window, do not specify start and end.
    * 
    * @example
    * 1
@@ -373,7 +423,8 @@ export class AlertRuleQuery extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: PROMQL_QUERY.
-   * Whether to perform alert evaluation only after data completeness is ensured.
+   * 
+   * Specifies whether to run the alert check only after the data is complete.
    * 
    * @example
    * true
@@ -382,12 +433,13 @@ export class AlertRuleQuery extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: CMS_BASIC_QUERY.
-   * List of filtering dimensions for the resource.
+   * 
+   * A list of filter dimensions for the resource.
    */
   dimensions?: { [key: string]: string }[];
   /**
    * @remarks
-   * 资源所属的领域。
+   * The realm to which the resource belongs.
    * 
    * @example
    * rum
@@ -396,22 +448,28 @@ export class AlertRuleQuery extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: PROMQL_QUERY.
-   * Duration of alert data, in seconds.
+   * 
+   * The duration for which the alert data persists, in seconds.
    * 
    * @example
    * 60
    */
   duration?: number;
+  /**
+   * @remarks
+   * An array of entity field filters.
+   */
   entityFields?: AlertRuleQueryEntityFields[];
   /**
    * @remarks
-   * 资源过滤器，用于筛选目标资源。
+   * A resource filter used to screen target resources.
    */
   entityFilter?: AlertRuleQueryEntityFilter;
   /**
    * @remarks
    * Applicable query type: PROMQL_QUERY.
-   * Query expression (PromQL).
+   * 
+   * The query expression (PromQL).
    * 
    * @example
    * sum(sum(max_over_time(kube_pod_status_phase{phase=~\\"Pending\\",job=\\"_kube-state-metrics\\"}[5m])) by (pod)) > 1000
@@ -420,19 +478,22 @@ export class AlertRuleQuery extends $dara.Model {
   /**
    * @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]).
+   * 
+   * The configuration for the join operation on the result sets of subquery 1 (queries[0]) and subquery 2 (queries[1]).
    */
   firstJoin?: AlertRuleSlsQueryJoin;
   /**
    * @remarks
    * Applicable query type: SLS_MULTI_QUERY.
-   * List of grouping field names.
+   * 
+   * A list of grouping field names.
    */
   groupFieldList?: string[];
   /**
    * @remarks
    * Applicable query type: CMS_BASIC_QUERY.
-   * Associated application group ID, valid only when relationType = GROUP.
+   * 
+   * The ID of the associated application group. This parameter is valid only when relationType is set to GROUP.
    * 
    * @example
    * 23423
@@ -441,21 +502,28 @@ export class AlertRuleQuery extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: SLS_MULTI_QUERY.
-   * Grouping type, with the following possible values:
+   * 
+   * The grouping type. Valid values:
    * 
    * - none: No grouping.
-   * - label: Automatic label grouping.
-   * - custom: Custom label grouping.
+   * 
+   * - label: Automatic grouping by tag.
+   * 
+   * - custom: Custom grouping by tag.
    * 
    * @example
    * label
    */
   groupType?: string;
+  /**
+   * @remarks
+   * An array of label filters.
+   */
   labelFilters?: AlertRuleQueryLabelFilters[];
   markTags?: AlertRuleQueryMarkTags[];
   /**
    * @remarks
-   * 指标名。
+   * The name of the metric.
    * 
    * @example
    * memory
@@ -463,7 +531,7 @@ export class AlertRuleQuery extends $dara.Model {
   metric?: string;
   /**
    * @remarks
-   * 监控指标集合。
+   * The collection of metrics.
    * 
    * @example
    * cpu_usage
@@ -472,7 +540,8 @@ export class AlertRuleQuery extends $dara.Model {
   /**
    * @remarks
    * Applicable query type: CMS_BASIC_QUERY.
-   * Namespace of the metric.
+   * 
+   * The namespace of the metric.
    * 
    * @example
    * acs_ecs_dashboard
@@ -480,19 +549,24 @@ export class AlertRuleQuery extends $dara.Model {
   namespace?: string;
   /**
    * @remarks
-   * Applicable query types: SLS_MULTI_QUERY, APM_MULTI_QUERY.
-   * List of subqueries.
+   * Applicable query types: SLS_MULTI_QUERY and APM_MULTI_QUERY.
    * 
-   * 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.
+   * A list of subqueries.
+   * 
+   * For the SLS_MULTI_QUERY type, you can include up to three subqueries. 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.
+   * 
+   * The resource scope for the rule query. Valid values:
+   * 
+   * - USER: All resources under the user ID.
+   * 
+   * - GROUP: An application group.
+   * 
+   * - INSTANCE: A list of specified instances.
    * 
    * @example
    * USER
@@ -501,33 +575,40 @@ export class AlertRuleQuery extends $dara.Model {
   /**
    * @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]).
+   * 
+   * The configuration for the join operation on the result sets of subquery 2 (queries[2]) and subquery 3 (queries[3]).
    */
   secondJoin?: AlertRuleSlsQueryJoin;
   /**
    * @remarks
-   * Service ID list.
+   * A list of service IDs.
    */
   serviceIds?: string[];
   /**
    * @remarks
-   * Query type.
+   * The query type.
    * 
    * Valid values:
    * 
-   * - PROMQL_QUERY: PromQL query
-   * - SLS_MULTI_QUERY: SLS query
-   * - APM_MULTI_QUERY: APM query
-   * - CMS_BASIC_QUERY: Basic CloudMonitor query
+   * - PROMQL_QUERY: A PromQL query.
+   * 
+   * - SLS_MULTI_QUERY: A Simple Log Service (SLS) query.
+   * 
+   * - APM_MULTI_QUERY: An APM 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.
+   * - CMS_BASIC_QUERY: A basic CloudMonitor query.
    * 
-   * The query type must match the data source type, with the following correspondences:
+   * Different query types have different valid parameters in the query object. For more information, see the "Applicable query type" description for each parameter.
+   * 
+   * The query type must match the data source type. The mappings are as follows:
    * 
    * - 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.
+   * 
+   * - Basic CloudMonitor data source (CMS_BASIC_DS): CMS_BASIC_QUERY
    * 
    * This parameter is required.
    *