@alicloud/cms20240330 9.2.2 → 10.0.0

package/src/models/CreateAggTaskGroupRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAggTaskGroupRequestTags extends $dara.Model {
   /**
    * @remarks
-   * Key of the resource group tag.
+   * The key of the resource group tag.
    * 
    * @example
    * key1
@@ -13,7 +13,7 @@ export class CreateAggTaskGroupRequestTags extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Value of the resource group tag.
+   * The value of the resource group tag.
    * 
    * @example
    * value1
@@ -45,8 +45,8 @@ export class CreateAggTaskGroupRequestTags extends $dara.Model {
 export class CreateAggTaskGroupRequest extends $dara.Model {
   /**
    * @remarks
-   * Aggregation task group configuration.
-   * Currently, only the “RecordingRuleYaml” format is supported, which must comply with the format requirements of open-source Prometheus RecordingRules.
+   * The configuration of the aggregation task group.
+   * Only the \\`RecordingRuleYaml\\` format is supported. The configuration must follow the format of RecordingRule for open source Prometheus.
    * 
    * This parameter is required.
    * 
@@ -62,7 +62,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   aggTaskGroupConfig?: string;
   /**
    * @remarks
-   * Aggregation task group configuration type, default is “RecordingRuleYaml” (open-source Prometheus RecordingRule format).
+   * The type of the aggregation task group configuration. The default value is \\`RecordingRuleYaml\\`. This is the format of RecordingRule for open source Prometheus.
    * 
    * @example
    * RecordingRuleYaml
@@ -70,7 +70,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   aggTaskGroupConfigType?: string;
   /**
    * @remarks
-   * Aggregation task group name.
+   * The name of the aggregation task group.
    * 
    * This parameter is required.
    * 
@@ -80,7 +80,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   aggTaskGroupName?: string;
   /**
    * @remarks
-   * When the scheduling mode is selected as “Cron”, this is the specific scheduling expression. For example, “0/1 * * * *” means starting from 0 minutes and scheduling every 1 minute.
+   * The cron expression for scheduling when \\`scheduleMode\\` is set to \\`Cron\\`. For example, \\`0/1 \\* \\* \\* \\*\\` indicates that the task is scheduled every minute, starting from minute 0.
    * 
    * @example
    * 0/1 * * * *
@@ -88,7 +88,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   cronExpr?: string;
   /**
    * @remarks
-   * Fixed delay time for scheduling, in seconds, default is 30.
+   * The fixed delay for scheduling. Unit: seconds. The default value is 30.
    * 
    * @example
    * 30
@@ -96,7 +96,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   delay?: number;
   /**
    * @remarks
-   * Description of the aggregation task group.
+   * The description of the aggregation task group.
    * 
    * @example
    * desc
@@ -104,7 +104,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The second-level timestamp corresponding to the start time of the schedule.
+   * The UNIX timestamp for the scheduling start time. Unit: seconds.
    * 
    * @example
    * 1724996015
@@ -112,7 +112,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   fromTime?: number;
   /**
    * @remarks
-   * Maximum number of retries for executing the aggregation task, default is 20.
+   * The maximum number of retries for an aggregation task. The default value is 20.
    * 
    * @example
    * 20
@@ -120,7 +120,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   maxRetries?: number;
   /**
    * @remarks
-   * Maximum retry time for executing the aggregation task, in seconds, default is 600.
+   * The maximum retry time for an aggregation task. Unit: seconds. The default value is 600.
    * 
    * @example
    * 600
@@ -128,7 +128,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   maxRunTimeInSeconds?: number;
   /**
    * @remarks
-   * Pre-check configuration, no configuration by default. The input string needs to be correctly parsed as JSON.
+   * The dry run configuration. This parameter is not configured by default. The input string must be a parsable JSON string.
    * 
    * @example
    * {"policy":"skip","prometheusId":"xxx","query":"scalar(sum(count_over_time(up{job=\\"_arms/kubelet/cadvisor\\"}[15s])) / 21)","threshold":0.5,"timeout":15,"type":"promql"}
@@ -136,7 +136,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   precheckString?: string;
   /**
    * @remarks
-   * Scheduling mode, either “Cron” or “FixedRate”, default is “FixedRate”.
+   * The scheduling mode. Valid values: \\`Cron\\` and \\`FixedRate\\`. The default value is \\`FixedRate\\`.
    * 
    * @example
    * FixedRate
@@ -144,7 +144,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   scheduleMode?: string;
   /**
    * @remarks
-   * Scheduling time expression, recommended “@s” or “@m”, indicating the alignment granularity of the scheduling time window, default is “@m”.
+   * The scheduling time expression. The recommended values are \\`@s\\` and \\`@m\\`. This expression specifies the granularity to which the time window is snapped. The default value is \\`@m\\`.
    * 
    * @example
    * @m
@@ -152,7 +152,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   scheduleTimeExpr?: string;
   /**
    * @remarks
-   * Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.
+   * The status of the aggregation task group. Valid values: \\`Running\\` and \\`Stopped\\`. The default value is \\`Running\\`.
    * 
    * @example
    * Running
@@ -160,12 +160,12 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Resource group tags.
+   * The tags of the resource group.
    */
   tags?: CreateAggTaskGroupRequestTags[];
   /**
    * @remarks
-   * The target Prometheus instance ID of the aggregation task group.
+   * The ID of the target Prometheus instance for the aggregation task group.
    * 
    * This parameter is required.
    * 
@@ -175,7 +175,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   targetPrometheusId?: string;
   /**
    * @remarks
-   * The second-level timestamp corresponding to the end time of the schedule, 0 indicates that the scheduling does not stop.
+   * The UNIX timestamp for the scheduling end time. Unit: seconds. A value of 0 means that scheduling does not stop.
    * 
    * @example
    * 0
@@ -183,7 +183,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   toTime?: number;
   /**
    * @remarks
-   * Whether to overwrite and update if a resource with the same name exists when creating an aggregation task group.
+   * Specifies whether to overwrite an existing resource with the same name.
    * 
    * @example
    * true

package/src/models/CreateAggTaskGroupResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAggTaskGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Summary of the aggregation task group configuration.
+   * The summary of the aggregation task group configuration.
    * 
    * @example
    * a54136014dc386a92c83a6ef1e97ff22
@@ -13,7 +13,7 @@ export class CreateAggTaskGroupResponseBody extends $dara.Model {
   aggTaskGroupConfigHash?: string;
   /**
    * @remarks
-   * Aggregation task group ID.
+   * The ID of the aggregation task group.
    * 
    * @example
    * aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f
@@ -21,7 +21,7 @@ export class CreateAggTaskGroupResponseBody extends $dara.Model {
   aggTaskGroupId?: string;
   /**
    * @remarks
-   * Aggregation task group name.
+   * The name of the aggregation task group.
    * 
    * @example
    * pipeline-aggtask-group
@@ -29,7 +29,7 @@ export class CreateAggTaskGroupResponseBody extends $dara.Model {
   aggTaskGroupName?: string;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7
@@ -37,7 +37,7 @@ export class CreateAggTaskGroupResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * Source Prometheus instance ID of the aggregation task group.
+   * The ID of the source Prometheus instance for the aggregation task group.
    * 
    * @example
    * rw-ecc04af14729b1a16e40a0d10068
@@ -45,7 +45,7 @@ export class CreateAggTaskGroupResponseBody extends $dara.Model {
   sourcePrometheusId?: string;
   /**
    * @remarks
-   * Current status of the aggregation task group.
+   * The current status of the aggregation task group.
    * 
    * @example
    * Pending2Running

package/src/models/CreateAlertWebhookRequest.ts

@@ -4,27 +4,50 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAlertWebhookRequest extends $dara.Model {
   /**
+   * @remarks
+   * The content type. Valid values:
+   * 
+   * - JSON (default)
+   * 
+   * - FORM
+   * 
    * @example
    * JSON
    */
   contentType?: string;
   /**
    * @remarks
-   * headers
+   * The headers.
    */
   headers?: { [key: string]: string };
   /**
+   * @remarks
+   * The language. Valid values:
+   * 
+   * - zh_CN
+   * 
+   * - en_US
+   * 
    * @example
    * zh_CN
    */
   lang?: string;
   /**
+   * @remarks
+   * The request method. Valid values:
+   * 
+   * - GET
+   * 
+   * - POST
+   * 
    * @example
    * GET
    */
   method?: string;
   /**
    * @remarks
+   * The name of the webhook.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,6 +56,8 @@ export class CreateAlertWebhookRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
+   * The URL for the alert callback.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -40,6 +65,9 @@ export class CreateAlertWebhookRequest extends $dara.Model {
    */
   url?: string;
   /**
+   * @remarks
+   * The unique ID of the webhook.
+   * 
    * @example
    * test
    */

package/src/models/CreateAlertWebhookResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAlertWebhookResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique ID of the webhook.
+   * 
    * @example
    * test
    */
   alertWebhookId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/CreateBizTraceRequest.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateBizTraceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The advanced configuration.
+   * 
    * @example
    * {"sample":{"strategy":"BY_APP"}}
    */
   advancedConfig?: string;
   /**
+   * @remarks
+   * The identifier for the business trace. It can contain only letters, digits, and underscores (_). The first character must be a lowercase letter.
+   * 
    * @example
    * label_env
    */
   bizTraceCode?: string;
   /**
+   * @remarks
+   * The name of the business trace.
+   * 
    * @example
    * just test
    */
   bizTraceName?: string;
   /**
+   * @remarks
+   * The configuration rules.
+   * 
    * @example
    * [{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]
    */
   ruleConfig?: string;
   /**
+   * @remarks
+   * The workspace.
+   * 
    * @example
    * default-cms-xxxxxxx-cn-hangzhou
    */

package/src/models/CreateBizTraceResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateBizTraceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the business trace.
+   * 
    * @example
    * e339260ed64c95d
    */
   bizTraceId?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/CreateCloudResourceResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateCloudResourceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/CreateContextStoreApikeyRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateContextStoreAPIKeyRequest extends $dara.Model {
   /**
    * @remarks
+   * The display name of the API key. Use this name to identify its purpose.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateContextStoreApikeyResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateContextStoreAPIKeyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The value of the API key. This value is returned only upon creation. Store it in a secure location.
+   * 
    * @example
    * sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The display name of the API key.
+   * 
    * @example
    * Production Service Key
    */
   name?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 3B311FD9-A60B-55E0-A896-A0C73*********
    */

package/src/models/CreateContextStoreRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateContextStoreRequestConfigSource 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 effective start time.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -47,7 +55,15 @@ export class CreateContextStoreRequestConfigSource extends $dara.Model {
 }
 
 export class CreateContextStoreRequestConfig extends $dara.Model {
+  /**
+   * @remarks
+   * The metadata fields.
+   */
   metadataField?: { [key: string]: string };
+  /**
+   * @remarks
+   * The configuration source.
+   */
   source?: CreateContextStoreRequestConfigSource;
   static names(): { [key: string]: string } {
     return {
@@ -80,6 +96,9 @@ export class CreateContextStoreRequestConfig extends $dara.Model {
 
 export class CreateContextStoreRequestDataset extends $dara.Model {
   /**
+   * @remarks
+   * The name of the dataset.
+   * 
    * @example
    * test_dataset
    */
@@ -106,9 +125,15 @@ export class CreateContextStoreRequestDataset extends $dara.Model {
 }
 
 export class CreateContextStoreRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration.
+   */
   config?: CreateContextStoreRequestConfig;
   /**
    * @remarks
+   * The name of the context store.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -117,14 +142,23 @@ export class CreateContextStoreRequest extends $dara.Model {
   contextStoreName?: string;
   /**
    * @remarks
+   * The type of the context store.
+   * 
    * This parameter is required.
    * 
    * @example
    * memory
    */
   contextType?: string;
+  /**
+   * @remarks
+   * The properties of the dataset.
+   */
   dataset?: CreateContextStoreRequestDataset;
   /**
+   * @remarks
+   * The description of the context store.
+   * 
    * @example
    * desc
    */

package/src/models/CreateContextStoreResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateContextStoreResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * E5B1D3D4-BB28-5996-8AD2-***********
    */

package/src/models/CreateDatasetRequest.ts

@@ -6,6 +6,8 @@ import { IndexKey } from "./IndexKey";
 export class CreateDatasetRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the dataset.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,12 +15,17 @@ export class CreateDatasetRequest extends $dara.Model {
    */
   datasetName?: string;
   /**
+   * @remarks
+   * The description of the dataset.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
    * @remarks
+   * The schema of the dataset.
+   * 
    * This parameter is required.
    */
   schema?: { [key: string]: IndexKey };

package/src/models/CreateDatasetResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateDatasetResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/CreateDeliveryTaskRequest.ts

@@ -3,9 +3,15 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class CreateDeliveryTaskRequestSinkList extends $dara.Model {
+  /**
+   * @remarks
+   * The configuration for the sink, specified as key-value pairs. The valid keys and values depend on the value of `sinkType`.
+   */
   sinkConfigs?: { [key: string]: string };
   /**
    * @remarks
+   * The type of the delivery destination (sink).
+   * 
    * This parameter is required.
    * 
    * @example
@@ -40,11 +46,17 @@ export class CreateDeliveryTaskRequestSinkList extends $dara.Model {
 
 export class CreateDeliveryTaskRequestTags extends $dara.Model {
   /**
+   * @remarks
+   * The key of the resource tag.
+   * 
    * @example
    * _cms_workspace
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the resource tag.
+   * 
    * @example
    * test
    */
@@ -75,37 +87,64 @@ export class CreateDeliveryTaskRequestTags extends $dara.Model {
 export class CreateDeliveryTaskRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the Prometheus instance that serves as the data source.
+   * 
    * This parameter is required.
    * 
    * @example
    * rw-xxxxxx
    */
   dataSourceId?: string;
+  /**
+   * @remarks
+   * A map of key-value pairs to attach as additional labels to all delivered metrics.
+   */
   externalLabels?: { [key: string]: string };
+  /**
+   * @remarks
+   * The label conditions for filtering metrics. The key is the label name and the value is the value to match. The filtering behavior is controlled by `labelFiltersType`.
+   */
   labelFilters?: { [key: string]: string };
   /**
+   * @remarks
+   * The mode for applying the label filters.
+   * 
    * @example
    * Allow
    */
   labelFiltersType?: string;
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
    * rg-ae******ey
    */
   resourceGroupId?: string;
   /**
    * @remarks
+   * An array of delivery destination objects.
+   * 
    * This parameter is required.
    */
   sinkList?: CreateDeliveryTaskRequestSinkList[];
+  /**
+   * @remarks
+   * An array of resource tags.
+   */
   tags?: CreateDeliveryTaskRequestTags[];
   /**
+   * @remarks
+   * The task description.
+   * 
    * @example
    * my delivery task
    */
   taskDescription?: string;
   /**
    * @remarks
+   * The name of the task. The name can contain Chinese characters, English letters, underscores (_), and hyphens (-).
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateDeliveryTaskResponseBody.ts

@@ -5,13 +5,16 @@ import * as $dara from '@darabonba/typescript';
 export class CreateDeliveryTaskResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * The unique ID for the request.
    * 
    * @example
    * 4CB23A2E-B426-5D4B-9AA2-6C7A508D954B
    */
   requestId?: string;
   /**
+   * @remarks
+   * The ID of the delivery task.
+   * 
    * @example
    * 98e367d8fb8cc83b
    */

package/src/models/CreateEntityStoreResponseBody.ts

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