@alicloud/cms20240330 3.2.3 → 3.2.5

package/src/models/ListWorkspacesResponseBody.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   /**
    * @remarks
+   * Creation time
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -13,19 +15,24 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * 工作空间描述
+   * Workspace description
    * 
    * @example
    * workspace test
    */
   description?: string;
   /**
+   * @remarks
+   * Workspace display name
+   * 
    * @example
    * workspace-test
    */
   displayName?: string;
   /**
    * @remarks
+   * Last modified time
+   * 
    * Use the UTC time format: yyyy-MM-ddTHH:mm:ssZ
    * 
    * @example
@@ -34,7 +41,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   lastModifyTime?: string;
   /**
    * @remarks
-   * 地域ID
+   * Region ID
    * 
    * @example
    * cn-heyuan
@@ -42,7 +49,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * 工作空间绑定的日志服务项目名称
+   * Log Service project name
    * 
    * @example
    * sls-project-test-001
@@ -50,7 +57,7 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
   slsProject?: string;
   /**
    * @remarks
-   * 工作空间名称
+   * Workspace name
    * 
    * This parameter is required.
    * 
@@ -93,25 +100,45 @@ export class ListWorkspacesResponseBodyWorkspaces extends $dara.Model {
 
 export class ListWorkspacesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Page size
+   * Default value:
+   * 	50
+   * Maximum value:
+   * 	50
+   * 
    * @example
    * 10
    */
   maxResults?: number;
   /**
+   * @remarks
+   * Pagination Token
+   * 
    * @example
    * xxxxxxxxxx
    */
   nextToken?: string;
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */
   requestId?: string;
   /**
+   * @remarks
+   * Total count
+   * 
    * @example
    * 1
    */
   total?: number;
