@alicloud/cms20240330 9.2.1 → 10.0.0

package/src/models/CreateIntegrationPolicyRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   /**
    * @remarks
-   * Cluster entity type, such as acs.ack.cluster/acs.one.cluster/acs.asi.cluster or others.
+   * The cluster entity type. Examples: acs.ack.cluster, acs.one.cluster, and acs.asi.cluster.
    * 
    * @example
    * acs.ack.cluster
@@ -13,7 +13,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   clusterEntityType?: string;
   /**
    * @remarks
-   * Cluster ID.
+   * The cluster ID.
    * 
    * @example
    * na61prod3-na61cloudhdfsssd
@@ -22,7 +22,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   clusterNamespace?: string;
   /**
    * @remarks
-   * Whether to disable the unique binding of the Policy. If enabled, multiple Policies can be created for a single container cluster.
+   * Specifies whether to disable unique policy binding. If this parameter is set to true, you can create multiple policies for a container cluster.
    * 
    * @example
    * ture
@@ -30,7 +30,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   disablePolicyShare?: boolean;
   /**
    * @remarks
-   * Entity group ID.
+   * The entity group ID.
    * 
    * @example
    * eg-b79f65d11fb94e779867cf937c3a3002
@@ -38,7 +38,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   entityGroupId?: string;
   /**
    * @remarks
-   * User ID to which the cluster belongs.
+   * The ID of the user who owns the cluster.
    * 
    * @example
    * 12xxxx
@@ -46,7 +46,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   entityUserId?: string;
   /**
    * @remarks
-   * VPC ID.
+   * The virtual private cloud (VPC) ID.
    * 
    * @example
    * vpc-bp18fgg3ffxa9czna40xt
@@ -88,7 +88,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
 export class CreateIntegrationPolicyRequestTags extends $dara.Model {
   /**
    * @remarks
-   * Tag `key` value.
+   * The key of the tag.
    * 
    * @example
    * use
@@ -96,7 +96,7 @@ export class CreateIntegrationPolicyRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Tag `value` value.
+   * The value of the tag.
    * 
    * @example
    * database
@@ -128,12 +128,12 @@ export class CreateIntegrationPolicyRequestTags extends $dara.Model {
 export class CreateIntegrationPolicyRequest extends $dara.Model {
   /**
    * @remarks
-   * Entity group for creating the policy. Policies can be quickly created using the entity group, and `clusterId` and `vpcId` are independent of each other.
+   * The entity group used to create the policy. You can quickly create a policy using an entity group. The clusterId and vpcId parameters are independent of each other.
    */
   entityGroup?: CreateIntegrationPolicyRequestEntityGroup;
   /**
    * @remarks
-   * Policy name
+   * The policy name.
    * 
    * @example
    * prod-database
@@ -141,7 +141,7 @@ export class CreateIntegrationPolicyRequest extends $dara.Model {
   policyName?: string;
   /**
    * @remarks
-   * Policy type: CS/ECS/Cloud
+   * The policy type. Valid values: CS, ECS, and Cloud.
    * 
    * This parameter is required.
    * 
@@ -151,7 +151,7 @@ export class CreateIntegrationPolicyRequest extends $dara.Model {
   policyType?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-aekz2km4kmhtbii
@@ -159,12 +159,12 @@ export class CreateIntegrationPolicyRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Resource tags.
+   * The resource tags.
    */
   tags?: CreateIntegrationPolicyRequestTags[];
   /**
    * @remarks
-   * Workspace.
+   * The workspace.
    * 
    * @example
    * prometheus

package/src/models/CreateIntegrationPolicyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   /**
    * @remarks
-   * Entity group ID.
+   * The entity group ID.
    * 
    * @example
    * eg-b79f65d11fb94e779867cf937c3a3002
@@ -13,7 +13,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   entityGroupId?: string;
   /**
    * @remarks
-   * Policy ID.
+   * The policy ID.
    * 
    * @example
    * policy-14c8e9a29b0a46da843f8781471062ff
@@ -21,7 +21,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   policyId?: string;
   /**
    * @remarks
-   * Policy name.
+   * The policy name.
    * 
    * @example
    * metrics-inner-manage
@@ -29,7 +29,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   policyName?: string;
   /**
    * @remarks
-   * Policy type.
+   * The policy type.
    * 
    * @example
    * CS
@@ -37,7 +37,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   policyType?: string;
   /**
    * @remarks
-   * Region ID.
+   * The region.
    * 
    * @example
    * cn-heyuan
@@ -45,7 +45,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * User ID.
+   * The user ID.
    * 
    * @example
    * u1234567
@@ -53,7 +53,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   userId?: string;
   /**
    * @remarks
-   * The workspace where the Policy resides.
+   * The workspace where the policy resides.
    * 
    * @example
    * prometheus
@@ -95,7 +95,7 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
 export class CreateIntegrationPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Whether it is created.
+   * Indicates whether the policy was created.
    * 
    * @example
    * true
@@ -103,12 +103,12 @@ export class CreateIntegrationPolicyResponseBody extends $dara.Model {
   created?: boolean;
   /**
    * @remarks
-   * Uploaded policy.
+   * The upload policy.
    */
   policy?: CreateIntegrationPolicyResponseBodyPolicy;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * CD8BA7D6-995D-578D-9941-78B0FECD14B5

