@alicloud/cms20240330 9.2.1 → 10.0.0

package/src/models/ActionIntegrationConfig.ts

@@ -5,12 +5,12 @@ import * as $dara from '@darabonba/typescript';
 export class ActionIntegrationConfig extends $dara.Model {
   /**
    * @remarks
-   * 行动集成 ID 列表
+   * A list of actions to perform.
    */
   actions?: string[];
   /**
    * @remarks
-   * 是否启用行动集成
+   * Indicates whether action integration is enabled.
    */
   enabled?: boolean;
   static names(): { [key: string]: string } {

package/src/models/AddContextsRequest.ts

@@ -4,27 +4,46 @@ import * as $dara from '@darabonba/typescript';
 
 export class AddContextsRequestItems extends $dara.Model {
   /**
+   * @remarks
+   * The unique agent ID.
+   * 
    * @example
    * 952730733889060865
    */
   agentId?: string;
   /**
+   * @remarks
+   * The application ID.
+   * 
    * @example
    * mm_480d961a1b5e4efe84603f4cbc0f
    */
   appId?: string;
+  /**
+   * @remarks
+   * A list of categories to apply to the context item.
+   */
   categories?: string[];
   /**
+   * @remarks
+   * The content of the context item.
+   * 
    * @example
    * You are a conversation assistant.
    */
   content?: string;
   /**
+   * @remarks
+   * The custom instructions for processing the context.
+   * 
    * @example
    * Your custom instructions here
    */
   customInstructions?: string;
   /**
+   * @remarks
+   * An object containing experience information for the context.
+   * 
    * @example
    * {
    * 	"taskType": "troubleshooting",
@@ -34,39 +53,75 @@ export class AddContextsRequestItems extends $dara.Model {
    */
   experience?: { [key: string]: any };
   /**
+   * @remarks
+   * The expiration timestamp for the context item.
+   * 
    * @example
    * 1731231212334396
    */
   expirationDate?: string;
   /**
+   * @remarks
+   * Specifies whether the context item is immutable. If set to `true`, the item cannot be changed after it is created. The default value is `false`.
+   * 
    * @example
    * true
    */
   immutable?: boolean;
   /**
+   * @remarks
+   * Specifies whether to perform inference based on the context. The default value is `false`.
+   * 
    * @example
    * true
    */
   infer?: boolean;
+  /**
+   * @remarks
+   * A map of key-value pairs to apply as labels.
+   */
   labels?: { [key: string]: string };
+  /**
+   * @remarks
+   * An array of message objects.
+   */
   messages?: { [key: string]: any }[];
   /**
+   * @remarks
+   * Key-value pairs to store as metadata.
+   * 
    * @example
    * {"sessionId":"test_session_001"}
    */
   metadata?: { [key: string]: any };
   /**
+   * @remarks
+   * The run ID.
+   * 
    * @example
    * jr-80ded1d6953c64ea
    */
   runId?: string;
   /**
+   * @remarks
+   * The timestamp of the context item.
+   * 
    * @example
    * 1774578167
    */
   timestamp?: number;
+  /**
+   * @remarks
+   * The condition that triggers the context.
+   * 
+   * @example
+   * Identify and troubleshoot SLs issues
+   */
   triggerCondition?: string;
   /**
+   * @remarks
+   * The unique user ID.
+   * 
    * @example
    * test_user_001
    */
@@ -140,6 +195,8 @@ export class AddContextsRequestItems extends $dara.Model {
 export class AddContextsRequest extends $dara.Model {
   /**
    * @remarks
+   * The context type.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -148,10 +205,15 @@ export class AddContextsRequest extends $dara.Model {
   contextType?: string;
   /**
    * @remarks
+   * An array of context items.
+   * 
    * This parameter is required.
    */
   items?: AddContextsRequestItems[];
   /**
+   * @remarks
+   * The memory type.
+   * 
    * @example
    * short
    */

package/src/models/AddContextsResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class AddContextsResponseBodyResults extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the written record or event.
+   * 
    * @example
    * 897294a7-67a4-4f60-976c-e136edc5f97e
    */
   contextId?: string;
   /**
+   * @remarks
+   * The write status. Can be "accepted", "queued", or "created".
+   * 
    * @example
    * accepted
    */
@@ -38,10 +44,17 @@ export class AddContextsResponseBodyResults extends $dara.Model {
 
 export class AddContextsResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique ID for the request.
+   * 
    * @example
    * 0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8
    */
   requestId?: string;
+  /**
+   * @remarks
+   * An array of objects containing the results of the write operation.
+   */
   results?: AddContextsResponseBodyResults[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AddMemoriesRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class AddMemoriesRequestMessages extends $dara.Model {
   /**
+   * @remarks
+   * Content.
+   * 
    * @example
    * My name is Zhang San and I live in Hangzhou.
    */
   content?: string;
   /**
+   * @remarks
+   * Role.
+   * 
    * @example
    * user
    */
@@ -38,37 +44,62 @@ export class AddMemoriesRequestMessages extends $dara.Model {
 
 export class AddMemoriesRequest extends $dara.Model {
   /**
+   * @remarks
+   * Application agent ID.
+   * 
    * @example
    * 952730733889060865
    */
   agentId?: string;
   /**
+   * @remarks
+   * Application ID.
+   * 
    * @example
    * mm_480d961a1b5e4efe84603f4cbc0f
    */
   appId?: string;
   /**
+   * @remarks
+   * Asynchronous mode.
+   * 
    * @example
    * true
    */
   asyncMode?: boolean;
   /**
+   * @remarks
+   * Custom instructions.
+   * 
    * @example
    * Your custom instructions here
    */
   customInstructions?: string;
   /**
+   * @remarks
+   * Infer.
+   * 
    * @example
    * true
    */
   infer?: boolean;
+  /**
+   * @remarks
+   * Messages.
+   */
   messages?: AddMemoriesRequestMessages[];
   /**
+   * @remarks
+   * Metadata.
+   * 
    * @example
    * {"sessionId":"test_session_001"}
    */
   metadata?: { [key: string]: any };
   /**
+   * @remarks
+   * Run ID.
+   * 
    * @example
    * jr-80ded1d6953c64ea
    */
@@ -79,6 +110,9 @@ export class AddMemoriesRequest extends $dara.Model {
    */
   timestamp?: number;
   /**
+   * @remarks
+   * User ID.
+   * 
    * @example
    * test_user_001
    */

package/src/models/AddMemoriesResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class AddMemoriesResponseBodyResults extends $dara.Model {
   /**
+   * @remarks
+   * Event ID.
+   * 
    * @example
    * 897294a7-67a4-4f60-976c-e136edc5f97e
    */
   eventId?: string;
   /**
+   * @remarks
+   * Details.
+   * 
    * @example
    * Memory processing has been queued for background execution
    */
   message?: string;
   /**
+   * @remarks
+   * Processing status.
+   * 
    * @example
    * Pending
    */
@@ -45,10 +54,17 @@ export class AddMemoriesResponseBodyResults extends $dara.Model {
 
 export class AddMemoriesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Request results.
+   */
   results?: AddMemoriesResponseBodyResults[];
   static names(): { [key: string]: string } {
     return {

package/src/models/AddonMeta.ts

@@ -5,9 +5,26 @@ import * as $dara from '@darabonba/typescript';
 /**
  */
 export class AddonMetaDashboards extends $dara.Model {
+  /**
+   * @remarks
+   * The description.
+   * 
+   * @example
+   * 描述信息
+   */
   description?: string;
+  /**
+   * @remarks
+   * The name of the diagram.
+   * 
+   * @example
+   * ECS 监控概览大盘
+   */
   name?: string;
   /**
+   * @remarks
+   * The URL of the diagram.
+   * 
    * @example
    * assets/dashboards/ecs.png
    */
@@ -39,11 +56,17 @@ export class AddonMetaDashboards extends $dara.Model {
 
 export class AddonMetaEnvironmentsCommonSchemaRefs extends $dara.Model {
   /**
+   * @remarks
+   * The group name of the CommonSchema.
+   * 
    * @example
    * acs-ecs
    */
   group?: string;
   /**
+   * @remarks
+   * The group version of the CommonSchema.
+   * 
    * @example
    * 0.1.0
    */
@@ -72,8 +95,20 @@ export class AddonMetaEnvironmentsCommonSchemaRefs extends $dara.Model {
 }
 
 export class AddonMetaEnvironmentsDependencies extends $dara.Model {
+  /**
+   * @remarks
+   * The supported cluster types.
+   */
   clusterTypes?: string[];
+  /**
+   * @remarks
+   * The probe dependency description. This is the component name. In later versions, this field is replaced by the collectors field.
+   */
   features?: { [key: string]: boolean };
+  /**
+   * @remarks
+   * The list of dependent services.
+   */
   services?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -111,21 +146,33 @@ export class AddonMetaEnvironmentsDependencies extends $dara.Model {
 
 export class AddonMetaEnvironmentsPoliciesBindEntity extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether group mode is used.
+   * 
    * @example
    * true/false
    */
   entityGroupMode?: boolean;
   /**
+   * @remarks
+   * The entity type.
+   * 
    * @example
    * acs.ecs.instance
    */
   entityType?: string;
   /**
+   * @remarks
+   * Indicates whether single-entity mode is used.
+   * 
    * @example
    * true/false
    */
   singleEntityMode?: boolean;
   /**
+   * @remarks
+   * The field in the entity from which to fetch the VPC ID.
+   * 
    * @example
    * vpcId
    */
@@ -158,6 +205,10 @@ export class AddonMetaEnvironmentsPoliciesBindEntity extends $dara.Model {
 }
 
 export class AddonMetaEnvironmentsPoliciesMetricCheckRule extends $dara.Model {
+  /**
+   * @remarks
+   * The Prometheus Query Language (PromQL) for the check rule.
+   */
   promQL?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -184,14 +235,34 @@ export class AddonMetaEnvironmentsPoliciesMetricCheckRule extends $dara.Model {
 }
 
 export class AddonMetaEnvironmentsPoliciesProtocols extends $dara.Model {
+  /**
+   * @remarks
+   * The description of the protocol.
+   * 
+   * @example
+   * 使用 Prometheus 协议写入指标数据
+   */
   description?: string;
   /**
+   * @remarks
+   * The display icon for the protocol.
+   * 
    * @example
    * assets/logos/ecs.svg
    */
   icon?: string;
+  /**
+   * @remarks
+   * The display name of the protocol.
+   * 
+   * @example
+   * Prometheus 协议
+   */
   label?: string;
   /**
+   * @remarks
+   * The name of the protocol.
+   * 
    * @example
    * Prometheus
    */
@@ -225,34 +296,64 @@ export class AddonMetaEnvironmentsPoliciesProtocols extends $dara.Model {
 
 export class AddonMetaEnvironmentsPolicies extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the alert rule is enabled by default after installation.
+   * 
    * @example
    * RUNNING
    */
   alertDefaultStatus?: string;
   /**
+   * @remarks
+   * The default mode. This integration mode does not require attaching an entity.
+   * 
    * @example
    * true/false
    */
   bindDefaultPolicy?: boolean;
+  /**
+   * @remarks
+   * Information about the attached target entity.
+   */
   bindEntity?: AddonMetaEnvironmentsPoliciesBindEntity;
   /**
+   * @remarks
+   * Indicates whether the component is installed by default.
+   * 
    * @example
    * true/false
    */
   defaultInstall?: boolean;
   /**
+   * @remarks
+   * Indicates whether to enable internal authorization token allocation.
+   * 
    * @example
    * true/false
    */
   enableServiceAccount?: boolean;
+  /**
+   * @remarks
+   * The data check rule after the component is integrated.
+   */
   metricCheckRule?: AddonMetaEnvironmentsPoliciesMetricCheckRule;
   /**
+   * @remarks
+   * Indicates whether to prompt for a workload restart after integration.
+   * 
    * @example
    * true/false
    */
   needRestartAfterIntegration?: boolean;
+  /**
+   * @remarks
+   * The list of supported client protocols.
+   */
   protocols?: AddonMetaEnvironmentsPoliciesProtocols[];
   /**
+   * @remarks
+   * The name of the target component for redirection.
+   * 
    * @example
    * cloud-acs-ecs
    */
@@ -304,22 +405,57 @@ export class AddonMetaEnvironmentsPolicies extends $dara.Model {
 }
 
 export class AddonMetaEnvironments extends $dara.Model {
+  /**
+   * @remarks
+   * The list of attached CommonSchemas.
+   */
   commonSchemaRefs?: AddonMetaEnvironmentsCommonSchemaRefs[];
+  /**
+   * @remarks
+   * The dependency description.
+   */
   dependencies?: AddonMetaEnvironmentsDependencies;
+  /**
+   * @remarks
+   * The description of the environment type.
+   * 
+   * @example
+   * 支持容器集群的工作覆盖监控
+   */
   description?: string;
   /**
+   * @remarks
+   * Indicates whether the environment type is enabled.
+   * 
    * @example
    * true/false
    */
   enable?: boolean;
+  /**
+   * @remarks
+   * The display name of the environment type.
+   * 
+   * @example
+   * 容器环境
+   */
   label?: string;
   /**
+   * @remarks
+   * The name of the environment type.
+   * 
    * @example
    * CS/ECS/Cloud/Client
    */
   name?: string;
+  /**
+   * @remarks
+   * Information about the control policy group for the component.
+   */
   policies?: AddonMetaEnvironmentsPolicies;
   /**
+   * @remarks
+   * The policy type.
+   * 
    * @example
    * ECS
    */
@@ -369,52 +505,106 @@ export class AddonMetaEnvironments extends $dara.Model {
 }
 
 export class AddonMeta extends $dara.Model {
+  /**
+   * @remarks
+   * The alias of the component. This is the display name.
+   * 
+   * @example
+   * ECS 监控
+   */
   alias?: string;
+  /**
+   * @remarks
+   * The categorization information of the component.
+   */
   categories?: string[];
+  /**
+   * @remarks
+   * A list of component diagrams.
+   */
   dashboards?: AddonMetaDashboards[];
   /**
+   * @remarks
+   * The description.
+   * 
    * @example
    * The out-of-the-box and comprehensive ECS observe dashboards and alarm rules. Based on AliYun CloudMonitor agentless metrics, exporter agent metrics, host audit logs, host events and other data.
    */
   description?: string;
+  /**
+   * @remarks
+   * The list of supported environment types.
+   */
   environments?: AddonMetaEnvironments[];
   /**
+   * @remarks
+   * The icon of the component.
+   * 
    * @example
    * assets/logos/ecs.svg
    */
   icon?: string;
+  /**
+   * @remarks
+   * The list of keywords.
+   */
   keywords?: string[];
   /**
+   * @remarks
+   * The language. Valid values:
+   * 
+   * - zh: Chinese (default)
+   * 
+   * - en: English
+   * 
    * @example
    * zh
    */
   language?: string;
   /**
+   * @remarks
+   * The last time the component was integrated.
+   * 
    * @example
    * 2025-10-25 09:12:12
    */
   latestReleaseCreateTime?: string;
   /**
+   * @remarks
+   * The name of the component.
+   * 
    * @example
    * cloud-acs-ecs
    */
   name?: string;
   /**
+   * @remarks
+   * Indicates whether the component can be installed only once under a policy.
+   * 
    * @example
    * true/false
    */
   once?: boolean;
   /**
+   * @remarks
+   * The scenario.
+   * 
    * @example
    * feature
    */
   scene?: string;
   /**
+   * @remarks
+   * The version number.
+   * 
    * @example
    * 0.0.1
    */
   version?: string;
   /**
+   * @remarks
+   * The sorting weight of the component.
+   * 
    * @example
    * 1000
    */