@alicloud/cms20240330 6.0.1 → 6.1.0

package/src/models/AlertRuleAlertMetricFilterDef.ts

@@ -3,8 +3,29 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class AlertRuleAlertMetricFilterDefSupportedOpts extends $dara.Model {
+  /**
+   * @remarks
+   * Display Name (Chinese).
+   * 
+   * @example
+   * Online
+   */
   displayNameCn?: string;
+  /**
+   * @remarks
+   * Display Name (English).
+   * 
+   * @example
+   * Online
+   */
   displayNameEn?: string;
+  /**
+   * @remarks
+   * Matching value.
+   * 
+   * @example
+   * online
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {
@@ -32,13 +53,66 @@ export class AlertRuleAlertMetricFilterDefSupportedOpts extends $dara.Model {
 }
 
 export class AlertRuleAlertMetricFilterDef extends $dara.Model {
+  /**
+   * @remarks
+   * Dimension in APM metrics.
+   * 
+   * @example
+   * status
+   */
   dim?: string;
+  /**
+   * @remarks
+   * When true, the filter item will not appear in the GROUP BY clause of the PromQL.
+   * 
+   * @example
+   * true
+   */
   dimDisabled?: boolean;
+  /**
+   * @remarks
+   * Display Name (Chinese).
+   * 
+   * @example
+   * Application Status
+   */
   displayNameCn?: string;
+  /**
+   * @remarks
+   * Display Name (English).
+   * 
+   * @example
+   * Application Status
+   */
   displayNameEn?: string;
+  /**
+   * @remarks
+   * Whether to hide. If hidden, it will not be displayed in the frontend UI, but its value can still be included when rendering the PromQL. A typical example is the "pid" filter condition in APM scenarios, which is generally not exposed through configurable UI elements but instead presented as a separate application search list in the frontend.
+   * 
+   * @example
+   * true
+   */
   hidden?: boolean;
+  /**
+   * @remarks
+   * When true, the filter item will not appear in the label filter of the PromQL.
+   * 
+   * @example
+   * true
+   */
   labelDisabled?: boolean;
+  /**
+   * @remarks
+   * Filter Condition Operator.
+   * 
+   * @example
+   * =
+   */
   opt?: string;
+  /**
+   * @remarks
+   * List of supported options.
+   */
   supportedOpts?: AlertRuleAlertMetricFilterDefSupportedOpts[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AlertRuleAlertMetricInput.ts

@@ -5,9 +5,31 @@ import { AlertRuleAlertMetricInputParamValue } from "./AlertRuleAlertMetricInput
 
 
 export class AlertRuleAlertMetricInput extends $dara.Model {
+  /**
+   * @remarks
+   * List of user-provided filter conditions. The supported parameters and filter conditions for the metric can be queried via ListAlertMetrics.
+   */
   filterValues?: AlertRuleAlertMetricInputFilterValue[];
+  /**
+   * @remarks
+   * Key of the metric group selected by the user.
+   * 
+   * @example
+   * apm.jvm
+   */
   groupId?: string;
+  /**
+   * @remarks
+   * Key of the predefined metric selected by the user.
+   * 
+   * @example
+   * appstat.jvm.GcPsMarkSweepCount
+   */
   metricId?: string;
+  /**
+   * @remarks
+   * List of input parameters. The metric\\"s supported parameters and filter conditions can be queried via ListAlertMetrics.
+   */
   paramValues?: AlertRuleAlertMetricInputParamValue[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AlertRuleAlertMetricInputFilterValue.ts

@@ -5,14 +5,31 @@ import * as $dara from '@darabonba/typescript';
 export class AlertRuleAlertMetricInputFilterValue extends $dara.Model {
   /**
    * @remarks
+   * Dimension of the filter condition.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * rootIp
    */
   dim?: string;
   /**
    * @remarks
+   * Filter Condition Operator.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * ALL
    */
   opt?: string;
+  /**
+   * @remarks
+   * Filter Condition Value.
+   * 
+   * @example
+   * 127.0.0.1
+   */
   value?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/AlertRuleAlertMetricInputParamValue.ts

@@ -6,11 +6,17 @@ export class AlertRuleAlertMetricInputParamValue extends $dara.Model {
   /**
    * @remarks
    * This parameter is required.
+   * 
+   * @example
+   * paramName
    */
   name?: string;
   /**
    * @remarks
    * This parameter is required.
+   * 
+   * @example
+   * paramValue
    */
   value?: string;
   static names(): { [key: string]: string } {

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 } {