@alicloud/cms20240330 9.2.2 → 10.0.0

package/src/models/ListAddonsResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListAddonsResponseBodyAddonsDashboards extends $dara.Model {
   /**
+   * @remarks
+   * Dashboard description.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * Dashboard name.
+   * 
    * @example
    * rum_view_link_rum_api
    */
   name?: string;
   /**
+   * @remarks
+   * The URL of the dashboard\\"s preview image.
+   * 
    * @example
    * http://xxxxxxx
    */
@@ -45,11 +54,17 @@ export class ListAddonsResponseBodyAddonsDashboards extends $dara.Model {
 
 export class ListAddonsResponseBodyAddonsEnvironmentsCommonSchemaRefs 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.4
    */
@@ -78,8 +93,20 @@ export class ListAddonsResponseBodyAddonsEnvironmentsCommonSchemaRefs extends $d
 }
 
 export class ListAddonsResponseBodyAddonsEnvironmentsDependencies extends $dara.Model {
+  /**
+   * @remarks
+   * Supported cluster types.
+   */
   clusterTypes?: string[];
+  /**
+   * @remarks
+   * The probes on which the integration depends.
+   */
   features?: { [key: string]: boolean };
+  /**
+   * @remarks
+   * A list of dependent services.
+   */
   services?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -116,6 +143,10 @@ export class ListAddonsResponseBodyAddonsEnvironmentsDependencies extends $dara.
 }
 
 export class ListAddonsResponseBodyAddonsEnvironmentsPoliciesMetricCheckRule extends $dara.Model {
+  /**
+   * @remarks
+   * A list of Prometheus Query Language (PromQL) statements.
+   */
   promQL?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -143,21 +174,33 @@ export class ListAddonsResponseBodyAddonsEnvironmentsPoliciesMetricCheckRule ext
 
 export class ListAddonsResponseBodyAddonsEnvironmentsPoliciesProtocols extends $dara.Model {
   /**
+   * @remarks
+   * Protocol description.
+   * 
    * @example
    * Support OpenTelemetry Protocal
    */
   description?: string;
   /**
+   * @remarks
+   * Icon URL.
+   * 
    * @example
    * http://xxxxxxx
    */
   icon?: string;
   /**
+   * @remarks
+   * Protocol display name.
+   * 
    * @example
    * OpenTelemetry
    */
   label?: string;
   /**
+   * @remarks
+   * Protocol name.
+   * 
    * @example
    * openTelemetry
    */
@@ -191,28 +234,51 @@ export class ListAddonsResponseBodyAddonsEnvironmentsPoliciesProtocols extends $
 
 export class ListAddonsResponseBodyAddonsEnvironmentsPolicies extends $dara.Model {
   /**
+   * @remarks
+   * The default status of the alert rule policy.
+   * 
    * @example
    * RUNNING
    */
   alertDefaultStatus?: string;
   /**
+   * @remarks
+   * Indicates whether the add-on is installed by default.
+   * 
    * @example
    * true
    */
   defaultInstall?: boolean;
   /**
+   * @remarks
+   * Indicates whether to assign a Service Account to communicate with the Console API.
+   * 
    * @example
    * true
    */
   enableServiceAccount?: boolean;
+  /**
+   * @remarks
+   * Metric check rule.
+   */
   metricCheckRule?: ListAddonsResponseBodyAddonsEnvironmentsPoliciesMetricCheckRule;
   /**
+   * @remarks
+   * Indicates whether to guide the user to restart pods after the add-on is installed.
+   * 
    * @example
    * true
    */
   needRestartAfterIntegration?: boolean;
+  /**
+   * @remarks
+   * The supported protocol types.
+   */
   protocols?: ListAddonsResponseBodyAddonsEnvironmentsPoliciesProtocols[];
   /**
+   * @remarks
+   * The name of the target add-on.
+   * 
    * @example
    * cloud-acs-ecs
    */
@@ -257,26 +323,57 @@ export class ListAddonsResponseBodyAddonsEnvironmentsPolicies extends $dara.Mode
 }
 
 export class ListAddonsResponseBodyAddonsEnvironments extends $dara.Model {
+  /**
+   * @remarks
+   * A list of associated Common Schemas.
+   */
   commonSchemaRefs?: ListAddonsResponseBodyAddonsEnvironmentsCommonSchemaRefs[];
+  /**
+   * @remarks
+   * A list of dependencies for the add-on.
+   */
   dependencies?: ListAddonsResponseBodyAddonsEnvironmentsDependencies;
   /**
+   * @remarks
+   * The description of the integration policy type.
+   * 
    * @example
    * o11y-demo-cn-heyuan
    */
   description?: string;
   /**
+   * @remarks
+   * Indicates whether the add-on is enabled.
+   * 
    * @example
    * false
    */
   enable?: boolean;
+  /**
+   * @remarks
+   * The label of the integration policy type.
+   * 
+   * @example
+   * 容器环境
+   */
   label?: string;
   /**
+   * @remarks
+   * The name of the integration policy type.
+   * 
    * @example
    * CS
    */
   name?: string;
+  /**
+   * @remarks
+   * Integration policy configuration.
+   */
   policies?: ListAddonsResponseBodyAddonsEnvironmentsPolicies;
   /**
+   * @remarks
+   * Integration Center policy type.
+   * 
    * @example
    * CS
    */
@@ -327,55 +424,101 @@ export class ListAddonsResponseBodyAddonsEnvironments extends $dara.Model {
 
 export class ListAddonsResponseBodyAddons extends $dara.Model {
   /**
+   * @remarks
+   * The alias of the add-on.
+   * 
    * @example
    * resume_vector_alias
    */
   alias?: string;
+  /**
+   * @remarks
+   * A list of tags for the add-on.
+   */
   categories?: string[];
+  /**
+   * @remarks
+   * A list of dashboards.
+   */
   dashboards?: ListAddonsResponseBodyAddonsDashboards[];
   /**
+   * @remarks
+   * Description
+   * 
    * @example
    * workspace api monitor test
    */
   description?: string;
+  /**
+   * @remarks
+   * A list of supported integration policy types.
+   */
   environments?: ListAddonsResponseBodyAddonsEnvironments[];
   /**
+   * @remarks
+   * The URL of the icon.
+   * 
    * @example
    * http://xxxxxxx
    */
   icon?: string;
+  /**
+   * @remarks
+   * A list of keywords.
+   */
   keywords?: string[];
   /**
+   * @remarks
+   * Language.
+   * 
    * @example
    * zh
    */
   language?: string;
   /**
+   * @remarks
+   * The time when the latest version was created.
+   * 
    * @example
    * 2025-09-03T03:15:56Z
    */
   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 display weight of the add-on.
+   * 
    * @example
    * 99
    */
@@ -440,6 +583,10 @@ export class ListAddonsResponseBodyAddons extends $dara.Model {
 }
 
 export class ListAddonsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * A list of available add-ons.
+   */
   addons?: ListAddonsResponseBodyAddons[];
   /**
    * @remarks

package/src/models/ListAggTaskGroupsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListAggTaskGroupsRequestTags extends $dara.Model {
   /**
    * @remarks
-   * Key of the resource group tag.
+   * The key of the resource group tag.
    * 
    * @example
    * key1
@@ -13,7 +13,7 @@ export class ListAggTaskGroupsRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Value of the resource group tag.
+   * The value of the resource group tag.
    * 
    * @example
    * value1
@@ -45,7 +45,7 @@ export class ListAggTaskGroupsRequestTags extends $dara.Model {
 export class ListAggTaskGroupsRequest extends $dara.Model {
   /**
    * @remarks
-   * List of IDs for the aggregation task groups, which must be JSON parseable.
+   * A list of aggregation task group IDs. The value must be a string that can be parsed as a JSON array.
    * 
    * @example
    * ["aggTaskGroup-xxx"]
@@ -53,7 +53,7 @@ export class ListAggTaskGroupsRequest extends $dara.Model {
   filterAggTaskGroupIds?: string;
   /**
    * @remarks
-   * List of names for the aggregation task groups, which must be JSON parseable.
+   * A list of aggregation task group names. The value must be a string that can be parsed as a JSON array.
    * 
    * @example
    * ["apiserver_request_total"]
@@ -61,7 +61,7 @@ export class ListAggTaskGroupsRequest extends $dara.Model {
   filterAggTaskGroupNames?: string;
   /**
    * @remarks
-   * Maximum number of records to return.
+   * The maximum number of entries to return on each page.
    * 
    * @example
    * 20
@@ -69,7 +69,7 @@ export class ListAggTaskGroupsRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * Query token.
+   * The token that is used to retrieve the next page of results.
    * 
    * @example
    * 28036394xxx
@@ -77,7 +77,7 @@ export class ListAggTaskGroupsRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * Name search, supports fuzzy matching.
+   * The name to search for. Fuzzy search is supported.
    * 
    * @example
    * test
@@ -85,7 +85,7 @@ export class ListAggTaskGroupsRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
-   * Status of the aggregation task group, either \\"Running\\" or \\"Stopped\\". Default is Running.
+   * The status of the aggregation task group. Valid values are \\`Running\\` and \\`Stopped\\`. The default value is \\`Running\\`.
    * 
    * @example
    * Running
@@ -93,12 +93,12 @@ export class ListAggTaskGroupsRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Resource group tags.
+   * The tags of the resource group.
    */
   tags?: ListAggTaskGroupsRequestTags[];
   /**
    * @remarks
-   * The target Prometheus instance ID for the aggregation task group.
+   * The ID of the target Prometheus instance for the aggregation task group.
    * 
    * @example
    * rw-pq4apob9jm

package/src/models/ListAggTaskGroupsResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   /**
    * @remarks
-   * Hash of the aggregation task group configuration.
+   * The summary of the aggregation task group configuration.
    * 
    * @example
    * a54136014xxx
@@ -13,7 +13,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   aggTaskGroupConfigHash?: string;
   /**
    * @remarks
-   * ID of the aggregation task group.
+   * The ID of the aggregation task group.
    * 
    * @example
    * aggTaskGroup-xxxx
@@ -21,7 +21,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   aggTaskGroupId?: string;
   /**
    * @remarks
-   * Name of the aggregation task group.
+   * The name of the aggregation task group.
    * 
    * @example
    * pipeline-aggtask-group
@@ -29,7 +29,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   aggTaskGroupName?: string;
   /**
    * @remarks
-   * Cron expression for the aggregation task group when the scheduling mode is set to \\"Cron\\".
+   * The scheduling expression for the aggregation task group when the scheduling mode is \\`Cron\\`.
    * 
    * @example
    * 0 10 8 1 * ? *
@@ -37,7 +37,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   cronExpr?: string;
   /**
    * @remarks
-   * Fixed delay time (in seconds) for scheduling.
+   * The fixed delay for scheduling, in seconds.
    * 
    * @example
    * 30
@@ -45,7 +45,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   delay?: number;
   /**
    * @remarks
-   * Description of the aggregation task group.
+   * The description of the aggregation task group.
    * 
    * @example
    * workspace api monitor update test
@@ -53,7 +53,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Start time of the schedule in seconds since epoch.
+   * The UNIX timestamp that indicates the scheduling start time.
    * 
    * @example
    * 1757409499000
@@ -61,7 +61,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   fromTime?: number;
   /**
    * @remarks
-   * Scheduling interval.
+   * The scheduling interval.
    * 
    * @example
    * 2025-04-24 00:00:00,2025-04-24 00:00:00
@@ -69,7 +69,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   interval?: string;
   /**
    * @remarks
-   * Maximum number of retries for the aggregation task.
+   * The maximum number of retries for an aggregation task.
    * 
    * @example
    * 2
@@ -77,7 +77,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   maxRetries?: number;
   /**
    * @remarks
-   * Maximum retry time (in seconds) for the aggregation task.
+   * The maximum retry duration for an aggregation task, in seconds.
    * 
    * @example
    * 200
@@ -85,7 +85,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   maxRunTimeInSeconds?: number;
   /**
    * @remarks
-   * Region ID.
+   * The region ID.
    * 
    * @example
    * cn-hangzhou
@@ -93,7 +93,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Scheduling mode.
+   * The scheduling mode.
    * 
    * @example
    * FixedRate
@@ -101,7 +101,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   scheduleMode?: string;
   /**
    * @remarks
-   * Scheduling time expression.
+   * The scheduling time expression.
    * 
    * @example
    * @m
@@ -109,7 +109,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   scheduleTimeExpr?: string;
   /**
    * @remarks
-   * The source Prometheus instance ID of the aggregation task group.
+   * The ID of the source Prometheus instance for the aggregation task group.
    * 
    * @example
    * rw-xxx
@@ -117,7 +117,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   sourcePrometheusId?: string;
   /**
    * @remarks
-   * Status of the aggregation task group.
+   * The status of the aggregation task group.
    * 
    * @example
    * Running
@@ -125,7 +125,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The target Prometheus instance ID of the aggregation task group.
+   * The ID of the target Prometheus instance for the aggregation task group.
    * 
    * @example
    * rw-xxx
@@ -133,7 +133,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   targetPrometheusId?: string;
   /**
    * @remarks
-   * The second-level timestamp corresponding to the end time of scheduling.
+   * The UNIX timestamp that indicates the scheduling end time.
    * 
    * @example
    * 0
@@ -141,7 +141,7 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
   toTime?: number;
   /**
    * @remarks
-   * Update time of the aggregation task group.
+   * The time when the aggregation task group was updated.
    * 
    * @example
    * 1757409499000
@@ -205,12 +205,12 @@ export class ListAggTaskGroupsResponseBodyAggTaskGroups extends $dara.Model {
 export class ListAggTaskGroupsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * List of aggregation task groups.
+   * A list of aggregation task groups.
    */
   aggTaskGroups?: ListAggTaskGroupsResponseBodyAggTaskGroups[];
   /**
    * @remarks
-   * The maximum number of records returned.
+   * The maximum number of entries returned.
    * 
    * @example
    * 100
@@ -218,7 +218,7 @@ export class ListAggTaskGroupsResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * Token for the next query.
+   * The token to use to retrieve the next page of results. This value is empty when there are no more results to return.
    * 
    * @example
    * aa9d0e569b880xxx
@@ -226,7 +226,7 @@ export class ListAggTaskGroupsResponseBody extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 7BF1F4D6-B9A8-5F0B-8C1D-4347FFCB798E
@@ -234,7 +234,7 @@ export class ListAggTaskGroupsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Total number of instances.
+   * The total number of entries.
    * 
    * @example
    * 5

package/src/models/ListAggTaskGroupsShrinkRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListAggTaskGroupsShrinkRequest extends $dara.Model {
   /**
    * @remarks
-   * List of IDs for the aggregation task groups, which must be JSON parseable.
+   * A list of aggregation task group IDs. The value must be a string that can be parsed as a JSON array.
    * 
    * @example
    * ["aggTaskGroup-xxx"]
@@ -13,7 +13,7 @@ export class ListAggTaskGroupsShrinkRequest extends $dara.Model {
   filterAggTaskGroupIds?: string;
   /**
    * @remarks
-   * List of names for the aggregation task groups, which must be JSON parseable.
+   * A list of aggregation task group names. The value must be a string that can be parsed as a JSON array.
    * 
    * @example
    * ["apiserver_request_total"]
@@ -21,7 +21,7 @@ export class ListAggTaskGroupsShrinkRequest extends $dara.Model {
   filterAggTaskGroupNames?: string;
   /**
    * @remarks
-   * Maximum number of records to return.
+   * The maximum number of entries to return on each page.
    * 
    * @example
    * 20
@@ -29,7 +29,7 @@ export class ListAggTaskGroupsShrinkRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * Query token.
+   * The token that is used to retrieve the next page of results.
    * 
    * @example
    * 28036394xxx
@@ -37,7 +37,7 @@ export class ListAggTaskGroupsShrinkRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * Name search, supports fuzzy matching.
+   * The name to search for. Fuzzy search is supported.
    * 
    * @example
    * test
@@ -45,7 +45,7 @@ export class ListAggTaskGroupsShrinkRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
-   * Status of the aggregation task group, either \\"Running\\" or \\"Stopped\\". Default is Running.
+   * The status of the aggregation task group. Valid values are \\`Running\\` and \\`Stopped\\`. The default value is \\`Running\\`.
    * 
    * @example
    * Running
@@ -53,12 +53,12 @@ export class ListAggTaskGroupsShrinkRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Resource group tags.
+   * The tags of the resource group.
    */
   tagsShrink?: string;
   /**
    * @remarks
-   * The target Prometheus instance ID for the aggregation task group.
+   * The ID of the target Prometheus instance for the aggregation task group.
    * 
    * @example
    * rw-pq4apob9jm