@alicloud/cms20240330 9.2.2 → 10.0.1

package/src/models/GetPipelineResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetPipelineResponseBodyExecutePolicyRunOnce extends $dara.Model {
   /**
+   * @remarks
+   * The start time of the execution, as a Unix timestamp.
+   * 
    * @example
    * 1772519013
    */
   fromTime?: number;
   /**
+   * @remarks
+   * The end time of the execution, as a Unix timestamp.
+   * 
    * @example
    * 1772519013
    */
@@ -38,11 +44,17 @@ export class GetPipelineResponseBodyExecutePolicyRunOnce extends $dara.Model {
 
 export class GetPipelineResponseBodyExecutePolicyScheduled extends $dara.Model {
   /**
+   * @remarks
+   * The start time of the execution, as a Unix timestamp.
+   * 
    * @example
    * 1772519013
    */
   fromTime?: number;
   /**
+   * @remarks
+   * The execution interval in seconds.
+   * 
    * @example
    * 86400
    */
@@ -72,11 +84,22 @@ export class GetPipelineResponseBodyExecutePolicyScheduled extends $dara.Model {
 
 export class GetPipelineResponseBodyExecutePolicy extends $dara.Model {
   /**
+   * @remarks
+   * The execution mode.
+   * 
    * @example
    * runOnce
    */
   mode?: string;
+  /**
+   * @remarks
+   * The configuration for a one-time execution.
+   */
   runOnce?: GetPipelineResponseBodyExecutePolicyRunOnce;
+  /**
+   * @remarks
+   * The configuration for a scheduled execution.
+   */
   scheduled?: GetPipelineResponseBodyExecutePolicyScheduled;
   static names(): { [key: string]: string } {
     return {
@@ -111,12 +134,22 @@ export class GetPipelineResponseBodyExecutePolicy extends $dara.Model {
 
 export class GetPipelineResponseBodyPipelineNodes extends $dara.Model {
   /**
+   * @remarks
+   * The node ID.
+   * 
    * @example
    * node_1
    */
   id?: string;
+  /**
+   * @remarks
+   * The parameters for the node.
+   */
   parameters?: { [key: string]: any };
   /**
+   * @remarks
+   * The node type.
+   * 
    * @example
    * dedup-fuzzy
    */
@@ -150,6 +183,10 @@ export class GetPipelineResponseBodyPipelineNodes extends $dara.Model {
 }
 
 export class GetPipelineResponseBodyPipeline extends $dara.Model {
+  /**
+   * @remarks
+   * The nodes in the pipeline.
+   */
   nodes?: GetPipelineResponseBodyPipelineNodes[];
   static names(): { [key: string]: string } {
     return {
@@ -177,11 +214,17 @@ export class GetPipelineResponseBodyPipeline extends $dara.Model {
 
 export class GetPipelineResponseBodySinkDataset 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 GetPipelineResponseBodySinkDataset extends $dara.Model {
 }
 
 export class GetPipelineResponseBodySink extends $dara.Model {
+  /**
+   * @remarks
+   * The dataset configuration.
+   */
   dataset?: GetPipelineResponseBodySinkDataset;
   /**
+   * @remarks
+   * The sink type.
+   * 
    * @example
    * dataset
    */
@@ -244,11 +294,17 @@ export class GetPipelineResponseBodySink extends $dara.Model {
 
 export class GetPipelineResponseBodySourceLogstore extends $dara.Model {
   /**
+   * @remarks
+   * The name of the Log Service Logstore.
+   * 
    * @example
    * test-logstore
    */
   logstore?: string;
   /**
+   * @remarks
+   * The name of the Log Service project.
+   * 
    * @example
    * test-project
    */
@@ -280,8 +336,15 @@ export class GetPipelineResponseBodySourceLogstore extends $dara.Model {
 }
 
 export class GetPipelineResponseBodySource extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration of the Log Service Logstore.
+   */
   logstore?: GetPipelineResponseBodySourceLogstore;
   /**
+   * @remarks
+   * The type of the data source.
+   * 
    * @example
    * logstore
    */
@@ -315,6 +378,8 @@ export class GetPipelineResponseBodySource extends $dara.Model {
 export class GetPipelineResponseBody extends $dara.Model {
   /**
    * @remarks
+   * The creation time.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -322,31 +387,61 @@ export class GetPipelineResponseBody extends $dara.Model {
    */
   createTime?: string;
   /**
+   * @remarks
+   * The description of the pipeline.
+   * 
    * @example
    * workspace test
    */
   description?: string;
+  /**
+   * @remarks
+   * The execution policy.
+   */
   executePolicy?: GetPipelineResponseBodyExecutePolicy;
+  /**
+   * @remarks
+   * The pipeline configuration.
+   */
   pipeline?: GetPipelineResponseBodyPipeline;
   /**
+   * @remarks
+   * The pipeline name.
+   * 
    * @example
    * pipeline-name-1
    */
   pipelineName?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 3430AE20-AFFF-597C-B553-2DF04B2933AA
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The pipeline\\"s data sink.
+   */
   sink?: GetPipelineResponseBodySink;
+  /**
+   * @remarks
+   * The pipeline\\"s data source.
+   */
   source?: GetPipelineResponseBodySource;
   /**
    * @remarks
+   * The update time.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -354,6 +449,9 @@ export class GetPipelineResponseBody extends $dara.Model {
    */
   updateTime?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * workspace-test
    */

package/src/models/GetPrometheusInstanceRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetPrometheusInstanceRequest extends $dara.Model {
   /**
    * @remarks
-   * Language setting, default is Chinese zh | en
+   * The language. Default value: zh. Valid values: zh, en.
    * 
    * @example
    * zh
@@ -13,7 +13,7 @@ export class GetPrometheusInstanceRequest extends $dara.Model {
   aliyunLang?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-aek2bhocin5e2na

package/src/models/GetPrometheusInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetPrometheusInstanceResponseBodyPrometheusInstanceTags extends $dara.Model {
   /**
    * @remarks
-   * Tag key.
+   * The tag key.
    * 
    * @example
    * openStorage
@@ -13,7 +13,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstanceTags extends $da
   key?: string;
   /**
    * @remarks
-   * Matched value.
+   * The tag value.
    * 
    * @example
    * 130303196111114281
@@ -45,8 +45,10 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstanceTags extends $da
 export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.Model {
   /**
    * @remarks
-   * Access type:
-   * readWrite, readOnly, httpReadOnly
+   * The access type. Valid values:
+   * - readWrite
+   * - readOnly
+   * - httpReadOnly
    * 
    * @example
    * readOnly
@@ -54,7 +56,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   accessType?: string;
   /**
    * @remarks
-   * Number of days to automatically archive and save after storage expiration. 0 means no archiving, 3650 means permanent saving.
+   * The number of days that data is automatically archived after the storage period expires. A value of 0 indicates that data is not archived. A value of 3650 indicates that data is permanently retained.
    * 
    * @example
    * 90
@@ -62,7 +64,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   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
    * {
@@ -79,7 +81,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   authFreeReadPolicy?: string;
   /**
    * @remarks
-   * Password-free write policy (supports IP segments and VpcId).
+   * The authentication-free write policy. IP CIDR blocks and VPC IDs are supported.
    * 
    * @example
    * {
@@ -96,7 +98,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   authFreeWritePolicy?: string;
   /**
    * @remarks
-   * authToken string.
+   * The authentication token.
    * 
    * @example
    * eJwixxxxx
@@ -104,7 +106,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   authToken?: string;
   /**
    * @remarks
-   * Instance creation time, using UTC+0, formatted as yyyy-MM-ddTHH:mmZ.
+   * The time when the instance was created. The time is in UTC+0 and in the yyyy-MM-ddTHH:mmZ format.
    * 
    * @example
    * 2025-08-10T02:07:53Z
@@ -112,7 +114,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   createTime?: string;
   /**
    * @remarks
-   * Whether to enable password-free reading.
+   * Indicates whether authentication-free read is enabled.
    * 
    * @example
    * true
@@ -120,7 +122,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   enableAuthFreeRead?: boolean;
   /**
    * @remarks
-   * Whether to enable password-free writing.
+   * Indicates whether authentication-free write is enabled.
    * 
    * @example
    * true
@@ -128,7 +130,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   enableAuthFreeWrite?: boolean;
   /**
    * @remarks
-   * Whether to enable authentication token.
+   * Indicates whether the authentication token is enabled.
    * 
    * @example
    * true
@@ -136,12 +138,12 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   enableAuthToken?: boolean;
   /**
    * @remarks
-   * Additional information.
+   * The extended information.
    */
   extraInfo?: { [key: string]: string };
   /**
    * @remarks
-   * URL of the visualization dashboard directory.
+   * The dashboard directory URL.
    * 
    * @example
    * https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx
@@ -149,7 +151,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   folderUrl?: string;
   /**
    * @remarks
-   * ID of the managed Grafana instance that is bound.
+   * The instance ID of the attached managed Grafana instance.
    * 
    * @example
    * SHARED
@@ -157,7 +159,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   grafanaInstanceId?: string;
   /**
    * @remarks
-   * Name of the managed Grafana instance that is bound.
+   * The name of the associated managed Grafana instance.
    * 
    * @example
    * 共享版
@@ -165,16 +167,23 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   grafanaInstanceName?: string;
   /**
    * @remarks
-   * HTTP public network address.
+   * The HTTP public endpoint.
    * 
    * @example
    * http://workspace-default-cms-xxxxxxx
    */
   httpApiInterUrl?: string;
+  /**
+   * @remarks
+   * The HTTP internal endpoint.
+   * 
+   * @example
+   * http://workspace-default-cms-xxxxxxx
+   */
   httpApiInternalUrl?: string;
   /**
    * @remarks
-   * HTTP intranet address.
+   * The HTTP private endpoint.
    * 
    * @example
    * http://workspace-default-cms-xxxxxxx
@@ -182,7 +191,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   httpApiIntraUrl?: string;
   /**
    * @remarks
-   * Prometheus instance type.
+   * The Prometheus instance type.
    * 
    * @example
    * remote-write
@@ -190,9 +199,9 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   instanceType?: string;
   /**
    * @remarks
-   * Billing method:
-   * POSTPAY: Pay-as-you-go based on metric reporting volume.
-   * POSTPAY_GB: Pay-as-you-go based on metric write volume.
+   * The billing method. Valid values:
+   * - POSTPAY: pay-as-you-go based on the number of reported metrics.
+   * - POSTPAY_GB: pay-as-you-go based on the volume of written metrics.
    * 
    * @example
    * POSTPAY
@@ -200,7 +209,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   paymentType?: string;
   /**
    * @remarks
-   * Time when the billing method of the instance was updated.
+   * The time when the billing method of the instance was last modified, in UTC format.
    * 
    * @example
    * 2025-08-10T02:07:53Z
@@ -216,7 +225,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   product?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * rw-524ada714221af267c73122af2e1
@@ -224,7 +233,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   prometheusInstanceId?: string;
   /**
    * @remarks
-   * Instance name.
+   * The instance name.
    * 
    * @example
    * test-prom-name
@@ -232,16 +241,23 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   prometheusInstanceName?: string;
   /**
    * @remarks
-   * Public network address of PushGateway.
+   * The PushGateway public endpoint.
    * 
    * @example
    * http://workspace-default-cms-xxxxxxx
    */
   pushGatewayInterUrl?: string;
+  /**
+   * @remarks
+   * The PushGateway internal endpoint.
+   * 
+   * @example
+   * http://workspace-default-cms-xxxxxxx
+   */
   pushGatewayInternalUrl?: string;
   /**
    * @remarks
-   * Intranet address of PushGateway.
+   * The PushGateway private endpoint.
    * 
    * @example
    * http://workspace-default-cms-xxxxxxx
@@ -249,7 +265,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   pushGatewayIntraUrl?: string;
   /**
    * @remarks
-   * Region ID.
+   * The region ID.
    * 
    * @example
    * cn-heyuan
@@ -257,16 +273,23 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   regionId?: string;
   /**
    * @remarks
-   * Public network read address.
+   * The public read endpoint.
    * 
    * @example
    * http://workspace-default-cms-xxxxxxx
    */
   remoteReadInterUrl?: string;
+  /**
+   * @remarks
+   * The RemoteRead internal endpoint.
+   * 
+   * @example
+   * https://workspace-default-cms-1xxxxxxxxxx
+   */
   remoteReadInternalUrl?: string;
   /**
    * @remarks
-   * Intranet read address.
+   * The private read endpoint.
    * 
    * @example
    * https://workspace-default-cms-1xxxxxxxxxx
@@ -274,16 +297,23 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   remoteReadIntraUrl?: string;
   /**
    * @remarks
-   * Public network write address.
+   * The public write endpoint.
    * 
    * @example
    * https://workspace-default-cms-xxxxxxxxxx
    */
   remoteWriteInterUrl?: string;
+  /**
+   * @remarks
+   * The RemoteWrite internal endpoint.
+   * 
+   * @example
+   * https://workspace-default-cms-xxxxxxxxxx
+   */
   remoteWriteInternalUrl?: string;
   /**
    * @remarks
-   * Intranet write address.
+   * The private write endpoint.
    * 
    * @example
    * https://workspace-default-cms-xxxxxxxxxx
@@ -291,7 +321,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   remoteWriteIntraUrl?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-acfm3gn5i6bigbi
@@ -307,7 +337,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   resourceType?: string;
   /**
    * @remarks
-   * Instance status.
+   * The instance status.
    * 
    * @example
    * Running
@@ -315,7 +345,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   status?: string;
   /**
    * @remarks
-   * Storage duration (in days).
+   * The storage duration, in days.
    * 
    * @example
    * 90
@@ -323,17 +353,17 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   storageDuration?: number;
   /**
    * @remarks
-   * Supported authentication types.
+   * The supported authentication types.
    */
   supportAuthTypes?: string[];
   /**
    * @remarks
-   * List of tags.
+   * The list of tags.
    */
   tags?: GetPrometheusInstanceResponseBodyPrometheusInstanceTags[];
   /**
    * @remarks
-   * User ID.
+   * The user ID.
    * 
    * @example
    * 170731234567
@@ -341,7 +371,7 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
   userId?: string;
   /**
    * @remarks
-   * Version.
+   * The version.
    * 
    * @example
    * V1
@@ -468,12 +498,12 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
 export class GetPrometheusInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Details of the Prometheus instance.
+   * The details of the Prometheus instance.
    */
   prometheusInstance?: GetPrometheusInstanceResponseBodyPrometheusInstance;
   /**
    * @remarks
-   * Unique identifier for the request.
+   * The request ID.
    * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC

package/src/models/GetPrometheusUserSettingRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetPrometheusUserSettingRequest extends $dara.Model {
   /**
+   * @remarks
+   * The language of the response. Valid values: zh and en. Default value: zh.
+   * 
    * @example
    * zh
    */

package/src/models/GetPrometheusUserSettingResponseBody.ts

@@ -3,10 +3,14 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetPrometheusUserSettingResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details of the user settings for Prometheus.
+   */
   prometheusUserSetting?: { [key: string]: string };
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 058550FA-DDBE-519E-9C6D-93521B9A5E90

package/src/models/GetPrometheusViewRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetPrometheusViewRequest extends $dara.Model {
   /**
    * @remarks
-   * Language environment, default is Chinese zh | en
+   * The language. Default value: zh. Valid values: zh and en.
    * 
    * @example
    * zh
@@ -13,7 +13,7 @@ export class GetPrometheusViewRequest extends $dara.Model {
   aliyunLang?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-aek2bhocin5e2na