package/src/models/CreateMemoryStoreRequest.ts

@@ -4,13 +4,23 @@ import { CustomExtractionStrategy } from "./CustomExtractionStrategy";
 
 
 export class CreateMemoryStoreRequestTraceSourceConfig extends $dara.Model {
+  /**
+   * @remarks
+   * Specifies whether to include the output in the trace.
+   */
   includeOutput?: boolean;
   /**
+   * @remarks
+   * The query to filter traces.
+   * 
    * @example
    * (serviceName : "langchain-rag" or serviceName : "agentscope-code-correction") and hostname = frontend-proxy-999c48c8d-hvk6c
    */
   query?: string;
   /**
+   * @remarks
+   * The name of the workspace that contains the trace source.
+   * 
    * @example
    * test-workspace
    */
@@ -41,15 +51,28 @@ export class CreateMemoryStoreRequestTraceSourceConfig extends $dara.Model {
 }
 
 export class CreateMemoryStoreRequest extends $dara.Model {
+  /**
+   * @remarks
+   * A list of custom extraction strategies.
+   */
   customExtractionStrategies?: CustomExtractionStrategy[];
   /**
+   * @remarks
+   * The description of the MemoryStore.
+   * 
    * @example
    * Test memory store for demonstration.
    */
   description?: string;
+  /**
+   * @remarks
+   * The extraction strategies to use. Valid values include `Episodic`, `Summary`, and `Fact`.
+   */
   extractionStrategies?: string[];
   /**
    * @remarks
+   * The name of the MemoryStore. The name must be unique within the workspace.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -58,6 +81,8 @@ export class CreateMemoryStoreRequest extends $dara.Model {
   memoryStoreName?: string;
   /**
    * @remarks
+   * The short-term TTL, which is the number of conversation rounds to retain.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -65,10 +90,17 @@ export class CreateMemoryStoreRequest extends $dara.Model {
    */
   shortTermTtl?: number;
   /**
+   * @remarks
+   * The source type of the memory. Valid values are `None` and `Trace`.
+   * 
    * @example
    * None/Trace
    */
   sourceType?: string;
+  /**
+   * @remarks
+   * Configuration for the trace source. Required if `sourceType` is `Trace`.
+   */
   traceSourceConfig?: CreateMemoryStoreRequestTraceSourceConfig;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreateMemoryStoreResponseBody.ts

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

package/src/models/CreatePipelineRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePipelineRequestExecutePolicyRunOnce extends $dara.Model {
   /**
+   * @remarks
+   * The start timestamp.
+   * 
    * @example
    * 1772519013
    */
   fromTime?: number;
   /**
+   * @remarks
+   * The end timestamp.
+   * 
    * @example
    * 1772519013
    */
@@ -38,11 +44,17 @@ export class CreatePipelineRequestExecutePolicyRunOnce extends $dara.Model {
 
 export class CreatePipelineRequestExecutePolicyScheduled extends $dara.Model {
   /**
+   * @remarks
+   * The start timestamp.
+   * 
    * @example
    * 1772519013
    */
   fromTime?: number;
   /**
+   * @remarks
+   * The execution interval in seconds.
+   * 
    * @example
    * 86400
    */
@@ -72,11 +84,22 @@ export class CreatePipelineRequestExecutePolicyScheduled extends $dara.Model {
 
 export class CreatePipelineRequestExecutePolicy extends $dara.Model {
   /**
+   * @remarks
+   * The execution mode. Set to `runOnce` for a single execution, or `scheduled` for a recurring execution.
+   * 
    * @example
    * runOnce
    */
   mode?: string;
+  /**
+   * @remarks
+   * The configuration for a one-time execution. This parameter is required when `executePolicy.mode` is set to `runOnce`.
+   */
   runOnce?: CreatePipelineRequestExecutePolicyRunOnce;
+  /**
+   * @remarks
+   * The configuration for a scheduled execution. This parameter is required when `executePolicy.mode` is set to `scheduled`.
+   */
   scheduled?: CreatePipelineRequestExecutePolicyScheduled;
   static names(): { [key: string]: string } {
     return {
@@ -111,12 +134,22 @@ export class CreatePipelineRequestExecutePolicy extends $dara.Model {
 
 export class CreatePipelineRequestPipelineNodes extends $dara.Model {
   /**
+   * @remarks
+   * The node ID.
+   * 
    * @example
    * node_1
    */
   id?: string;
+  /**
+   * @remarks
+   * The node parameters.
+   */
   parameters?: { [key: string]: any };
   /**
+   * @remarks
+   * The node type.
+   * 
    * @example
    * dedup-fuzzy
    */
@@ -150,6 +183,10 @@ export class CreatePipelineRequestPipelineNodes extends $dara.Model {
 }
 
 export class CreatePipelineRequestPipeline extends $dara.Model {
+  /**
+   * @remarks
+   * The pipeline nodes.
+   */
   nodes?: CreatePipelineRequestPipelineNodes[];
   static names(): { [key: string]: string } {
     return {
@@ -177,11 +214,17 @@ export class CreatePipelineRequestPipeline extends $dara.Model {
 
 export class CreatePipelineRequestSinkDataset extends $dara.Model {
   /**
+   * @remarks
+   * The dataset name.
+   * 
    * @example
    * dataset_1
    */
   dataset?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * workspace-test
    */
@@ -210,8 +253,15 @@ export class CreatePipelineRequestSinkDataset extends $dara.Model {
 }
 
 export class CreatePipelineRequestSink extends $dara.Model {
+  /**
+   * @remarks
+   * The destination dataset configuration. This parameter is required when `sink.type` is set to `dataset`.
+   */
   dataset?: CreatePipelineRequestSinkDataset;
   /**
+   * @remarks
+   * The sink type.
+   * 
    * @example
    * dataset
    */
@@ -244,16 +294,25 @@ export class CreatePipelineRequestSink extends $dara.Model {
 
 export class CreatePipelineRequestSourceLogstore extends $dara.Model {
   /**
+   * @remarks
+   * The Logstore name.
+   * 
    * @example
    * test-logstore
    */
   logstore?: string;
   /**
+   * @remarks
+   * The Log Service Project name.
+   * 
    * @example
    * test-project
    */
   project?: string;
   /**
+   * @remarks
+   * The query statement to filter logs.
+   * 
    * @example
    * status:500 and method:GET
    */
@@ -284,8 +343,15 @@ export class CreatePipelineRequestSourceLogstore extends $dara.Model {
 }
 
 export class CreatePipelineRequestSource extends $dara.Model {
+  /**
+   * @remarks
+   * The Log Service Logstore configuration. This parameter is required when `source.type` is set to `logstore`.
+   */
   logstore?: CreatePipelineRequestSourceLogstore;
   /**
+   * @remarks
+   * The data source type.
+   * 
    * @example
    * logstore
    */
@@ -318,18 +384,40 @@ export class CreatePipelineRequestSource extends $dara.Model {
 
 export class CreatePipelineRequest extends $dara.Model {
   /**
+   * @remarks
+   * The pipeline description.
+   * 
    * @example
    * test
    */
   description?: string;
+  /**
+   * @remarks
+   * The execution policy.
+   */
   executePolicy?: CreatePipelineRequestExecutePolicy;
+  /**
+   * @remarks
+   * The pipeline configuration.
+   */
   pipeline?: CreatePipelineRequestPipeline;
   /**
+   * @remarks
+   * The pipeline name.
+   * 
    * @example
    * pipeline-name-1
    */
   pipelineName?: string;
+  /**
+   * @remarks
+   * The data sink for the processed output.
+   */
   sink?: CreatePipelineRequestSink;
+  /**
+   * @remarks
+   * The data source.
+   */
   source?: CreatePipelineRequestSource;
   static names(): { [key: string]: string } {
     return {

package/src/models/CreatePipelineResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePipelineResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0CEC5375-C554-562B-A65F-***
    */

package/src/models/CreatePrometheusInstanceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePrometheusInstanceRequestTags extends $dara.Model {
   /**
    * @remarks
-   * Tag key.
+   * The tag key.
    * 
    * @example
    * key1
@@ -13,7 +13,7 @@ export class CreatePrometheusInstanceRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Tag value.
+   * The tag value.
    * 
    * @example
    * 110109200001214284
@@ -45,9 +45,11 @@ export class CreatePrometheusInstanceRequestTags extends $dara.Model {
 export class CreatePrometheusInstanceRequest extends $dara.Model {
   /**
    * @remarks
-   * The number of days to automatically archive and save after the storage expires, 0 means no archiving. The range of archiving days is as follows:
-   * * V1: 60~365 days.
-   * * V2: 60~3650 days (3650 indicates permanent storage).
+   * The number of days that data is automatically archived after the storage duration expires. A value of 0 indicates that data is not archived. Valid values:
+   * 
+   * - V1 instances: 60 to 365.
+   * 
+   * - V2 instances: 60 to 3650. A value of 3650 indicates that the data is permanently stored.
    * 
    * @example
    * 60
@@ -58,7 +60,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   archiveDuration?: number;
   /**
    * @remarks
-   * Password-free read policy (supports IP segments and VpcId).
+   * The policy for password-free read access. IP address ranges and VPC IDs are supported.
    * 
    * @example
    * {
@@ -75,7 +77,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   authFreeReadPolicy?: string;
   /**
    * @remarks
-   * Password-free write policy.
+   * The policy for password-free write access.
    * 
    * @example
    * {
@@ -92,7 +94,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   authFreeWritePolicy?: string;
   /**
    * @remarks
-   * Whether to enable password-free read (only supported in V2 version).
+   * Specifies whether to enable password-free read access. This feature is supported only for V2 instances.
    * 
    * @example
    * true
@@ -100,7 +102,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   enableAuthFreeRead?: boolean;
   /**
    * @remarks
-   * Whether to enable password-free write (only supported in V2 version).
+   * Specifies whether to enable password-free write access. This feature is supported only for V2 instances.
    * 
    * @example
    * true
@@ -108,7 +110,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   enableAuthFreeWrite?: boolean;
   /**
    * @remarks
-   * Whether to enable authorization Token (only supported in V1 version).
+   * Specifies whether to enable an authorization token. This feature is supported only for V1 instances.
    * 
    * @example
    * true
@@ -116,10 +118,11 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   enableAuthToken?: boolean;
   /**
    * @remarks
-   * Billing method:
-   * * POSTPAY: Postpaid by metric reporting volume.
-   * * POSTPAY_GB: Postpaid by metric write volume.
-   * Note, if left blank, the user\\"s default billing method configuration will be used. If the user has not configured a default, the system defaults to billing by metric reporting volume.
+   * The billing method.
+   * 
+   * - POSTPAY: pay-as-you-go based on the volume of reported metrics.
+   * 
+   * - Note: If you leave this parameter empty, the default billing method is used. If a default billing method is not configured, POSTPAY is used.
    * 
    * @example
    * POSTPAY
@@ -127,7 +130,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   paymentType?: string;
   /**
    * @remarks
-   * Instance name.
+   * The name of the instance.
    * 
    * This parameter is required.
    * 
@@ -137,7 +140,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   prometheusInstanceName?: string;
   /**
    * @remarks
-   * Instance status.
+   * The instance status.
    * 
    * @example
    * Running
@@ -145,9 +148,11 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Storage duration (days):
-   * * By write volume: 90, 180.
-   * * By metric reporting volume: 15, 30, 60, 90, 180.
+   * The storage duration of the instance in days. The valid values depend on the billing method:
+   * 
+   * - For instances billed based on data written: 90 and 180.
+   * 
+   * - For instances billed based on reported metrics: 15, 30, 60, 90, and 180.
    * 
    * @example
    * 90
@@ -155,12 +160,12 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   storageDuration?: number;
   /**
    * @remarks
-   * Tag values.
+   * The tags.
    */
   tags?: CreatePrometheusInstanceRequestTags[];
   /**
    * @remarks
-   * Belonging workspace, default value: default-cms-{userId}-{regionId}.
+   * The workspace to which the instance belongs. The default value is default-cms-{userId}-{regionId}.
    * 
    * @example
    * wokspace1

package/src/models/CreatePrometheusInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePrometheusInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * rw-abc123
@@ -13,7 +13,7 @@ export class CreatePrometheusInstanceResponseBody extends $dara.Model {
   prometheusInstanceId?: string;
   /**
    * @remarks
-   * ID of the request.
+   * The ID of the request.
    * 
    * @example
    * 264C3E89-BE6E-5F82-A484-CE9C2196C7DC