@alicloud/cms20240330 9.2.1 → 10.0.0

package/src/models/CmsEventForView.ts

@@ -5,107 +5,174 @@ import { EventResourceForEventView } from "./EventResourceForEventView";
 
 export class CmsEventForView extends $dara.Model {
   /**
+   * @remarks
+   * Additional annotations for the event. This is an unstructured description field.
+   * 
    * @example
    * { "description": "High load detected on server", "operator": "auto" }
    */
   annotations?: { [key: string]: any };
   /**
+   * @remarks
+   * The raw data of the event. The format depends on the event type and dataschema.
+   * 
    * @example
    * { "metricName": "cpu_usage", "value": 95.2, "threshold": 80 }
    */
   data?: any;
   /**
+   * @remarks
+   * The content type of the data field.
+   * 
    * @example
    * "application/json"
    */
   datacontenttype?: string;
   /**
+   * @remarks
+   * The data schema definition, which describes the structure of the data field.
+   * 
    * @example
    * "https://schema.alibabacloud.com/cms/alert/v1"
    */
   dataschema?: string;
   /**
+   * @remarks
+   * The deduplication ID. It identifies different instances of the same event, such as a repeatedly reported event.
+   * 
    * @example
    * "dedup-abc123"
    */
   dedupId?: string;
   /**
+   * @remarks
+   * The unique identifier for the event. The system generates this globally unique ID.
+   * 
    * @example
    * "event-1234567890"
    */
   id?: string;
   /**
+   * @remarks
+   * The unique integration identifier. It is used for identity recognition in cross-system integrations.
+   * 
    * @example
    * "integration-xyz"
    */
   integrationUuid?: string;
   /**
+   * @remarks
+   * The key-value pairs of the event labels.
+   * 
    * @example
    * {\\"source\\": \\"system\\"}
    */
   labels?: { [key: string]: any };
   /**
+   * @remarks
+   * The timestamp when the event was received and processed.
+   * 
    * @example
    * 1743846610000
    */
   receiveTime?: number;
+  /**
+   * @remarks
+   * Information about the resource associated with the event, such as the instance ID, IP address, and region.
+   */
   resource?: EventResourceForEventView;
   /**
+   * @remarks
+   * The severity level of the event.
+   * 
    * @example
    * "CRITICAL"
    */
   severity?: string;
   /**
+   * @remarks
+   * The name of the source system or service, such as ECS, RDS, or VPC.
+   * 
    * @example
    * "ECS"
    */
   source?: string;
   /**
+   * @remarks
+   * The type of event source. It distinguishes between sources such as monitoring systems, Simple Log Service, and application observability.
+   * 
    * @example
    * "CloudMonitor"
    */
   sourcetype?: string;
   /**
+   * @remarks
+   * The current status of the event.
+   * 
    * @example
    * Running
    */
   status?: string;
   /**
+   * @remarks
+   * The subject or title of the event. It briefly describes the event.
+   * 
    * @example
    * "Instance cpu usage exceeds threshold"
    */
   subject?: string;
   /**
+   * @remarks
+   * The event subtype.
+   * 
    * @example
    * "HighCPUUsage"
    */
   subtype?: string;
   /**
+   * @remarks
+   * The internal system event ID. It is used for internal tracking and log association.
+   * 
    * @example
    * "sys-event-987654321"
    */
   sysId?: string;
   /**
+   * @remarks
+   * The time when the event occurred.
+   * 
    * @example
    * "2025-04-05T10:30:00Z"
    */
   time?: string;
   /**
+   * @remarks
+   * The timestamp of the event occurrence.
+   * 
    * @example
    * 1743846600000
    */
   timestamp?: number;
   /**
+   * @remarks
+   * The event type.
+   * 
    * @example
    * "Alert"
    */
   type?: string;
   /**
+   * @remarks
+   * The ID or name of the workspace. It is used for multi-tenant or organization fencing.
+   * 
    * @example
    * "ws-abc123"
    */
   workspace?: string;
   /**
+   * @remarks
+   * The workspace tags. They help you manage events by tag.
+   * 
    * @example
    * { "department": "finance", "project": "payment-gateway" }
    */

package/src/models/ConditionConfigUnified.ts

@@ -7,47 +7,47 @@ import { ApmThresholdConfig } from "./ApmThresholdConfig";
 export class ConditionConfigUnified extends $dara.Model {
   /**
    * @remarks
-   * 聚合函数（APM_SIMPLE_CONDITION）
+   * The aggregation method for metric data points over the evaluation period. Valid values include `AVG`, `SUM`, and `MAX`.
    */
   aggregate?: string;
   /**
    * @remarks
-   * 多条比较（APM_COMPOSITE_CONDITION）
+   * A list of composite comparison configurations for APM alerts. Each item is an `ApmCompositeCompareConfig` object.
    */
   compareList?: ApmCompositeCompareConfig[];
   /**
    * @remarks
-   * 持续时间（秒），PROMETHEUS_SIMPLE / UMODEL_METRICSET 使用
+   * The number of seconds a condition must be true before triggering an alert.
    */
   durationSecs?: number;
   /**
    * @remarks
-   * 比较操作符（UMODEL_METRICSET_CONDITION 或 APM_SIMPLE_CONDITION）
+   * The comparison operator used to evaluate the metric against the threshold.
    */
   operator?: string;
   /**
    * @remarks
-   * 条件间逻辑关系（APM_COMPOSITE_CONDITION）
+   * The logical relationship between multiple conditions. Valid values are `AND` and `OR`.
    */
   relation?: string;
   /**
    * @remarks
-   * 严重等级（UMODEL / PROMETHEUS_SIMPLE / APM_COMPOSITE）
+   * The alert severity. Valid values are `CRITICAL`, `WARNING`, and `INFO`.
    */
   severity?: string;
   /**
    * @remarks
-   * 阈值（UMODEL_METRICSET_CONDITION）
+   * The value against which the metric is evaluated to trigger an alert.
    */
   threshold?: number;
   /**
    * @remarks
-   * 多阈值列表（APM_SIMPLE_CONDITION）
+   * A list of threshold configurations for Application Performance Monitoring (APM) alerts. Each item is an `ApmThresholdConfig` object.
    */
   thresholdList?: ApmThresholdConfig[];
   /**
    * @remarks
-   * 检测条件类型
+   * The type of the alert condition.
    * 
    * This parameter is required.
    */

package/src/models/ContactForIncidentView.ts

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

package/src/models/CreateAddonReleaseRequest.ts

@@ -6,7 +6,7 @@ import { EntityDiscoverRule } from "./EntityDiscoverRule";
 export class CreateAddonReleaseRequest extends $dara.Model {
   /**
    * @remarks
-   * The Addon name of the component that needs to be monitored.
+   * The name of the add-on to integrate.
    * 
    * This parameter is required.
    * 
@@ -16,7 +16,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   addonName?: string;
   /**
    * @remarks
-   * The language type of the component.
+   * The language of the add-on.
    * 
    * @example
    * zh
@@ -24,7 +24,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   aliyunLang?: string;
   /**
    * @remarks
-   * Whether it is a dry run, default is false.
+   * Specifies whether to perform a dry run. The default value is false.
    * 
    * @example
    * false
@@ -32,12 +32,12 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   dryRun?: boolean;
   /**
    * @remarks
-   * Field rules
+   * The entity discovery rules.
    */
   entityRules?: EntityDiscoverRule;
   /**
    * @remarks
-   * Environment type. If the Policy type is CS and ECS, use accordingly; otherwise, it is unified as Cloud.
+   * 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.
    * 
    * @example
    * CS
@@ -45,7 +45,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   envType?: string;
   /**
    * @remarks
-   * Parent AddonReleaseId.
+   * The ID of the parent AddonRelease.
    * 
    * @example
    * policy-xxxxxxxxxxx
@@ -53,7 +53,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   parentAddonReleaseId?: string;
   /**
    * @remarks
-   * The plugin name after access. If not specified, a default rule name will be generated.
+   * The name of the release after the integration. If you do not specify this parameter, a default name is generated.
    * 
    * @example
    * test-gpu-integration-name
@@ -61,7 +61,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   releaseName?: string;
   /**
    * @remarks
-   * Input metadata.
+   * The 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 Addon component that needs to be monitored.
+   * The version of the add-on to integrate.
    * 
    * This parameter is required.
    * 
@@ -79,7 +79,7 @@ export class CreateAddonReleaseRequest extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * The workspace name for installing the component resources.
+   * The name of the workspace where the add-on is installed.
    * 
    * @example
    * default

package/src/models/CreateAddonReleaseResponseBody.ts

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