@alicloud/cms20240330 9.2.2 → 10.0.1

package/src/models/GetAggTaskGroupResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetAggTaskGroupResponseBodyAggTaskGroupTags extends $dara.Model {
   /**
    * @remarks
-   * Key of the resource group tag.
+   * The key of the resource group tag.
    * 
    * @example
    * key1
@@ -45,7 +45,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroupTags extends $dara.Model {
 export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   /**
    * @remarks
-   * Aggregation task group configuration.
+   * The configuration of the aggregation task group.
    * 
    * @example
    * groups:
@@ -59,7 +59,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   aggTaskGroupConfig?: string;
   /**
    * @remarks
-   * Summary of the aggregation task group configuration.
+   * The summary of the aggregation task group configuration.
    * 
    * @example
    * a54136xxx
@@ -67,7 +67,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   aggTaskGroupConfigHash?: string;
   /**
    * @remarks
-   * ID of the aggregation task group.
+   * The ID of the aggregation task group.
    * 
    * @example
    * aggTaskGroup-xx
@@ -75,7 +75,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   aggTaskGroupId?: string;
   /**
    * @remarks
-   * Name of the aggregation task group.
+   * The name of the aggregation task group.
    * 
    * @example
    * pipeline-aggtask-group
@@ -83,7 +83,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   aggTaskGroupName?: string;
   /**
    * @remarks
-   * Scheduling expression for the aggregation task group when the scheduling mode is \\"Cron\\".
+   * The scheduling expression of the aggregation task group when the scheduling mode is set to Cron.
    * 
    * @example
    * 0 1 3 * * ? *
@@ -91,7 +91,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   cronExpr?: string;
   /**
    * @remarks
-   * Fixed delay time (in seconds) for scheduling.
+   * The fixed delay time for scheduling, in seconds.
    * 
    * @example
    * 2
@@ -99,7 +99,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   delay?: number;
   /**
    * @remarks
-   * Description of the aggregation task group.
+   * The description of the aggregation task group.
    * 
    * @example
    * test
@@ -107,7 +107,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * Second-level timestamp corresponding to the start time of scheduling (not yet effective).
+   * The UNIX timestamp in seconds that corresponds to the start time of the scheduling. This parameter is not yet in effect.
    * 
    * @example
    * 1757409495
@@ -115,7 +115,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   fromTime?: number;
   /**
    * @remarks
-   * Maximum number of retries for executing the aggregation task.
+   * The maximum number of retries to execute the aggregation task.
    * 
    * @example
    * 2
@@ -123,7 +123,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   maxRetries?: number;
   /**
    * @remarks
-   * Maximum retry time for executing the aggregation task.
+   * The maximum runtime of the aggregation task, in seconds.
    * 
    * @example
    * 50
@@ -131,7 +131,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   maxRunTimeInSeconds?: number;
   /**
    * @remarks
-   * Pre-check configuration.
+   * The dry run configuration.
    * 
    * @example
    * {"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}
@@ -139,7 +139,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   precheckString?: string;
   /**
    * @remarks
-   * Region ID.
+   * The region ID.
    * 
    * @example
    * cn-zhangjiakou
@@ -147,7 +147,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Scheduling mode.
+   * The scheduling mode.
    * 
    * @example
    * FixedRate
@@ -155,7 +155,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   scheduleMode?: string;
   /**
    * @remarks
-   * Scheduling time expression.
+   * The scheduling time expression.
    * 
    * @example
    * @m
@@ -163,7 +163,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   scheduleTimeExpr?: string;
   /**
    * @remarks
-   * ID of the source Prometheus instance for the aggregation task group.
+   * The ID of the source Prometheus instance for the aggregation task group.
    * 
    * @example
    * rw-xxx
@@ -171,7 +171,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   sourcePrometheusId?: string;
   /**
    * @remarks
-   * Status of the aggregation task group.
+   * The status of the aggregation task group.
    * 
    * @example
    * Running
@@ -179,12 +179,12 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Resource group tags
+   * The tags of the resource group.
    */
   tags?: GetAggTaskGroupResponseBodyAggTaskGroupTags[];
   /**
    * @remarks
-   * The target Prometheus instance ID of the aggregation task group.
+   * The ID of the target Prometheus instance for the aggregation task group.
    * 
    * @example
    * rw-xxx
@@ -192,7 +192,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   targetPrometheusId?: string;
   /**
    * @remarks
-   * The second-level timestamp corresponding to the end time of the scheduling.
+   * The UNIX timestamp in seconds that corresponds to the end time of the scheduling.
    * 
    * @example
    * 1757409495
@@ -200,7 +200,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   toTime?: number;
   /**
    * @remarks
-   * The update time (timestamp) of the aggregation task group.
+   * The time when the aggregation task group was updated. This is a timestamp.
    * 
    * @example
    * 1757409499000
@@ -208,7 +208,7 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * The user to whom the aggregation task group belongs.
+   * The user to which the aggregation task group belongs.
    * 
    * @example
    * 123xxx
@@ -281,12 +281,12 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
 export class GetAggTaskGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Aggregation task group.
+   * The aggregation task group.
    */
   aggTaskGroup?: GetAggTaskGroupResponseBodyAggTaskGroup;
   /**
    * @remarks
-   * Request ID
+   * The request ID.
    * 
    * @example
    * 68DAF543-35DF-5762-BE90-F5C00B5DC036
@@ -294,7 +294,7 @@ export class GetAggTaskGroupResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Whether the request was successful
+   * Indicates whether the request was successful.
    * 
    * @example
    * True

package/src/models/GetBizTraceResponseBody.ts

@@ -4,8 +4,15 @@ import { BizTraceConfig } from "./BizTraceConfig";
 
 
 export class GetBizTraceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The business trace.
+   */
   item?: BizTraceConfig;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */

package/src/models/GetCloudResourceDataRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class GetCloudResourceDataRequest extends $dara.Model {
   /**
    * @remarks
+   * The start of the query time range.
+   * 
+   * The value is a UNIX timestamp in seconds, which represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,8 @@ export class GetCloudResourceDataRequest extends $dara.Model {
   from?: number;
   /**
    * @remarks
+   * The query statement.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +27,10 @@ export class GetCloudResourceDataRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
+   * The end of the query time range.
+   * 
+   * The value is a UNIX timestamp in seconds, which represents the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetCloudResourceDataResponseBody.ts

@@ -2,19 +2,166 @@
 import * as $dara from '@darabonba/typescript';
 
 
+export class GetCloudResourceDataResponseBodyResponseStatusStatusItem extends $dara.Model {
+  /**
+   * @remarks
+   * The status code.
+   * 
+   * @example
+   * Success,ExecuteTimeout,UModelNotExist
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The status level.
+   * 
+   * @example
+   * Info,Warn,Error
+   */
+  level?: string;
+  /**
+   * @remarks
+   * The message content.
+   * 
+   * @example
+   * successful
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The suggestion when an execution error occurs.
+   * 
+   * @example
+   * Try to reduce the query scope or increase timeout limit, then retry
+   */
+  suggestion?: string;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      level: 'level',
+      message: 'message',
+      suggestion: 'suggestion',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      level: 'string',
+      message: 'string',
+      suggestion: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetCloudResourceDataResponseBodyResponseStatus extends $dara.Model {
+  /**
+   * @remarks
+   * The information during execution.
+   * 
+   * @example
+   * {}
+   */
+  executionStates?: string;
+  /**
+   * @remarks
+   * The status level.
+   * 
+   * @example
+   * Info,Warn,Error
+   */
+  level?: string;
+  /**
+   * @remarks
+   * The execution result.
+   * 
+   * @example
+   * Success,PartialSuccess,Error
+   */
+  result?: string;
+  /**
+   * @remarks
+   * The retry policy.
+   * 
+   * @example
+   * None,Once,Continuous
+   */
+  retryPolicy?: string;
+  /**
+   * @remarks
+   * The detailed status information.
+   */
+  statusItem?: GetCloudResourceDataResponseBodyResponseStatusStatusItem[];
+  static names(): { [key: string]: string } {
+    return {
+      executionStates: 'executionStates',
+      level: 'level',
+      result: 'result',
+      retryPolicy: 'retryPolicy',
+      statusItem: 'statusItem',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      executionStates: 'string',
+      level: 'string',
+      result: 'string',
+      retryPolicy: 'string',
+      statusItem: { 'type': 'array', 'itemType': GetCloudResourceDataResponseBodyResponseStatusStatusItem },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.statusItem)) {
+      $dara.Model.validateArray(this.statusItem);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class GetCloudResourceDataResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The total list of returned data.
+   */
   data?: string[][];
+  /**
+   * @remarks
+   * The list of headers.
+   */
   header?: string[];
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The result status.
+   */
+  responseStatus?: GetCloudResourceDataResponseBodyResponseStatus;
   static names(): { [key: string]: string } {
     return {
       data: 'data',
       header: 'header',
       requestId: 'requestId',
+      responseStatus: 'responseStatus',
     };
   }
 
@@ -23,6 +170,7 @@ export class GetCloudResourceDataResponseBody extends $dara.Model {
       data: { 'type': 'array', 'itemType': { 'type': 'array', 'itemType': 'string' } },
       header: { 'type': 'array', 'itemType': 'string' },
       requestId: 'string',
+      responseStatus: GetCloudResourceDataResponseBodyResponseStatus,
     };
   }
 
@@ -33,6 +181,9 @@ export class GetCloudResourceDataResponseBody extends $dara.Model {
     if(Array.isArray(this.header)) {
       $dara.Model.validateArray(this.header);
     }
+    if(this.responseStatus && typeof (this.responseStatus as any).validate === 'function') {
+      (this.responseStatus as any).validate();
+    }
     super.validate();
   }
 

package/src/models/GetCloudResourceResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetCloudResourceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-heyuan
    */
   regionId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/GetCmsServiceRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetCmsServiceRequest extends $dara.Model {
   /**
+   * @remarks
+   * prometheus: Checks the activation status of the Prometheus service. The service is billed by reported data volume or written data volume.
+   * 
    * @example
    * prometheus
    * 
@@ -12,6 +15,9 @@ export class GetCmsServiceRequest extends $dara.Model {
    */
   product?: string;
   /**
+   * @remarks
+   * prometheus: Checks whether the Prometheus product that is billed by reported data volume is activated.prometheusgb: Checks whether the Prometheus product that is billed by written data volume is activated.
+   * 
    * @example
    * prometheus
    * 

package/src/models/GetCmsServiceResponseBody.ts

@@ -4,18 +4,24 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetCmsServiceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the service or product is activated.
+   * 
    * @example
    * false
    */
   enabled?: boolean;
   /**
+   * @remarks
+   * PROM_NOT_OPEN: Prometheus is not activated.SLS_NOT_OPEN: Simple Log Service (SLS), a dependency of Prometheus, is not activated.CMS_SLR_NOT_EXIST: The service-linked role (SLR) for CloudMonitor does not exist.SLS_SLR_NOT_EXIST: The SLR for SLS does not exist.
+   * 
    * @example
    * PROM_NOT_OPEN
    */
   errorCode?: string;
   /**
    * @remarks
-   * Id of the request
+   * The request ID.
    * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****

package/src/models/GetContextRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetContextRequest extends $dara.Model {
   /**
+   * @remarks
+   * Whether to return the context in a formatted structure. Valid values: `true` and `false`. Default value: `false`.
+   * 
    * @example
    * true
    */

package/src/models/GetContextStoreResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetContextStoreResponseBodyConfigInnerSource extends $dara.Model {
   /**
+   * @remarks
+   * The name of the Log Service logstore.
+   * 
    * @example
    * sls-test-logstore
    */
   logstore?: string;
   /**
+   * @remarks
+   * The name of the Log Service project.
+   * 
    * @example
    * sls-test-project
    */
@@ -38,17 +44,25 @@ export class GetContextStoreResponseBodyConfigInnerSource extends $dara.Model {
 
 export class GetContextStoreResponseBodyConfigSource extends $dara.Model {
   /**
+   * @remarks
+   * The name of the Log Service logstore.
+   * 
    * @example
    * sls-test-logstore
    */
   logstore?: string;
   /**
+   * @remarks
+   * The name of the Log Service project.
+   * 
    * @example
    * sls-test-project
    */
   project?: string;
   /**
    * @remarks
+   * The time when the configuration takes effect. This value is a Unix timestamp in milliseconds.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -81,8 +95,20 @@ export class GetContextStoreResponseBodyConfigSource extends $dara.Model {
 }
 
 export class GetContextStoreResponseBodyConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The internal source.
+   */
   innerSource?: GetContextStoreResponseBodyConfigInnerSource;
+  /**
+   * @remarks
+   * The metadata fields.
+   */
   metadataField?: { [key: string]: string };
+  /**
+   * @remarks
+   * The configuration source.
+   */
   source?: GetContextStoreResponseBodyConfigSource;
   static names(): { [key: string]: string } {
     return {
@@ -120,6 +146,9 @@ export class GetContextStoreResponseBodyConfig extends $dara.Model {
 
 export class GetContextStoreResponseBodyDataset extends $dara.Model {
   /**
+   * @remarks
+   * The name of the dataset.
+   * 
    * @example
    * test_dataset
    */
@@ -146,48 +175,78 @@ export class GetContextStoreResponseBodyDataset extends $dara.Model {
 }
 
 export class GetContextStoreResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration of the context store.
+   */
   config?: GetContextStoreResponseBodyConfig;
   /**
+   * @remarks
+   * The context store name.
+   * 
    * @example
    * test-context-store
    */
   contextStoreName?: string;
   /**
+   * @remarks
+   * The type of the context store.
+   * 
    * @example
    * memory
    */
   contextType?: string;
   /**
    * @remarks
+   * The creation time of the context store. This value is a Unix timestamp in seconds.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
    * 1695090077
    */
   createTime?: string;
+  /**
+   * @remarks
+   * Information about the associated dataset.
+   */
   dataset?: GetContextStoreResponseBodyDataset;
   /**
+   * @remarks
+   * The description of the context store.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-beijing
    */
   regionId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The status of the context store.
+   * 
    * @example
    * active
    */
   status?: string;
   /**
    * @remarks
+   * The last update time of the context store. This value is a Unix timestamp in seconds.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -195,6 +254,9 @@ export class GetContextStoreResponseBody extends $dara.Model {
    */
   updateTime?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * workspace-test
    */