@alicloud/cms20240330 9.2.2 → 10.0.1

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,9 @@ 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 period expires. A value of 0 indicates that data is not archived. Valid values for the archive duration:
+   * * V1: 60 to 365 days.
+   * * V2: 60 to 3650 days (3650 indicates permanent retention).
    * 
    * @example
    * 60
@@ -58,7 +58,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   archiveDuration?: number;
   /**
    * @remarks
-   * Password-free read policy (supports IP segments and VpcId).
+   * The authentication-free read policy. IP CIDR blocks and VPC IDs are supported.
    * 
    * @example
    * {
@@ -75,7 +75,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   authFreeReadPolicy?: string;
   /**
    * @remarks
-   * Password-free write policy.
+   * The authentication-free write policy.
    * 
    * @example
    * {
@@ -92,7 +92,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 authentication-free read. This parameter is supported only for V2 instances.
    * 
    * @example
    * true
@@ -100,7 +100,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 authentication-free write. This parameter is supported only for V2 instances.
    * 
    * @example
    * true
@@ -108,7 +108,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   enableAuthFreeWrite?: boolean;
   /**
    * @remarks
-   * Whether to enable authorization Token (only supported in V1 version).
+   * Specifies whether to enable the authorization token. This parameter is supported only for V1 instances.
    * 
    * @example
    * true
@@ -116,10 +116,10 @@ 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 billable methods. Valid values:
+   * * POSTPAY: pay-as-you-go by metric reporting volume.
+   * * POSTPAY_GB: pay-as-you-go by metric write volume.
+   * If this parameter is left empty, the default billing method configured by the user is used. If the user has not configured a default billing method, the system uses pay-as-you-go by metric reporting volume.
    * 
    * @example
    * POSTPAY
@@ -127,7 +127,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   paymentType?: string;
   /**
    * @remarks
-   * Instance name.
+   * The instance name.
    * 
    * This parameter is required.
    * 
@@ -137,7 +137,15 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
   prometheusInstanceName?: string;
   /**
    * @remarks
-   * Instance status.
+   * The resource group ID.
+   * 
+   * @example
+   * rg-aekz5qqvjyatgoy
+   */
+  resourceGroupId?: string;
+  /**
+   * @remarks
+   * The instance status.
    * 
    * @example
    * Running
@@ -145,9 +153,9 @@ 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 (in days):
+   * * By write volume: 90 or 180.
+   * * By metric reporting volume: 15, 30, 60, 90, or 180.
    * 
    * @example
    * 90
@@ -155,12 +163,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. Default value: default-cms-{userId}-{regionId}.
    * 
    * @example
    * wokspace1
@@ -176,6 +184,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
       enableAuthToken: 'enableAuthToken',
       paymentType: 'paymentType',
       prometheusInstanceName: 'prometheusInstanceName',
+      resourceGroupId: 'resourceGroupId',
       status: 'status',
       storageDuration: 'storageDuration',
       tags: 'tags',
@@ -193,6 +202,7 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
       enableAuthToken: 'boolean',
       paymentType: 'string',
       prometheusInstanceName: 'string',
+      resourceGroupId: 'string',
       status: 'string',
       storageDuration: 'number',
       tags: { 'type': 'array', 'itemType': CreatePrometheusInstanceRequestTags },

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.
+   * Id of the request
    * 
    * @example
    * 264C3E89-BE6E-5F82-A484-CE9C2196C7DC

package/src/models/CreatePrometheusViewRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePrometheusViewRequestPrometheusInstances extends $dara.Model {
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * arms-1d581fac20a462dcde743d9628
@@ -13,7 +13,7 @@ export class CreatePrometheusViewRequestPrometheusInstances extends $dara.Model
   prometheusInstanceId?: string;
   /**
    * @remarks
-   * Region ID.
+   * The region ID.
    * 
    * @example
    * cn-wulanchabu
@@ -21,7 +21,7 @@ export class CreatePrometheusViewRequestPrometheusInstances extends $dara.Model
   regionId?: string;
   /**
    * @remarks
-   * User ID.
+   * The user ID.
    * 
    * @example
    * 167271234567890
@@ -55,7 +55,7 @@ export class CreatePrometheusViewRequestPrometheusInstances extends $dara.Model
 export class CreatePrometheusViewRequestTags extends $dara.Model {
   /**
    * @remarks
-   * Tag key.
+   * The tag key.
    * 
    * @example
    * test-key
@@ -63,7 +63,7 @@ export class CreatePrometheusViewRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Tag value.
+   * The tag value.
    * 
    * @example
    * test-value
@@ -95,7 +95,7 @@ export class CreatePrometheusViewRequestTags extends $dara.Model {
 export class CreatePrometheusViewRequest extends $dara.Model {
   /**
    * @remarks
-   * Not enabled yet
+   * Not in use.
    * 
    * @example
    * {
@@ -112,7 +112,7 @@ export class CreatePrometheusViewRequest extends $dara.Model {
   authFreeReadPolicy?: string;
   /**
    * @remarks
-   * Whether to support password-free read
+   * Specifies whether anonymous read is supported.
    * 
    * @example
    * true
@@ -120,7 +120,7 @@ export class CreatePrometheusViewRequest extends $dara.Model {
   enableAuthFreeRead?: boolean;
   /**
    * @remarks
-   * Whether to support authToken
+   * Specifies whether authToken is supported.
    * 
    * @example
    * true
@@ -128,14 +128,14 @@ export class CreatePrometheusViewRequest extends $dara.Model {
   enableAuthToken?: boolean;
   /**
    * @remarks
-   * List of Prometheus instances.
+   * The list of Prometheus instances.
    * 
    * This parameter is required.
    */
   prometheusInstances?: CreatePrometheusViewRequestPrometheusInstances[];
   /**
    * @remarks
-   * Prometheus view name.
+   * The Prometheus view name.
    * 
    * This parameter is required.
    * 
@@ -145,7 +145,7 @@ export class CreatePrometheusViewRequest extends $dara.Model {
   prometheusViewName?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfm3gn5i6bigbi
@@ -153,7 +153,7 @@ export class CreatePrometheusViewRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Not enabled yet.
+   * Not in use.
    * 
    * @example
    * null
@@ -161,13 +161,14 @@ export class CreatePrometheusViewRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The operation to be performed.
+   * The tags.
    */
   tags?: CreatePrometheusViewRequestTags[];
   /**
    * @remarks
-   * - V1: Old version
-   * - V2: New version
+   * Valid values:
+   * - V1: legacy version
+   * - V2: new version.
    * 
    * This parameter is required.
    * 
@@ -177,7 +178,7 @@ export class CreatePrometheusViewRequest extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * Default value: default-cms-{userId}-{regionId}
+   * Default value: default-cms-{userId}-{regionId}.
    * 
    * @example
    * cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor

package/src/models/CreatePrometheusViewResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePrometheusViewResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Prometheus view ID.
+   * The Prometheus view ID.
    * 
    * @example
    * cd5237f7dbd574cf9bbd648ff9efb16cd
@@ -13,7 +13,7 @@ export class CreatePrometheusViewResponseBody extends $dara.Model {
   prometheusViewId?: string;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****

package/src/models/CreatePrometheusVirtualInstanceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePrometheusVirtualInstanceRequest extends $dara.Model {
   /**
    * @remarks
-   * Each cloud product can only create one virtual instance in each region.
+   * Each cloud product supports only one virtual instance per region.
    * 
    * This parameter is required.
    * 

package/src/models/CreatePrometheusVirtualInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.Model {
   /**
    * @remarks
-   * Creation time
+   * The time when the instance was created.
    * 
    * @example
    * 1751520976660
@@ -13,7 +13,7 @@ export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.M
   createdAt?: string;
   /**
    * @remarks
-   * HTTP API query address
+   * The HTTP API query URL.
    * 
    * @example
    * http://xxxxxxx
@@ -21,7 +21,7 @@ export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.M
   httpApiUrl?: string;
   /**
    * @remarks
-   * Region ID
+   * The instance ID.
    * 
    * @example
    * rw-e815960b4c9ebc5c3d89790c7e82
@@ -29,7 +29,7 @@ export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.M
   instanceId?: string;
   /**
    * @remarks
-   * Cloud product
+   * The cloud product.
    * 
    * @example
    * ack-csi-fuse
@@ -37,7 +37,7 @@ export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.M
   namespace?: string;
   /**
    * @remarks
-   * User ID
+   * Region ID
    * 
    * @example
    * cn-zhengzhou-jva
@@ -45,7 +45,7 @@ export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.M
   regionId?: string;
   /**
    * @remarks
-   * User ID
+   * The user ID.
    * 
    * @example
    * 167212345678
@@ -85,12 +85,12 @@ export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.M
 export class CreatePrometheusVirtualInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Instance ID
+   * The instance.
    */
   instance?: CreatePrometheusVirtualInstanceResponseBodyInstance;
   /**
    * @remarks
-   * ID of the request
+   * Id of the request
    * 
    * @example
    * 0B9377D9-C56B-5C2E-A8A4-************