@alicloud/cms20240330 9.2.2 → 10.0.1

package/src/models/GetAddonResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAddonResponseBodyDataDashboards extends $dara.Model {
   /**
+   * @remarks
+   * The description of the dashboard.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * The name of the dashboard.
+   * 
    * @example
    * rum_api_dot_metric_set
    */
   name?: string;
   /**
+   * @remarks
+   * The URL of the preview image.
+   * 
    * @example
    * http://iac-service-transfer.oss-cn-hangzhou.aliyuncs.com/78c5_288850010070719968_bdcf7cca781844c8ac4add133791713f
    */
@@ -44,7 +53,21 @@ export class GetAddonResponseBodyDataDashboards extends $dara.Model {
 }
 
 export class GetAddonResponseBodyDataEnvironmentsCommonSchemaRefs extends $dara.Model {
+  /**
+   * @remarks
+   * The group name of the common schema.
+   * 
+   * @example
+   * acs-ecs
+   */
   group?: string;
+  /**
+   * @remarks
+   * The version of the common schema.
+   * 
+   * @example
+   * 0.1.3
+   */
   version?: string;
   static names(): { [key: string]: string } {
     return {
@@ -70,8 +93,20 @@ export class GetAddonResponseBodyDataEnvironmentsCommonSchemaRefs extends $dara.
 }
 
 export class GetAddonResponseBodyDataEnvironmentsDependencies extends $dara.Model {
+  /**
+   * @remarks
+   * The dependencies on cluster types.
+   */
   clusterTypes?: string[];
+  /**
+   * @remarks
+   * The dependencies on probes.
+   */
   features?: { [key: string]: boolean };
+  /**
+   * @remarks
+   * The dependencies on activated services.
+   */
   services?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -108,6 +143,10 @@ export class GetAddonResponseBodyDataEnvironmentsDependencies extends $dara.Mode
 }
 
 export class GetAddonResponseBodyDataEnvironmentsPoliciesMetricCheckRule extends $dara.Model {
+  /**
+   * @remarks
+   * The data check rule that is used after installation.
+   */
   promQL?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -135,19 +174,35 @@ export class GetAddonResponseBodyDataEnvironmentsPoliciesMetricCheckRule extends
 
 export class GetAddonResponseBodyDataEnvironmentsPoliciesProtocols extends $dara.Model {
   /**
+   * @remarks
+   * The description of the protocol.
+   * 
    * @example
-   * Prometheus Metrics
+   * Support OpenTelemetry Protocol
    */
   description?: string;
   /**
+   * @remarks
+   * The URL of the icon.
+   * 
    * @example
    * icon URL
    */
   icon?: string;
+  /**
+   * @remarks
+   * The display name of the protocol.
+   * 
+   * @example
+   * OpenTelemetry
+   */
   label?: string;
   /**
+   * @remarks
+   * The name of the protocol.
+   * 
    * @example
-   * rum_api_dot_metric_set
+   * OpenTelemetry
    */
   name?: string;
   static names(): { [key: string]: string } {
@@ -179,28 +234,51 @@ export class GetAddonResponseBodyDataEnvironmentsPoliciesProtocols extends $dara
 
 export class GetAddonResponseBodyDataEnvironmentsPolicies extends $dara.Model {
   /**
+   * @remarks
+   * The status of the default policy for alert rules.
+   * 
    * @example
    * true
    */
   alertDefaultStatus?: string;
   /**
+   * @remarks
+   * Indicates whether the add-on is installed by default.
+   * 
    * @example
    * true
    */
   defaultInstall?: boolean;
   /**
+   * @remarks
+   * Indicates whether a service account is assigned for communication with the console API.
+   * 
    * @example
    * true
    */
   enableServiceAccount?: boolean;
+  /**
+   * @remarks
+   * The metric check rule.
+   */
   metricCheckRule?: GetAddonResponseBodyDataEnvironmentsPoliciesMetricCheckRule;
   /**
+   * @remarks
+   * Indicates whether to guide the user to restart pods after the add-on is installed.
+   * 
    * @example
    * true
    */
   needRestartAfterIntegration?: boolean;
+  /**
+   * @remarks
+   * The protocol.
+   */
   protocols?: GetAddonResponseBodyDataEnvironmentsPoliciesProtocols[];
   /**
+   * @remarks
+   * The name of the target add-on to which the system redirects.
+   * 
    * @example
    * cs-default
    */
@@ -245,26 +323,57 @@ export class GetAddonResponseBodyDataEnvironmentsPolicies extends $dara.Model {
 }
 
 export class GetAddonResponseBodyDataEnvironments extends $dara.Model {
+  /**
+   * @remarks
+   * The list of associated common schemas.
+   */
   commonSchemaRefs?: GetAddonResponseBodyDataEnvironmentsCommonSchemaRefs[];
+  /**
+   * @remarks
+   * The dependencies.
+   */
   dependencies?: GetAddonResponseBodyDataEnvironmentsDependencies;
   /**
+   * @remarks
+   * The description.
+   * 
    * @example
    * Observability integration.
    */
   description?: string;
   /**
+   * @remarks
+   * Indicates whether the feature is enabled.
+   * 
    * @example
    * false
    */
   enable?: boolean;
+  /**
+   * @remarks
+   * The display name of the environment.
+   * 
+   * @example
+   * 容器环境
+   */
   label?: string;
   /**
+   * @remarks
+   * The name of the add-on.
+   * 
    * @example
    * cs-default-umodel-1752755202744_k8s.metric.high_level_metric_deployment_cn-hangzhou/c0a686118449c4390b9cc0a07ea3e0e85
    */
   name?: string;
+  /**
+   * @remarks
+   * The ID of the resource group.
+   */
   policies?: GetAddonResponseBodyDataEnvironmentsPolicies;
   /**
+   * @remarks
+   * The type of the integration policy.
+   * 
    * @example
    * CS
    */
@@ -315,55 +424,101 @@ export class GetAddonResponseBodyDataEnvironments extends $dara.Model {
 
 export class GetAddonResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The alias of the component.
+   * 
    * @example
    * resume_vector_alias
    */
   alias?: string;
+  /**
+   * @remarks
+   * The list of component categories.
+   */
   categories?: string[];
+  /**
+   * @remarks
+   * The list of dashboards.
+   */
   dashboards?: GetAddonResponseBodyDataDashboards[];
   /**
+   * @remarks
+   * The description of the add-on.
+   * 
    * @example
    * o11y-demo-cn-heyuan
    */
   description?: string;
+  /**
+   * @remarks
+   * The environment information.
+   */
   environments?: GetAddonResponseBodyDataEnvironments[];
   /**
+   * @remarks
+   * The URL of the icon.
+   * 
    * @example
-   * icon URL
+   * https://xxxxx
    */
   icon?: string;
+  /**
+   * @remarks
+   * The keywords.
+   */
   keywords?: string[];
   /**
+   * @remarks
+   * The language.
+   * 
    * @example
    * zh
    */
   language?: string;
   /**
+   * @remarks
+   * The time when the latest version was created.
+   * 
    * @example
    * 2023-09-12 12:30:30
    */
   latestReleaseCreateTime?: string;
   /**
+   * @remarks
+   * The name of the add-on.
+   * 
    * @example
    * rum_api_dashboard_explorer_link_metric_set
    */
   name?: string;
   /**
+   * @remarks
+   * Indicates whether the add-on can be installed only once.
+   * 
    * @example
    * true
    */
   once?: boolean;
   /**
+   * @remarks
+   * The scenario of the component.
+   * 
    * @example
    * middleware
    */
   scene?: string;
   /**
+   * @remarks
+   * The version of the component.
+   * 
    * @example
    * *
    */
   version?: string;
   /**
+   * @remarks
+   * The weight.
+   * 
    * @example
    * 10
    */
@@ -428,10 +583,14 @@ export class GetAddonResponseBodyData extends $dara.Model {
 }
 
 export class GetAddonResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data returned.
+   */
   data?: GetAddonResponseBodyData;
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8

package/src/models/GetAddonSchemaRequest.ts

@@ -4,12 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAddonSchemaRequest extends $dara.Model {
   /**
+   * @remarks
+   * The language of the response. Valid values: \\`zh\\` and \\`en\\`. The default value is \\`zh\\`.
+   * 
    * @example
    * zh
    */
   aliyunLang?: string;
+  /**
+   * @remarks
+   * The environment type. Valid values: \\`CS\\` (container) and \\`ECS\\`.
+   * 
+   * @example
+   * CS
+   */
   environmentType?: string;
   /**
+   * @remarks
+   * The version of the component.
+   * 
    * @example
    * 0.1.1
    */

package/src/models/GetAddonSchemaResponseBody.ts

@@ -4,15 +4,35 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAddonSchemaResponseBodyFieldsConditions extends $dara.Model {
   /**
+   * @remarks
+   * The control mode of the field.
+   * 
    * @example
-   * redeploy
+   * show
    */
   action?: string;
+  /**
+   * @remarks
+   * The name of the field.
+   * 
+   * @example
+   * store.storageTarget
+   */
   field?: string;
+  /**
+   * @remarks
+   * The operator for the condition.
+   * 
+   * @example
+   * ==
+   */
   op?: string;
   /**
+   * @remarks
+   * The target value for the condition.
+   * 
    * @example
-   * [{\\"count\\": \\"1\\", \\"max\\": \\"358.106\\", \\"sum\\": \\"358.106\\", \\"ts\\": \\"1755049815000000\\", \\"min\\": \\"358.106\\"}, {\\"count\\": \\"1\\", \\"max\\": \\"326.311\\", \\"sum\\": \\"326.311\\", \\"ts\\": \\"1755049830000000\\", \\"min\\": \\"326.311\\"}]
+   * Custom
    */
   value?: any;
   static names(): { [key: string]: string } {
@@ -43,10 +63,20 @@ export class GetAddonSchemaResponseBodyFieldsConditions extends $dara.Model {
 }
 
 export class GetAddonSchemaResponseBodyFieldsPropsDataSource extends $dara.Model {
+  /**
+   * @remarks
+   * The label.
+   * 
+   * @example
+   * tagKey
+   */
   label?: string;
   /**
+   * @remarks
+   * The value of the label.
+   * 
    * @example
-   * []
+   * tagValue
    */
   value?: string;
   static names(): { [key: string]: string } {
@@ -75,10 +105,21 @@ export class GetAddonSchemaResponseBodyFieldsPropsDataSource extends $dara.Model
 export class GetAddonSchemaResponseBodyFieldsProps extends $dara.Model {
   /**
    * @remarks
-   * AK
+   * The information about the data source.
    */
   dataSource?: GetAddonSchemaResponseBodyFieldsPropsDataSource[];
+  /**
+   * @remarks
+   * A collection of related data.
+   */
   related?: string[];
+  /**
+   * @remarks
+   * The mode.
+   * 
+   * @example
+   * single
+   */
   selectMode?: string;
   static names(): { [key: string]: string } {
     return {
@@ -112,16 +153,61 @@ export class GetAddonSchemaResponseBodyFieldsProps extends $dara.Model {
 }
 
 export class GetAddonSchemaResponseBodyFieldsValidation extends $dara.Model {
+  /**
+   * @remarks
+   * The maximum value. The value is inclusive.
+   * 
+   * @example
+   * 2000
+   */
   max?: number;
+  /**
+   * @remarks
+   * The maximum length that is supported by the text control.
+   * 
+   * @example
+   * 100
+   */
   maxLength?: number;
   /**
+   * @remarks
+   * The details.
+   * 
    * @example
-   * ok
+   * length limit
    */
   message?: string;
+  /**
+   * @remarks
+   * The minimum value.
+   * 
+   * @example
+   * 0
+   */
   min?: number;
+  /**
+   * @remarks
+   * The minimum length.
+   * 
+   * @example
+   * 16
+   */
   minLength?: number;
+  /**
+   * @remarks
+   * The regular expression.
+   * 
+   * @example
+   * ^(http|https)://
+   */
   regular?: string;
+  /**
+   * @remarks
+   * Specifies whether the parameter is required.
+   * 
+   * @example
+   * false
+   */
   required?: boolean;
   static names(): { [key: string]: string } {
     return {
@@ -157,29 +243,92 @@ export class GetAddonSchemaResponseBodyFieldsValidation extends $dara.Model {
 }
 
 export class GetAddonSchemaResponseBodyFields extends $dara.Model {
+  /**
+   * @remarks
+   * A list of display conditions.
+   */
   conditions?: GetAddonSchemaResponseBodyFieldsConditions[];
+  /**
+   * @remarks
+   * The default value.
+   * 
+   * @example
+   * mysql.default
+   */
   defaultValue?: any;
   /**
+   * @remarks
+   * The description.
+   * 
    * @example
-   * o11y-demo-cn-heyuan
+   * MySQL datasource
    */
   description?: string;
+  /**
+   * @remarks
+   * Specifies whether the field is hidden. Valid values: \\`true\\` (hidden) and \\`false\\` (displayed).
+   * 
+   * @example
+   * false
+   */
   disabled?: boolean;
+  /**
+   * @remarks
+   * The type of the element.
+   * 
+   * @example
+   * input
+   */
   element?: string;
+  /**
+   * @remarks
+   * The path of the field.
+   * 
+   * @example
+   * mysql.host
+   */
   fieldPath?: string;
+  /**
+   * @remarks
+   * The display name of the field.
+   * 
+   * @example
+   * mysql
+   */
   label?: string;
   /**
+   * @remarks
+   * The name of the field.
+   * 
    * @example
-   * rum_api_dashboard_explorer_link_metric_set
+   * host
    */
   name?: string;
+  /**
+   * @remarks
+   * The placeholder text.
+   * 
+   * @example
+   * Please enter the metrics collection interval
+   */
   placeholder?: string;
+  /**
+   * @remarks
+   * Other properties of the component.
+   */
   props?: GetAddonSchemaResponseBodyFieldsProps;
   /**
+   * @remarks
+   * The type of the field.
+   * 
    * @example
-   * xtrace
+   * string
    */
   type?: string;
+  /**
+   * @remarks
+   * The validation rule for the field.
+   */
   validation?: GetAddonSchemaResponseBodyFieldsValidation;
   static names(): { [key: string]: string } {
     return {
@@ -234,15 +383,25 @@ export class GetAddonSchemaResponseBodyFields extends $dara.Model {
 }
 
 export class GetAddonSchemaResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * A list of data table fields.
+   */
   fields?: GetAddonSchemaResponseBodyFields[];
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * E5B1D3D4-BB28-5996-8AD2-***********
    */
   requestId?: string;
   /**
+   * @remarks
+   * The type of the schema.
+   * 
    * @example
-   * response_time
+   * common
    */
   type?: string;
   static names(): { [key: string]: string } {