@alicloud/cms20240330 6.2.4 → 6.4.0

package/src/models/ChangeResourceGroupRequest.ts

@@ -4,25 +4,16 @@ import * as $dara from '@darabonba/typescript';
 
 export class ChangeResourceGroupRequest extends $dara.Model {
   /**
-   * @remarks
-   * The resource group ID.
-   * 
    * @example
    * rg-ae******ey
    */
   resourceGroupId?: string;
   /**
-   * @remarks
-   * The resource ID.
-   * 
    * @example
    * test
    */
   resourceId?: string;
   /**
-   * @remarks
-   * The resource type.
-   * 
    * @example
    * Service
    */

package/src/models/ChangeResourceGroupResponseBody.ts

@@ -4,9 +4,6 @@ import * as $dara from '@darabonba/typescript';
 
 export class ChangeResourceGroupResponseBody extends $dara.Model {
   /**
-   * @remarks
-   * The request ID.
-   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */

package/src/models/CmsEventForView.ts

@@ -4,27 +4,111 @@ import { EventResourceForEventView } from "./EventResourceForEventView";
 
 
 export class CmsEventForView extends $dara.Model {
+  /**
+   * @example
+   * { "description": "High load detected on server", "operator": "auto" }
+   */
   annotations?: { [key: string]: any };
+  /**
+   * @example
+   * { "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }
+   */
   data?: any;
+  /**
+   * @example
+   * "application/json"
+   */
   datacontenttype?: string;
+  /**
+   * @example
+   * "https://schema.alibabacloud.com/cms/alert/v1"
+   */
   dataschema?: string;
+  /**
+   * @example
+   * "dedup-abc123"
+   */
   dedupId?: string;
+  /**
+   * @example
+   * "event-1234567890"
+   */
   id?: string;
+  /**
+   * @example
+   * "integration-xyz"
+   */
   integrationUuid?: string;
+  /**
+   * @example
+   * {\\"source\\": \\"system\\"}
+   */
   labels?: { [key: string]: any };
+  /**
+   * @example
+   * 1743846610000
+   */
   receiveTime?: number;
   resource?: EventResourceForEventView;
+  /**
+   * @example
+   * "CRITICAL"
+   */
   severity?: string;
+  /**
+   * @example
+   * "ECS"
+   */
   source?: string;
+  /**
+   * @example
+   * "CloudMonitor"
+   */
   sourcetype?: string;
+  /**
+   * @example
+   * Running
+   */
   status?: string;
+  /**
+   * @example
+   * "Instance cpu usage exceeds threshold"
+   */
   subject?: string;
+  /**
+   * @example
+   * "HighCPUUsage"
+   */
   subtype?: string;
+  /**
+   * @example
+   * "sys-event-987654321"
+   */
   sysId?: string;
+  /**
+   * @example
+   * "2025-04-05T10:30:00Z"
+   */
   time?: string;
+  /**
+   * @example
+   * 1743846600000
+   */
   timestamp?: number;
+  /**
+   * @example
+   * "Alert"
+   */
   type?: string;
+  /**
+   * @example
+   * "ws-abc123"
+   */
   workspace?: string;
+  /**
+   * @example
+   * { "department": "finance", "project": "payment-gateway" }
+   */
   workspaceTags?: { [key: string]: any };
   static names(): { [key: string]: string } {
     return {

package/src/models/ContactForIncidentView.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ContactForIncidentView extends $dara.Model {
+  /**
+   * @example
+   * "contact-123456"
+   */
   contactId?: string;
   name?: string;
   static names(): { [key: string]: string } {

package/src/models/CreateAddonReleaseRequest.ts

@@ -6,7 +6,7 @@ import { EntityDiscoverRule } from "./EntityDiscoverRule";
 export class CreateAddonReleaseRequest extends $dara.Model {
   /**
    * @remarks
-   * The name of the add-on to integrate.
+   * The Addon name of the component that needs to be monitored.
    * 
    * This parameter is required.
    * 
@@ -16,7 +16,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   addonName?: string;
   /**
    * @remarks
-   * The language of the add-on.
+   * The language type of the component.
    * 
    * @example
    * zh
@@ -24,7 +24,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   aliyunLang?: string;
   /**
    * @remarks
-   * Specifies whether to perform a dry run. The default value is false.
+   * Whether it is a dry run, default is false.
    * 
    * @example
    * false
@@ -32,12 +32,12 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   dryRun?: boolean;
   /**
    * @remarks
-   * The entity discovery rules.
+   * Field rules
    */
   entityRules?: EntityDiscoverRule;
   /**
    * @remarks
-   * The environment type. Set this parameter to CS for container environments or ECS for ECS environments. For all other environment types, set this parameter to Cloud.
+   * Environment type. If the Policy type is CS and ECS, use accordingly; otherwise, it is unified as Cloud.
    * 
    * @example
    * CS
@@ -45,7 +45,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   envType?: string;
   /**
    * @remarks
-   * The ID of the parent AddonRelease.
+   * Parent AddonReleaseId.
    * 
    * @example
    * policy-xxxxxxxxxxx
@@ -53,7 +53,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   parentAddonReleaseId?: string;
   /**
    * @remarks
-   * The name of the release after the integration. If you do not specify this parameter, a default name is generated.
+   * The plugin name after access. If not specified, a default rule name will be generated.
    * 
    * @example
    * test-gpu-integration-name
@@ -61,7 +61,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   releaseName?: string;
   /**
    * @remarks
-   * The metadata.
+   * Input metadata.
    * 
    * @example
    * {"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}
@@ -69,7 +69,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   values?: string;
   /**
    * @remarks
-   * The version of the add-on to integrate.
+   * The version of the Addon component that needs to be monitored.
    * 
    * This parameter is required.
    * 
@@ -79,7 +79,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * The name of the workspace where the add-on is installed.
+   * The workspace name for installing the component resources.
    * 
    * @example
    * default

package/src/models/CreateAddonReleaseResponseBody.ts

@@ -6,7 +6,7 @@ import { EntityGroupBase } from "./EntityGroupBase";
 export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
   /**
    * @remarks
-   * The time when the phase first transitioned.
+   * First transition time.
    * 
    * @example
    * 2024-11-04T16:10:22+08:00
@@ -14,7 +14,7 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
   firstTransitionTime?: string;
   /**
    * @remarks
-   * The time when the phase last transitioned.
+   * Last transition time.
    * 
    * @example
    * 2024-11-04T16:10:22+08:00
@@ -22,7 +22,7 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
   lastTransitionTime?: string;
   /**
    * @remarks
-   * The details of the phase.
+   * Detailed information.
    * 
    * @example
    * The addon loaded successfully
@@ -30,7 +30,7 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
   message?: string;
   /**
    * @remarks
-   * The status of the phase.
+   * Phase status.
    * 
    * @example
    * {\\"phase\\": \\"Created\\", \\"executionDetails\\": [], \\"invocations\\": [], \\"latestExecError\\": {\\"message\\": \\"\\", \\"code\\": \\"\\", \\"requestId\\": \\"\\", \\"extraInfo\\": \\"\\", \\"title\\": \\"\\"}}
@@ -38,7 +38,7 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
   status?: string;
   /**
    * @remarks
-   * The type of the phase.
+   * Phase type.
    * 
    * @example
    * Loaded
@@ -76,7 +76,7 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
 export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   /**
    * @remarks
-   * The name of the integrated add-on.
+   * The Addon name of the component being monitored.
    * 
    * @example
    * cs-gpu
@@ -84,7 +84,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   addonName?: string;
   /**
    * @remarks
-   * The number of alert rules.
+   * Number of alert groups.
    * 
    * @example
    * 6
@@ -92,12 +92,12 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   alertRuleCount?: number;
   /**
    * @remarks
-   * The information about the add-on installation phases.
+   * Component installation phase information.
    */
   conditions?: CreateAddonReleaseResponseBodyReleaseConditions[];
   /**
    * @remarks
-   * The configuration of the add-on.
+   * Component configuration.
    * 
    * @example
    * {"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}
@@ -105,7 +105,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * The time when the add-on was integrated.
+   * Connection time.
    * 
    * @example
    * 2024-11-05T15:21:30+08:00
@@ -113,7 +113,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The number of dashboards.
+   * Number of dashboards.
    * 
    * @example
    * 3
@@ -121,12 +121,12 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   dashboardCount?: number;
   /**
    * @remarks
-   * The details of the entity.
+   * Entity details.
    */
   entityRules?: EntityGroupBase;
   /**
    * @remarks
-   * The environment type.
+   * Environment type.
    * 
    * @example
    * CS
@@ -134,7 +134,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   envType?: string;
   /**
    * @remarks
-   * The environment ID.
+   * Environment ID.
    * 
    * @example
    * policy-xxxxxxxxxxx
@@ -142,7 +142,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * The number of exporters.
+   * Number of plugins.
    * 
    * @example
    * 2
@@ -150,7 +150,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   exporterCount?: number;
   /**
    * @remarks
-   * Indicates whether a configuration is available.
+   * Whether it has configuration.
    * 
    * @example
    * true
@@ -158,7 +158,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   haveConfig?: boolean;
   /**
    * @remarks
-   * The ID of the user who installed the add-on.
+   * ID of the user who installed it.
    * 
    * @example
    * 1654218965xxxxxx
@@ -166,7 +166,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   installUserId?: string;
   /**
    * @remarks
-   * The language.
+   * Language.
    * 
    * @example
    * zh
@@ -174,7 +174,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   language?: string;
   /**
    * @remarks
-   * Indicates whether the add-on is a managed add-on.
+   * Whether it is a managed component.
    * 
    * @example
    * true
@@ -182,7 +182,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   managed?: boolean;
   /**
    * @remarks
-   * The ID of the parent AddonRelease.
+   * Parent AddonReleaseId.
    * 
    * @example
    * policy-xxxxxxxxxxx
@@ -190,7 +190,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   parentAddonReleaseId?: string;
   /**
    * @remarks
-   * The ID of the environment policy.
+   * Policy environment ID.
    * 
    * @example
    * policy-xxxxxxxxxx
@@ -198,7 +198,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   policyId?: string;
   /**
    * @remarks
-   * The region ID.
+   * Region ID.
    * 
    * @example
    * cn-hangzhou
@@ -206,7 +206,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * The ID of the release.
+   * ReleaseID after installation.
    * 
    * @example
    * 2e898e60-5e6a-46d1-a994-xxxxxxxxxx
@@ -214,7 +214,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   releaseId?: string;
   /**
    * @remarks
-   * The name of the release.
+   * Name of the Release.
    * 
    * @example
    * test-gpu-integration-name
@@ -222,7 +222,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   releaseName?: string;
   /**
    * @remarks
-   * The scenario of the add-on.
+   * Component scenario.
    * 
    * @example
    * 1
@@ -230,7 +230,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   scene?: string;
   /**
    * @remarks
-   * The status of the add-on.
+   * Component status.
    * 
    * @example
    * 200
@@ -238,7 +238,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The time when the add-on was last updated.
+   * Update time.
    * 
    * @example
    * 2024-09-13T02:21:02Z
@@ -246,7 +246,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * The user ID.
+   * ID of the owner user.
    * 
    * @example
    * 165421896xxxxxx
@@ -254,7 +254,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   userId?: string;
   /**
    * @remarks
-   * The version of the add-on.
+   * Component version.
    * 
    * @example
    * 1.0.0
@@ -262,7 +262,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * The workspace.
+   * Workspace.
    * 
    * @example
    * default
@@ -346,12 +346,12 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
 export class CreateAddonReleaseResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the integrated add-on.
+   * Accessed component information.
    */
   release?: CreateAddonReleaseResponseBodyRelease;
   /**
    * @remarks
-   * The request ID.
+   * Request ID.
    * 
    * @example
    * 0CEC5375-C554-562B-A65F-9A629907C1F0

package/src/models/CreateAggTaskGroupRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAggTaskGroupRequestTags extends $dara.Model {
   /**
    * @remarks
-   * The key of the resource group tag.
+   * Key of the resource group tag.
    * 
    * @example
    * key1
@@ -13,7 +13,7 @@ export class CreateAggTaskGroupRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * The value of the resource group tag.
+   * Value of the resource group tag.
    * 
    * @example
    * value1
@@ -45,8 +45,8 @@ export class CreateAggTaskGroupRequestTags extends $dara.Model {
 export class CreateAggTaskGroupRequest extends $dara.Model {
   /**
    * @remarks
-   * The configuration of the aggregation task group.
-   * Only the \\`RecordingRuleYaml\\` format is supported. The configuration must follow the format of RecordingRule for open source Prometheus.
+   * Aggregation task group configuration.
+   * Currently, only the “RecordingRuleYaml” format is supported, which must comply with the format requirements of open-source Prometheus RecordingRules.
    * 
    * This parameter is required.
    * 
@@ -62,7 +62,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   aggTaskGroupConfig?: string;
   /**
    * @remarks
-   * The type of the aggregation task group configuration. The default value is \\`RecordingRuleYaml\\`. This is the format of RecordingRule for open source Prometheus.
+   * Aggregation task group configuration type, default is “RecordingRuleYaml” (open-source Prometheus RecordingRule format).
    * 
    * @example
    * RecordingRuleYaml
@@ -70,7 +70,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   aggTaskGroupConfigType?: string;
   /**
    * @remarks
-   * The name of the aggregation task group.
+   * Aggregation task group name.
    * 
    * This parameter is required.
    * 
@@ -80,7 +80,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   aggTaskGroupName?: string;
   /**
    * @remarks
-   * The cron expression for scheduling when \\`scheduleMode\\` is set to \\`Cron\\`. For example, \\`0/1 \\* \\* \\* \\*\\` indicates that the task is scheduled every minute, starting from minute 0.
+   * When the scheduling mode is selected as “Cron”, this is the specific scheduling expression. For example, “0/1 * * * *” means starting from 0 minutes and scheduling every 1 minute.
    * 
    * @example
    * 0/1 * * * *
@@ -88,7 +88,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   cronExpr?: string;
   /**
    * @remarks
-   * The fixed delay for scheduling. Unit: seconds. The default value is 30.
+   * Fixed delay time for scheduling, in seconds, default is 30.
    * 
    * @example
    * 30
@@ -96,7 +96,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   delay?: number;
   /**
    * @remarks
-   * The description of the aggregation task group.
+   * Description of the aggregation task group.
    * 
    * @example
    * desc
@@ -104,7 +104,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The UNIX timestamp for the scheduling start time. Unit: seconds.
+   * The second-level timestamp corresponding to the start time of the schedule.
    * 
    * @example
    * 1724996015
@@ -112,7 +112,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   fromTime?: number;
   /**
    * @remarks
-   * The maximum number of retries for an aggregation task. The default value is 20.
+   * Maximum number of retries for executing the aggregation task, default is 20.
    * 
    * @example
    * 20
@@ -120,7 +120,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   maxRetries?: number;
   /**
    * @remarks
-   * The maximum retry time for an aggregation task. Unit: seconds. The default value is 600.
+   * Maximum retry time for executing the aggregation task, in seconds, default is 600.
    * 
    * @example
    * 600
@@ -128,7 +128,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   maxRunTimeInSeconds?: number;
   /**
    * @remarks
-   * The dry run configuration. This parameter is not configured by default. The input string must be a parsable JSON string.
+   * Pre-check configuration, no configuration by default. The input string needs to be correctly parsed as JSON.
    * 
    * @example
    * {"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\\"_arms/kubelet/cadvisor\\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"}
@@ -136,7 +136,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   precheckString?: string;
   /**
    * @remarks
-   * The scheduling mode. Valid values: \\`Cron\\` and \\`FixedRate\\`. The default value is \\`FixedRate\\`.
+   * Scheduling mode, either “Cron” or “FixedRate”, default is “FixedRate”.
    * 
    * @example
    * FixedRate
@@ -144,7 +144,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   scheduleMode?: string;
   /**
    * @remarks
-   * The scheduling time expression. The recommended values are \\`@s\\` and \\`@m\\`. This expression specifies the granularity to which the time window is snapped. The default value is \\`@m\\`.
+   * Scheduling time expression, recommended “@s” or “@m”, indicating the alignment granularity of the scheduling time window, default is “@m”.
    * 
    * @example
    * @m
@@ -152,7 +152,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   scheduleTimeExpr?: string;
   /**
    * @remarks
-   * The status of the aggregation task group. Valid values: \\`Running\\` and \\`Stopped\\`. The default value is \\`Running\\`.
+   * Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.
    * 
    * @example
    * Running
@@ -160,12 +160,12 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The tags of the resource group.
+   * Resource group tags.
    */
   tags?: CreateAggTaskGroupRequestTags[];
   /**
    * @remarks
-   * The ID of the target Prometheus instance for the aggregation task group.
+   * The target Prometheus instance ID of the aggregation task group.
    * 
    * This parameter is required.
    * 
@@ -175,7 +175,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   targetPrometheusId?: string;
   /**
    * @remarks
-   * The UNIX timestamp for the scheduling end time. Unit: seconds. A value of 0 means that scheduling does not stop.
+   * The second-level timestamp corresponding to the end time of the schedule, 0 indicates that the scheduling does not stop.
    * 
    * @example
    * 0
@@ -183,7 +183,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   toTime?: number;
   /**
    * @remarks
-   * Specifies whether to overwrite an existing resource with the same name.
+   * Whether to overwrite and update if a resource with the same name exists when creating an aggregation task group.
    * 
    * @example
    * true