@alicloud/cms20240330 9.2.1 → 10.0.0

package/src/models/ListContextStoresRequest.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListContextStoresRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the context store.
+   * 
    * @example
    * test-context-store
    */
   contextStoreName?: string;
   /**
+   * @remarks
+   * The context type.
+   * 
    * @example
    * memory
    */
   contextType?: string;
   /**
+   * @remarks
+   * The maximum number of results to return.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token for the next page of results.
+   * 
    * @example
    * OCAQV0pBqldexv7EidbIZw==
    */

package/src/models/ListContextStoresResponseBody.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListContextStoresResponseBodyResults extends $dara.Model {
   /**
+   * @remarks
+   * The name of the context store.
+   * 
    * @example
    * test-context-store
    */
   contextStoreName?: string;
   /**
+   * @remarks
+   * The context type.
+   * 
    * @example
    * memory
    */
   contextType?: string;
   /**
    * @remarks
+   * The creation time of the context store. The value is a Unix timestamp in milliseconds.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -22,22 +30,33 @@ export class ListContextStoresResponseBodyResults extends $dara.Model {
    */
   createTime?: string;
   /**
+   * @remarks
+   * The description of the context store.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-heyuan
    */
   regionId?: string;
   /**
+   * @remarks
+   * The status of the context store.
+   * 
    * @example
    * active
    */
   status?: string;
   /**
    * @remarks
+   * The last update time of the context store. The value is a Unix timestamp in milliseconds.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -45,6 +64,9 @@ export class ListContextStoresResponseBodyResults extends $dara.Model {
    */
   updateTime?: string;
   /**
+   * @remarks
+   * The ID of the workspace.
+   * 
    * @example
    * workspace-test
    */
@@ -86,22 +108,38 @@ export class ListContextStoresResponseBodyResults extends $dara.Model {
 
 export class ListContextStoresResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The maximum number of results returned per page.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The token to retrieve the next page of results. If this field is empty, all results have been returned.
+   * 
    * @example
    * 2-ba4d-4b9f-aa24-dcb067a30f1c
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The unique ID of the request.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
+  /**
+   * @remarks
+   * A list of context stores.
+   */
   results?: ListContextStoresResponseBodyResults[];
   /**
+   * @remarks
+   * The total number of context stores.
+   * 
    * @example
    * 56
    */

package/src/models/ListDatasetsRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDatasetsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the dataset.
+   * 
    * @example
    * test_dataset
    */
   datasetName?: string;
   /**
+   * @remarks
+   * The maximum number of results to return per page.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token for retrieving the next page of results. A `nextToken` is included in the response when the result set is truncated. To continue pagination, provide the `nextToken` from the previous response.
+   * 
    * @example
    * d9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************
    */

package/src/models/ListDatasetsResponseBody.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListDatasetsResponseBodyDatasets 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
@@ -12,22 +14,33 @@ export class ListDatasetsResponseBodyDatasets extends $dara.Model {
    */
   createTime?: string;
   /**
+   * @remarks
+   * The name of the dataset.
+   * 
    * @example
    * test_dataset
    */
   datasetName?: string;
   /**
+   * @remarks
+   * The description of the dataset.
+   * 
    * @example
    * test dataset
    */
   description?: string;
   /**
+   * @remarks
+   * The ID of the region where the dataset resides.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
    * @remarks
+   * The time the dataset was last updated, as a UNIX timestamp.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -35,6 +48,9 @@ export class ListDatasetsResponseBodyDatasets extends $dara.Model {
    */
   updateTime?: string;
   /**
+   * @remarks
+   * The ID of the workspace that contains the dataset.
+   * 
    * @example
    * workspace-test
    */
@@ -71,23 +87,39 @@ export class ListDatasetsResponseBodyDatasets extends $dara.Model {
 }
 
 export class ListDatasetsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * A list of dataset objects.
+   */
   datasets?: ListDatasetsResponseBodyDatasets[];
   /**
+   * @remarks
+   * The maximum number of results returned per page.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * A token to retrieve the next page of results. This element is returned only when the result set is truncated.
+   * 
    * @example
    * d9a48d977f45aa6fcf6981ed13b885b3fab0b124c12dcbbe70edce5d81ba****************
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of datasets that match the query.
+   * 
    * @example
    * 96
    */

package/src/models/ListDeliveryTasksRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDeliveryTasksRequestTag extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * testKey
    */
   key?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * value1
    */
@@ -38,25 +44,41 @@ export class ListDeliveryTasksRequestTag extends $dara.Model {
 
 export class ListDeliveryTasksRequest extends $dara.Model {
   /**
+   * @remarks
+   * The keywords for a fuzzy search by task name or task ID. The search uses `LIKE` semantics.
+   * 
    * @example
    * test-task
    */
   keyWords?: string;
   /**
+   * @remarks
+   * The number of entries to return on each page. Default value: 20. Maximum value: 100.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. For subsequent requests, set this parameter to the `nextToken` value that is returned in the previous response.
+   * 
    * @example
    * sjC5rekx93Ew7K7VcmI3wkBZBYQ-GphB2ilQu3zJCGxoZuicwyJznfo2riTjr-lq
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-aek2bhocin5e2na
    */
   resourceGroupId?: string;
+  /**
+   * @remarks
+   * A list of tags.
+   */
   tag?: ListDeliveryTasksRequestTag[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListDeliveryTasksResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListDeliveryTasksResponseBodyDeliveryTasksExtraInfo extends $dara.Model {
+  /**
+   * @remarks
+   * A list of EventBridge tasks.
+   */
   taskNameList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -29,8 +33,15 @@ export class ListDeliveryTasksResponseBodyDeliveryTasksExtraInfo extends $dara.M
 }
 
 export class ListDeliveryTasksResponseBodyDeliveryTasksSinkList extends $dara.Model {
+  /**
+   * @remarks
+   * Detailed configuration for the sink. The available key-value pairs depend on the specified `sinkType`.
+   */
   sinkConfigs?: { [key: string]: string };
   /**
+   * @remarks
+   * The type of the sink.
+   * 
    * @example
    * Prometheus
    */
@@ -63,11 +74,17 @@ export class ListDeliveryTasksResponseBodyDeliveryTasksSinkList extends $dara.Mo
 
 export class ListDeliveryTasksResponseBodyDeliveryTasksTags extends $dara.Model {
   /**
+   * @remarks
+   * The key of the resource tag.
+   * 
    * @example
    * key
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the resource tag.
+   * 
    * @example
    * value
    */
@@ -98,6 +115,8 @@ export class ListDeliveryTasksResponseBodyDeliveryTasksTags extends $dara.Model
 export class ListDeliveryTasksResponseBodyDeliveryTasks extends $dara.Model {
   /**
    * @remarks
+   * The time when the delivery task was created.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -105,47 +124,90 @@ export class ListDeliveryTasksResponseBodyDeliveryTasks extends $dara.Model {
    */
   createTime?: string;
   /**
+   * @remarks
+   * The ID of the Prometheus instance that serves as the data source.
+   * 
    * @example
    * rw-5f2b4c7e66342s
    */
   dataSourceId?: string;
+  /**
+   * @remarks
+   * A key-value map of additional labels to attach to all delivered metrics.
+   */
   externalLabels?: { [key: string]: string };
+  /**
+   * @remarks
+   * Additional information.
+   */
   extraInfo?: ListDeliveryTasksResponseBodyDeliveryTasksExtraInfo;
+  /**
+   * @remarks
+   * A key-value map of metric label filters. These filters are used with `labelFiltersType` to determine which metrics to deliver.
+   */
   labelFilters?: { [key: string]: string };
   /**
+   * @remarks
+   * The filtering mode for metric labels.
+   * 
    * @example
    * Allow
    */
   labelFiltersType?: string;
   /**
+   * @remarks
+   * The ID of the resource group to which the task belongs.
+   * 
    * @example
    * rg-acfm3gn5i6bigbi
    */
   resourceGroupId?: string;
+  /**
+   * @remarks
+   * A list of sinks.
+   */
   sinkList?: ListDeliveryTasksResponseBodyDeliveryTasksSinkList[];
   /**
+   * @remarks
+   * The current status of the delivery task.
+   * 
    * @example
    * Enable
    */
   status?: string;
+  /**
+   * @remarks
+   * The resource tags attached to the task.
+   */
   tags?: ListDeliveryTasksResponseBodyDeliveryTasksTags[];
   /**
+   * @remarks
+   * The description of the delivery task.
+   * 
    * @example
    * my delivery task
    */
   taskDescription?: string;
   /**
+   * @remarks
+   * The ID of the delivery task.
+   * 
    * @example
    * db21f8a126d96953
    */
   taskId?: string;
   /**
+   * @remarks
+   * The name of the delivery task.
+   * 
    * @example
    * test-task
    */
   taskName?: string;
   /**
    * @remarks
+   * The time when the task was last updated.
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -215,23 +277,39 @@ export class ListDeliveryTasksResponseBodyDeliveryTasks extends $dara.Model {
 }
 
 export class ListDeliveryTasksResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * A list of delivery tasks.
+   */
   deliveryTasks?: ListDeliveryTasksResponseBodyDeliveryTasks[];
   /**
+   * @remarks
+   * The maximum number of results to return. The maximum value is 100.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token used to retrieve the next page of results. If this parameter is not returned, no more results are available.
+   * 
    * @example
    * 2-ba4d-4b9f-aa24-dcb067a30f1c
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The unique ID for the request.
+   * 
    * @example
    * 7D7DF334-B2F2-5453-AD51-A27B337E3191
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of tasks.
+   * 
    * @example
    * 100
    */

package/src/models/ListDeliveryTasksShrinkRequest.ts

@@ -4,25 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListDeliveryTasksShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * The keywords for a fuzzy search by task name or task ID. The search uses `LIKE` semantics.
+   * 
    * @example
    * test-task
    */
   keyWords?: string;
   /**
+   * @remarks
+   * The number of entries to return on each page. Default value: 20. Maximum value: 100.
+   * 
    * @example
    * 100
    */
   maxResults?: number;
   /**
+   * @remarks
+   * The pagination token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. For subsequent requests, set this parameter to the `nextToken` value that is returned in the previous response.
+   * 
    * @example
    * sjC5rekx93Ew7K7VcmI3wkBZBYQ-GphB2ilQu3zJCGxoZuicwyJznfo2riTjr-lq
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The resource group ID.
+   * 
    * @example
    * rg-aek2bhocin5e2na
    */
   resourceGroupId?: string;
+  /**
+   * @remarks
+   * A list of tags.
+   */
   tagShrink?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ListIntegrationPoliciesRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListIntegrationPoliciesRequestTag extends $dara.Model {
   /**
    * @remarks
-   * Tag key
+   * The tag key.
    * 
    * @example
    * test
@@ -13,7 +13,7 @@ export class ListIntegrationPoliciesRequestTag extends $dara.Model {
   key?: string;
   /**
    * @remarks
-   * Tag value
+   * The tag value.
    * 
    * @example
    * value
@@ -45,7 +45,7 @@ export class ListIntegrationPoliciesRequestTag extends $dara.Model {
 export class ListIntegrationPoliciesRequest extends $dara.Model {
   /**
    * @remarks
-   * Addon name.
+   * The add-on name.
    * 
    * @example
    * cs-default
@@ -53,7 +53,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   addonName?: string;
   /**
    * @remarks
-   * Bound resource ID
+   * The ID of the attached resource.
    * 
    * @example
    * 622d27c2e87d49debceeebc7c642610e
@@ -61,7 +61,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   bindResourceId?: string;
   /**
    * @remarks
-   * Filter for entity IDs, separated by commas
+   * The IDs of the entity groups to filter by. Separate multiple IDs with commas.
    * 
    * @example
    * eg-1,eg-2,eg-3
@@ -69,7 +69,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   entityGroupIds?: string;
   /**
    * @remarks
-   * Used for Region query, separated by commas
+   * The IDs of the regions to query. Separate multiple region IDs with commas.
    * 
    * @example
    * cn-beijing,cn-hangzhou
@@ -77,7 +77,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   filterRegionIds?: string;
   /**
    * @remarks
-   * Maximum number of results to return. Default is 30, with a maximum of 100.
+   * The maximum number of entries to return on each page. The default value is 30. The maximum value is 100.
    * 
    * @example
    * 30
@@ -85,7 +85,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * Used to return more results. This parameter is not required for the first query. For subsequent queries, use the Token obtained from the response.
+   * The token that is used to retrieve the next page of results. You do not need to specify this parameter for the first request. You can obtain the token from the response to the previous request.
    * 
    * @example
    * mvnX6zqg3P
@@ -93,7 +93,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * Policy ID.
+   * The policy ID.
    * 
    * @example
    * policy-93817a401f78435596d745a97d2e85a1
@@ -101,7 +101,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   policyId?: string;
   /**
    * @remarks
-   * Rule name.
+   * The policy name.
    * 
    * @example
    * prod-database
@@ -109,7 +109,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   policyName?: string;
   /**
    * @remarks
-   * Policy type
+   * The policy type.
    * 
    * @example
    * CS
@@ -117,7 +117,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   policyType?: string;
   /**
    * @remarks
-   * Instance ID.
+   * The instance ID.
    * 
    * @example
    * cmee-622d27c2e87d49debceeebc7c642610e
@@ -125,7 +125,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   prometheusInstanceId?: string;
   /**
    * @remarks
-   * Used for general queries
+   * A general-purpose query string.
    * 
    * @example
    * test
@@ -133,7 +133,7 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
-   * Resource group ID.
+   * The resource group ID.
    * 
    * @example
    * rg-xxxxx
@@ -141,12 +141,12 @@ export class ListIntegrationPoliciesRequest extends $dara.Model {
   resourceGroupId?: string;
   /**
    * @remarks
-   * Tag list.
+   * The list of tags.
    */
   tag?: ListIntegrationPoliciesRequestTag[];
   /**
    * @remarks
-   * Workspace.
+   * The workspace.
    * 
    * @example
    * demo