+  /**
+   * @remarks
+   * List of workspaces
+   */
   workspaces?: ListWorkspacesResponseBodyWorkspaces[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListWorkspacesShrinkRequest.ts

@@ -4,16 +4,29 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListWorkspacesShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * Page size
+   * Default value:
+   * 	50
+   * Maximum value:
+   * 	50
+   * 
    * @example
    * 10
    */
   maxResults?: number;
   /**
+   * @remarks
+   * Pagination Token
+   * 
    * @example
    * xxxxxxxxxx
    */
   nextToken?: string;
   /**
+   * @remarks
+   * Region
+   * 
    * @example
    * cn-heyuan
    * 
@@ -22,11 +35,17 @@ export class ListWorkspacesShrinkRequest extends $dara.Model {
    */
   region?: string;
   /**
+   * @remarks
+   * Workspace name, fuzzy search
+   * 
    * @example
    * workspace-test-001
    */
   workspaceName?: string;
   /**
+   * @remarks
+   * Workspace name, exact match
+   * 
    * @example
    * workspace-test-001
    * 

package/src/models/PutWorkspaceRequest.ts

@@ -5,20 +5,23 @@ import * as $dara from '@darabonba/typescript';
 export class PutWorkspaceRequest extends $dara.Model {
   /**
    * @remarks
-   * 工作空间描述
+   * Description of the workspace
    * 
    * @example
    * workspace test
    */
   description?: string;
   /**
+   * @remarks
+   * Display name of the workspace
+   * 
    * @example
    * workspace-test
    */
   displayName?: string;
   /**
    * @remarks
-   * 工作空间绑定的日志服务项目名称
+   * Name of the Log Service project
    * 
    * This parameter is required.
    * 

package/src/models/PutWorkspaceResponseBody.ts

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

package/src/models/UpdateAddonReleaseRequest.ts

@@ -5,17 +5,30 @@ import { EntityDiscoverRule } from "./EntityDiscoverRule";
 
 export class UpdateAddonReleaseRequest extends $dara.Model {
   /**
+   * @remarks
+   * Addon version information.
+   * 
    * @example
    * 0.0.2
    */
   addonVersion?: string;
   /**
+   * @remarks
+   * Whether to pre-check this request.
+   * 
    * @example
    * true
    */
   dryRun?: boolean;
+  /**
+   * @remarks
+   * Entity discovery rules.
+   */
   entityRules?: EntityDiscoverRule;
   /**
+   * @remarks
+   * Metadata information.
+   * 
    * @example
    * {"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}
    */

package/src/models/UpdateAddonReleaseResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateAddonReleaseResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 9F00A7AF-2728-5424-B321-79D39C00A1EC
    */

package/src/models/UpdateAggTaskGroupRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateAggTaskGroupRequestTags extends $dara.Model {
   /**
+   * @remarks
+   * Key of the resource group tag.
+   * 
    * @example
    * key1
    */
   key?: string;
   /**
+   * @remarks
+   * Value of the resource group tag.
+   * 
    * @example
    * value1
    */
@@ -39,6 +45,8 @@ export class UpdateAggTaskGroupRequestTags extends $dara.Model {
 export class UpdateAggTaskGroupRequest extends $dara.Model {
   /**
    * @remarks
+   * Aggregation task group configuration. Currently, only the “RecordingRuleYaml” format is supported, and it must comply with the format requirements of open-source Prometheus RecordingRules.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -52,68 +60,110 @@ export class UpdateAggTaskGroupRequest extends $dara.Model {
    */
   aggTaskGroupConfig?: string;
   /**
+   * @remarks
+   * Aggregation task group configuration type, default is “RecordingRuleYaml” (open-source Prometheus RecordingRule format).
+   * 
    * @example
    * RecordingRuleYaml
    */
   aggTaskGroupConfigType?: string;
   /**
+   * @remarks
+   * Aggregation task group name.
+   * 
    * @example
    * test-group
    */
   aggTaskGroupName?: string;
   /**
+   * @remarks
+   * When the scheduling mode is set to “Cron”, this is the specific scheduling expression. For example, “0/1 * * * *” means starting from 0 minutes, schedule every 1 minute.
+   * 
    * @example
    * 0/1 * * * *
    */
   cronExpr?: string;
   /**
+   * @remarks
+   * Fixed delay time for scheduling, in seconds, default is 30.
+   * 
    * @example
    * 30
    */
   delay?: number;
   /**
+   * @remarks
+   * Description of the aggregation task group.
+   * 
    * @example
    * desc
    */
   description?: string;
   /**
+   * @remarks
+   * The second-level timestamp corresponding to the start time of the scheduling.
+   * 
    * @example
    * 1724996015
    */
   fromTime?: number;
   /**
+   * @remarks
+   * Maximum number of retries for executing the aggregation task, default is 20.
+   * 
    * @example
    * 20
    */
   maxRetries?: number;
   /**
+   * @remarks
+   * Maximum retry time for executing the aggregation task, in seconds, default is 600.
+   * 
    * @example
    * 600
    */
   maxRunTimeInSeconds?: number;
   /**
+   * @remarks
+   * Pre-check configuration, no configuration by default. The input string needs to be correctly parsed as JSON.
+   * 
    * @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"}
    */
   precheckString?: string;
   /**
+   * @remarks
+   * Scheduling mode, either “Cron” or “FixedRate”, default is “FixedRate”.
+   * 
    * @example
    * FixedRate
    */
   scheduleMode?: string;
   /**
+   * @remarks
+   * Scheduling time expression, recommended values are “@s” or “@m”, indicating the granularity of the scheduling time window alignment, default is “@m”.
+   * 
    * @example
    * @m
    */
   scheduleTimeExpr?: string;
   /**
+   * @remarks
+   * Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.
+   * 
    * @example
    * Running
    */
   status?: string;
+  /**
+   * @remarks
+   * Resource group tags.
+   */
   tags?: UpdateAggTaskGroupRequestTags[];
   /**
    * @remarks
+   * Target Prometheus instance ID of the aggregation task group.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -121,6 +171,9 @@ export class UpdateAggTaskGroupRequest extends $dara.Model {
    */
   targetPrometheusId?: string;
   /**
+   * @remarks
+   * The second-level timestamp corresponding to the end time of the scheduling, 0 indicates that the scheduling does not stop.
+   * 
    * @example
    * 0
    */

package/src/models/UpdateAggTaskGroupResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateAggTaskGroupResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Summary of the aggregation task group configuration.
+   * 
    * @example
    * a54136014dc386a92c83a6ef1e97ff22
    */
   aggTaskGroupConfigHash?: string;
   /**
+   * @remarks
+   * Aggregation task group ID
+   * 
    * @example
    * aggTaskGroup-5fb2c3ade63a4709bcb059d13493b7b8
    */
   aggTaskGroupId?: string;
   /**
+   * @remarks
+   * Aggregation task group name
+   * 
    * @example
    * pipeline-aggtask-group
    */
   aggTaskGroupName?: string;
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****
    */
   requestId?: string;
   /**
+   * @remarks
+   * Source Prometheus instance ID of the aggregation task group
+   * 
    * @example
    * rw-083e17834e279f8c627fe91a2d72
    */
   sourcePrometheusId?: string;
   /**
+   * @remarks
+   * Current status of the aggregation task group
+   * 
    * @example
    * Running
    */

package/src/models/UpdateAggTaskGroupStatusRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateAggTaskGroupStatusRequest extends $dara.Model {
   /**
    * @remarks
+   * Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/UpdateAggTaskGroupStatusResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateAggTaskGroupStatusResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Summary of the aggregation task group configuration.
+   * 
    * @example
    * a54136014dc386a92c83a6ef1e97ff22
    */
   aggTaskGroupConfigHash?: string;
   /**
+   * @remarks
+   * Aggregation task group ID.
+   * 
    * @example
    * aggTaskGroup-xxx
    */
   aggTaskGroupId?: string;
   /**
+   * @remarks
+   * Aggregation task group name.
+   * 
    * @example
    * pipeline-aggtask-group
    */
   aggTaskGroupName?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 0CEC5375-C554-562B-A65F-***
    */
   requestId?: string;
   /**
+   * @remarks
+   * Source Prometheus instance ID of the aggregation task group.
+   * 
    * @example
    * rw-xxx
    */
   sourcePrometheusId?: string;
   /**
+   * @remarks
+   * The current status of the aggregated task group.
+   * 
    * @example
    * Running
    */

package/src/models/UpdateIntegrationPolicyRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdateIntegrationPolicyRequestTags extends $dara.Model {
   /**
+   * @remarks
+   * Tag `key` value.
+   * 
    * @example
    * algo_bhv_expose_in_airec_exposure
    */
   key?: string;
   /**
+   * @remarks
+   * Tag `value` value.
+   * 
    * @example
    * [{\\"Id\\": \\"kgqie6hm\\", \\"Name\\": \\"Sheet1\\"}]
    */
@@ -38,20 +44,33 @@ export class UpdateIntegrationPolicyRequestTags extends $dara.Model {
 
 export class UpdateIntegrationPolicyRequest extends $dara.Model {
   /**
+   * @remarks
+   * Fee package type, CS_Pro/CS_Basic/empty.
+   * 
    * @example
    * CS_Pro
    */
   feePackage?: string;
   /**
+   * @remarks
+   * Rule name, minimum 3 characters, maximum 63 characters, must start with a letter.
+   * 
    * @example
    * metrics-inner-manage
    */
   policyName?: string;
   /**
+   * @remarks
+   * Resource group ID of the instance.
+   * 
    * @example
    * rg-aekzoiafjtr7zyq
    */
   resourceGroupId?: string;
+  /**
+   * @remarks
+   * Resource tags.
+   */
   tags?: UpdateIntegrationPolicyRequestTags[];
   static names(): { [key: string]: string } {
     return {

package/src/models/UpdateIntegrationPolicyResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class UpdateIntegrationPolicyResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 0CEC5375-C554-562B-A65F-9A629907C1F0

package/src/models/UpdatePrometheusInstanceRequest.ts

@@ -4,6 +4,11 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdatePrometheusInstanceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The number of days to automatically archive and save after the storage expires, 0 means no archiving. The range of archiving days:
+   * V1: 1~365 days. Only supported for metric write volume.
+   * V2: 1~3650 days (3650 indicates permanent storage).
+   * 
    * @example
    * 365
    * 
@@ -12,51 +17,103 @@ export class UpdatePrometheusInstanceRequest extends $dara.Model {
    */
   archiveDuration?: number;
   /**
+   * @remarks
+   * Password-free read policy (supports IP segments and VpcId).
+   * 
    * @example
-   * 0.0.0.0/0
+   * {
+   *   "SourceIp": [
+   *     "192.168.1.0/24",
+   *     "172.168.2.22"
+   *   ],
+   *   "SourceVpc": [
+   *     "vpc-xx1",
+   *     "vpc-xx2"
+   *   ]
+   * }
    */
   authFreeReadPolicy?: string;
   /**
+   * @remarks
+   * Password-free write policy (supports IP segments and VpcId).
+   * 
    * @example
-   * true
+   * {
+   *   "SourceIp": [
+   *     "192.168.1.0/24",
+   *     "172.168.2.22"
+   *   ],
+   *   "SourceVpc": [
+   *     "vpc-xx1",
+   *     "vpc-xx2"
+   *   ]
+   * }
    */
   authFreeWritePolicy?: string;
   /**
+   * @remarks
+   * Whether to enable password-free read.
+   * 
    * @example
    * true
    */
   enableAuthFreeRead?: boolean;
   /**
+   * @remarks
+   * Whether to enable password-free write.
+   * 
    * @example
    * true
    */
   enableAuthFreeWrite?: boolean;
   /**
+   * @remarks
+   * Whether to enable access token authentication.
+   * 
    * @example
    * true
    */
   enableAuthToken?: boolean;
   /**
+   * @remarks
+   * Billing method (can only be modified once during the instance\\"s lifecycle):
+   * POSTPAY: Postpaid by metric reporting volume.
+   * POSTPAY_GB: Postpaid by metric write volume.
+   * 
    * @example
    * POSTPAY_GB
    */
   paymentType?: string;
   /**
+   * @remarks
+   * Instance name.
+   * 
    * @example
    * test-prom-name
    */
   prometheusInstanceName?: string;
   /**
+   * @remarks
+   * Instance storage DB status (only supports RUNNING). If empty, the storage DB status will not be changed.
+   * 
    * @example
    * RUNNING
    */
   status?: string;
   /**
+   * @remarks
+   * Storage duration (days):
+   * By write volume: 90, 180.
+   * By metric reporting volume: 15, 30, 60, 90, 180.
+   * 
    * @example
    * 90
    */
   storageDuration?: number;
   /**
+   * @remarks
+   * Belonging workspace.
+   * 
    * @example
    * default-cms-1500199863951574-cn-shanghai
    */

package/src/models/UpdatePrometheusInstanceResponseBody.ts

@@ -4,13 +4,16 @@ import * as $dara from '@darabonba/typescript';
 
 export class UpdatePrometheusInstanceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * rw-abc123
    */
   prometheusInstanceId?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 1E92F783-E057-58F1-BD5C-92DED088E7A5