@alicloud/cms20240330 9.2.1 → 10.0.0

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
    */

package/src/models/GetDatasetResponseBody.ts

@@ -6,6 +6,8 @@ import { IndexKey } from "./IndexKey";
 export class GetDatasetResponseBody extends $dara.Model {
   /**
    * @remarks
+   * The time the dataset was created, as a Unix timestamp.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -13,28 +15,46 @@ export class GetDatasetResponseBody extends $dara.Model {
    */
   createTime?: string;
   /**
+   * @remarks
+   * The name of the dataset.
+   * 
    * @example
    * test_dataset
    */
   datasetName?: string;
   /**
+   * @remarks
+   * The description of the dataset.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * The ID of the region where the dataset is located.
+   * 
    * @example
    * cn-heyuan
    */
   regionId?: string;
   /**
+   * @remarks
+   * The unique identifier for the request.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * The data schema of the dataset.
+   */
   schema?: { [key: string]: IndexKey };
   /**
    * @remarks
+   * The time the dataset was last updated, as a Unix timestamp.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -42,6 +62,9 @@ export class GetDatasetResponseBody extends $dara.Model {
    */
   updateTime?: string;
   /**
+   * @remarks
+   * The workspace ID.
+   * 
    * @example
    * workspace-test
    */

package/src/models/GetDeliveryTaskResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetDeliveryTaskResponseBodyDeliveryTaskExtraInfo extends $dara.Model {
+  /**
+   * @remarks
+   * The names of the associated EventBridge tasks.
+   */
   taskNameList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -29,8 +33,15 @@ export class GetDeliveryTaskResponseBodyDeliveryTaskExtraInfo extends $dara.Mode
 }
 
 export class GetDeliveryTaskResponseBodyDeliveryTaskSinkList extends $dara.Model {
+  /**
+   * @remarks
+   * The sink configuration. The structure of this object depends on the value of `sinkType`. For details, see CreateDeliveryTask.
+   */
   sinkConfigs?: { [key: string]: string };
   /**
+   * @remarks
+   * The sink type.
+   * 
    * @example
    * Prometheus
    */
@@ -63,11 +74,17 @@ export class GetDeliveryTaskResponseBodyDeliveryTaskSinkList extends $dara.Model
 
 export class GetDeliveryTaskResponseBodyDeliveryTaskTags extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * sourcetype
    */
   key?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * production
    */
@@ -98,6 +115,8 @@ export class GetDeliveryTaskResponseBodyDeliveryTaskTags extends $dara.Model {
 export class GetDeliveryTaskResponseBodyDeliveryTask extends $dara.Model {
   /**
    * @remarks
+   * The creation time.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -105,47 +124,90 @@ export class GetDeliveryTaskResponseBodyDeliveryTask extends $dara.Model {
    */
   createTime?: string;
   /**
+   * @remarks
+   * The data source ID (the Prometheus instance ID).
+   * 
    * @example
    * rw-xxxxxx
    */
   dataSourceId?: string;
+  /**
+   * @remarks
+   * A map of key-value pairs to add as external labels to all delivered metrics.
+   */
   externalLabels?: { [key: string]: string };
+  /**
+   * @remarks
+   * The extra information.
+   */
   extraInfo?: GetDeliveryTaskResponseBodyDeliveryTaskExtraInfo;
+  /**
+   * @remarks
+   * The label filters, used with `labelFiltersType`. In each filter, the key is the metric label and the value is the value to match.
+   */
   labelFilters?: { [key: string]: string };
   /**
+   * @remarks
+   * The label filter type.
+   * 
    * @example
    * Allow
    */
   labelFiltersType?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-chengdu
    */
   regionId?: string;
+  /**
+   * @remarks
+   * An array of sink configurations.
+   */
   sinkList?: GetDeliveryTaskResponseBodyDeliveryTaskSinkList[];
   /**
+   * @remarks
+   * The task status.
+   * 
    * @example
    * Pending2Running
    */
   status?: string;
+  /**
+   * @remarks
+   * The tags attached to the task.
+   */
   tags?: GetDeliveryTaskResponseBodyDeliveryTaskTags[];
   /**
+   * @remarks
+   * The task description.
+   * 
    * @example
    * my delivery task
    */
   taskDescription?: string;
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * 8b07eeac8249866d
    */
   taskId?: string;
   /**
+   * @remarks
+   * The task name.
+   * 
    * @example
    * test-task
    */
   taskName?: string;
   /**
    * @remarks
+   * The update time.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -215,8 +277,15 @@ export class GetDeliveryTaskResponseBodyDeliveryTask extends $dara.Model {
 }
 
 export class GetDeliveryTaskResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The delivery task details.
+   */
   deliveryTask?: GetDeliveryTaskResponseBodyDeliveryTask;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 0CEC5375-C554-562B-A65F-9A629907C1F0
    */

package/src/models/GetEntityStoreDataHeaders.ts

@@ -6,7 +6,7 @@ export class GetEntityStoreDataHeaders extends $dara.Model {
   commonHeaders?: { [key: string]: string };
   /**
    * @remarks
-   * Content encoding type for the compression algorithm
+   * The content encoding type of the compression algorithm.
    * 
    * @example
    * gzip

package/src/models/GetEntityStoreDataRequest.ts

@@ -5,9 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class GetEntityStoreDataRequest extends $dara.Model {
   /**
    * @remarks
-   * Start time of the query.
+   * The start point in time for the query.
    * 
-   * Unix timestamp format, representing the number of seconds since 1970-1-1 00:00:00 UTC.
+   * This is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.
    * 
    * This parameter is required.
    * 
@@ -17,7 +17,7 @@ export class GetEntityStoreDataRequest extends $dara.Model {
   from?: number;
   /**
    * @remarks
-   * Query statement
+   * The search statement.
    * 
    * This parameter is required.
    * 
@@ -27,9 +27,9 @@ export class GetEntityStoreDataRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
-   * End time of the query.
+   * The end point in time for the query.
    * 
-   * Unix timestamp format, representing the number of seconds since 1970-1-1 00:00:00 UTC.
+   * This is a UNIX timestamp. It represents the number of seconds that have elapsed since 00:00:00 UTC on January 1, 1970.
    * 
    * This parameter is required.
    * 

package/src/models/GetEntityStoreDataResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetEntityStoreDataResponseBodyResponseStatusStatusItem extends $dara.Model {
   /**
    * @remarks
-   * Status code
+   * The status code.
    * 
    * @example
    * Success,ExecuteTimeout,UModelNotExist
@@ -13,7 +13,7 @@ export class GetEntityStoreDataResponseBodyResponseStatusStatusItem extends $dar
   code?: string;
   /**
    * @remarks
-   * Status level
+   * The status level.
    * 
    * @example
    * Info,Warn,Error
@@ -21,7 +21,7 @@ export class GetEntityStoreDataResponseBodyResponseStatusStatusItem extends $dar
   level?: string;
   /**
    * @remarks
-   * Calculation execution information
+   * The execution information.
    * 
    * @example
    * Query execution timeout after 30 seconds
@@ -29,7 +29,7 @@ export class GetEntityStoreDataResponseBodyResponseStatusStatusItem extends $dar
   message?: string;
   /**
    * @remarks
-   * Suggestions when an error occurs during execution
+   * The suggestion provided when an execution fault occurs.
    * 
    * @example
    * Try to reduce the query scope or increase timeout limit, then retry
@@ -65,7 +65,7 @@ export class GetEntityStoreDataResponseBodyResponseStatusStatusItem extends $dar
 export class GetEntityStoreDataResponseBodyResponseStatus extends $dara.Model {
   /**
    * @remarks
-   * Information during the execution process
+   * Information about the execution procedure.
    * 
    * @example
    * {}
@@ -73,7 +73,7 @@ export class GetEntityStoreDataResponseBodyResponseStatus extends $dara.Model {
   executionStates?: string;
   /**
    * @remarks
-   * Status level
+   * The status level.
    * 
    * @example
    * Info,Warn,Error
@@ -81,7 +81,7 @@ export class GetEntityStoreDataResponseBodyResponseStatus extends $dara.Model {
   level?: string;
   /**
    * @remarks
-   * Execution result
+   * The execution result.
    * 
    * @example
    * Success,PartialSuccess,Error
@@ -89,7 +89,7 @@ export class GetEntityStoreDataResponseBodyResponseStatus extends $dara.Model {
   result?: string;
   /**
    * @remarks
-   * Retry policy
+   * The retry policy.
    * 
    * @example
    * None,Once,Continuous
@@ -97,7 +97,7 @@ export class GetEntityStoreDataResponseBodyResponseStatus extends $dara.Model {
   retryPolicy?: string;
   /**
    * @remarks
-   * Detailed status information list
+   * A list of detailed status information.
    */
   statusItem?: GetEntityStoreDataResponseBodyResponseStatusStatusItem[];
   static names(): { [key: string]: string } {
@@ -135,17 +135,17 @@ export class GetEntityStoreDataResponseBodyResponseStatus extends $dara.Model {
 export class GetEntityStoreDataResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Total list of returned data
+   * The list of returned data.
    */
   data?: string[][];
   /**
    * @remarks
-   * List of request headers
+   * The list of request headers.
    */
   header?: string[];
   /**
    * @remarks
-   * Request ID
+   * The request ID.
    * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
@@ -153,7 +153,7 @@ export class GetEntityStoreDataResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Result status
+   * The result status.
    */
   responseStatus?: GetEntityStoreDataResponseBodyResponseStatus;
   static names(): { [key: string]: string } {

package/src/models/GetEntityStoreResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetEntityStoreResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Region ID
+   * The region ID.
    * 
    * @example
    * cn-heyuan
@@ -13,7 +13,7 @@ export class GetEntityStoreResponseBody extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Request ID
+   * The request ID.
    * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
@@ -21,7 +21,7 @@ export class GetEntityStoreResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Workspace name
+   * The name of the workspace.
    * 
    * @example
    * workspace-test-001