@alicloud/cms20240330 3.2.4 → 3.3.0

package/src/models/CreateAddonReleaseRequest.ts

@@ -6,6 +6,8 @@ import { EntityDiscoverRule } from "./EntityDiscoverRule";
 export class CreateAddonReleaseRequest extends $dara.Model {
   /**
    * @remarks
+   * The Addon name of the component that needs to be monitored.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,38 +15,62 @@ export class CreateAddonReleaseRequest extends $dara.Model {
    */
   addonName?: string;
   /**
+   * @remarks
+   * The language type of the component.
+   * 
    * @example
    * zh
    */
   aliyunLang?: string;
   /**
+   * @remarks
+   * Whether it is a dry run, default is false.
+   * 
    * @example
    * false
    */
   dryRun?: boolean;
+  /**
+   * @remarks
+   * Field rules
+   */
   entityRules?: EntityDiscoverRule;
   /**
+   * @remarks
+   * Environment type. If the Policy type is CS and ECS, use accordingly; otherwise, it is unified as Cloud.
+   * 
    * @example
    * CS
    */
   envType?: string;
   /**
+   * @remarks
+   * Parent AddonReleaseId.
+   * 
    * @example
    * policy-xxxxxxxxxxx
    */
   parentAddonReleaseId?: string;
   /**
+   * @remarks
+   * The plugin name after access. If not specified, a default rule name will be generated.
+   * 
    * @example
    * test-gpu-integration-name
    */
   releaseName?: string;
   /**
+   * @remarks
+   * Input metadata.
+   * 
    * @example
    * {"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}
    */
   values?: string;
   /**
    * @remarks
+   * The version of the Addon component that needs to be monitored.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -52,6 +78,9 @@ export class CreateAddonReleaseRequest extends $dara.Model {
    */
   version?: string;
   /**
+   * @remarks
+   * The workspace name for installing the component resources.
+   * 
    * @example
    * default
    */

package/src/models/CreateAddonReleaseResponseBody.ts

@@ -5,26 +5,41 @@ import { EntityGroupBase } from "./EntityGroupBase";
 
 export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
   /**
+   * @remarks
+   * First transition time.
+   * 
    * @example
    * 2024-11-04T16:10:22+08:00
    */
   firstTransitionTime?: string;
   /**
+   * @remarks
+   * Last transition time.
+   * 
    * @example
    * 2024-11-04T16:10:22+08:00
    */
   lastTransitionTime?: string;
   /**
+   * @remarks
+   * Detailed information.
+   * 
    * @example
    * The addon loaded successfully
    */
   message?: string;
   /**
+   * @remarks
+   * Phase status.
+   * 
    * @example
    * {\\"phase\\": \\"Created\\", \\"executionDetails\\": [], \\"invocations\\": [], \\"latestExecError\\": {\\"message\\": \\"\\", \\"code\\": \\"\\", \\"requestId\\": \\"\\", \\"extraInfo\\": \\"\\", \\"title\\": \\"\\"}}
    */
   status?: string;
   /**
+   * @remarks
+   * Phase type.
+   * 
    * @example
    * Loaded
    */
@@ -60,118 +75,195 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
 
 export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   /**
+   * @remarks
+   * The Addon name of the component being monitored.
+   * 
    * @example
    * cs-gpu
    */
   addonName?: string;
   /**
+   * @remarks
+   * Number of alert groups.
+   * 
    * @example
    * 6
    */
   alertRuleCount?: number;
+  /**
+   * @remarks
+   * Component installation phase information.
+   */
   conditions?: CreateAddonReleaseResponseBodyReleaseConditions[];
   /**
+   * @remarks
+   * Component configuration.
+   * 
    * @example
    * {"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}
    */
   config?: string;
   /**
+   * @remarks
+   * Connection time.
+   * 
    * @example
    * 2024-11-05T15:21:30+08:00
    */
   createTime?: string;
   /**
+   * @remarks
+   * Number of dashboards.
+   * 
    * @example
    * 3
    */
   dashboardCount?: number;
+  /**
+   * @remarks
+   * Entity details.
+   */
   entityRules?: EntityGroupBase;
   /**
+   * @remarks
+   * Environment type.
+   * 
    * @example
    * CS
    */
   envType?: string;
   /**
+   * @remarks
+   * Environment ID.
+   * 
    * @example
    * policy-xxxxxxxxxxx
    */
   environmentId?: string;
   /**
+   * @remarks
+   * Number of plugins.
+   * 
    * @example
    * 2
    */
   exporterCount?: number;
   /**
+   * @remarks
+   * Whether it has configuration.
+   * 
    * @example
    * true
    */
   haveConfig?: boolean;
   /**
+   * @remarks
+   * ID of the user who installed it.
+   * 
    * @example
    * 1654218965xxxxxx
    */
   installUserId?: string;
   /**
+   * @remarks
+   * Language.
+   * 
    * @example
    * zh
    */
   language?: string;
   /**
+   * @remarks
+   * Whether it is a managed component.
+   * 
    * @example
    * true
    */
   managed?: boolean;
   /**
+   * @remarks
+   * Parent AddonReleaseId.
+   * 
    * @example
    * policy-xxxxxxxxxxx
    */
   parentAddonReleaseId?: string;
   /**
+   * @remarks
+   * Policy environment ID.
+   * 
    * @example
    * policy-xxxxxxxxxx
    */
   policyId?: string;
   /**
+   * @remarks
+   * Region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * ReleaseID after installation.
+   * 
    * @example
    * 2e898e60-5e6a-46d1-a994-xxxxxxxxxx
    */
   releaseId?: string;
   /**
+   * @remarks
+   * Name of the Release.
+   * 
    * @example
    * test-gpu-integration-name
    */
   releaseName?: string;
   /**
+   * @remarks
+   * Component scenario.
+   * 
    * @example
    * 1
    */
   scene?: string;
   /**
+   * @remarks
+   * Component status.
+   * 
    * @example
    * 200
    */
   status?: string;
   /**
+   * @remarks
+   * Update time.
+   * 
    * @example
    * 2024-09-13T02:21:02Z
    */
   updateTime?: string;
   /**
+   * @remarks
+   * ID of the owner user.
+   * 
    * @example
    * 165421896xxxxxx
    */
   userId?: string;
   /**
+   * @remarks
+   * Component version.
+   * 
    * @example
    * 1.0.0
    */
   version?: string;
   /**
+   * @remarks
+   * Workspace.
+   * 
    * @example
    * default
    */
@@ -252,8 +344,15 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
 }
 
 export class CreateAddonReleaseResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Accessed component information.
+   */
   release?: CreateAddonReleaseResponseBodyRelease;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 0CEC5375-C554-562B-A65F-9A629907C1F0
    */

package/src/models/CreateAggTaskGroupRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAggTaskGroupRequestTags 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,9 @@ 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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -52,12 +61,17 @@ export class CreateAggTaskGroupRequest 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.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -65,58 +79,94 @@ 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.
+   * 
    * @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 schedule.
+   * 
    * @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 “@s” or “@m”, indicating the alignment granularity of the scheduling time window, 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?: CreateAggTaskGroupRequestTags[];
   /**
    * @remarks
+   * The target Prometheus instance ID of the aggregation task group.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -124,11 +174,17 @@ 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.
+   * 
    * @example
    * 0
    */
   toTime?: number;
   /**
+   * @remarks
+   * Whether to overwrite and update if a resource with the same name exists when creating an aggregation task group.
+   * 
    * @example
    * true
    */

package/src/models/CreateAggTaskGroupResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAggTaskGroupResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Summary of the aggregation task group configuration.
+   * 
    * @example
    * a54136014dc386a92c83a6ef1e97ff22
    */
   aggTaskGroupConfigHash?: string;
   /**
+   * @remarks
+   * Aggregation task group ID.
+   * 
    * @example
    * aggTaskGroup-f4b8e50525cf41c894488c0c71ec483f
    */
   aggTaskGroupId?: string;
   /**
+   * @remarks
+   * Aggregation task group name.
+   * 
    * @example
    * pipeline-aggtask-group
    */
   aggTaskGroupName?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 16C0A6D6-C3E7-511D-A60B-A87FD85F5BA7
    */
   requestId?: string;
   /**
+   * @remarks
+   * Source Prometheus instance ID of the aggregation task group.
+   * 
    * @example
    * rw-ecc04af14729b1a16e40a0d10068
    */
   sourcePrometheusId?: string;
   /**
+   * @remarks
+   * Current status of the aggregation task group.
+   * 
    * @example
    * Pending2Running
    */

package/src/models/CreateEntityStoreResponseBody.ts

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

package/src/models/CreateIntegrationPolicyRequest.ts

@@ -4,22 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
   /**
+   * @remarks
+   * Cluster entity type, such as acs.ack.cluster/acs.one.cluster/acs.asi.cluster or others.
+   * 
    * @example
    * acs.ack.cluster
    */
   clusterEntityType?: string;
   /**
+   * @remarks
+   * Cluster ID.
+   * 
    * @example
    * na61prod3-na61cloudhdfsssd
    */
   clusterId?: string;
+  /**
+   * @remarks
+   * Whether to disable the unique binding of the Policy. If enabled, multiple Policies can be created for a single container cluster.
+   * 
+   * @example
+   * ture
+   */
   disablePolicyShare?: boolean;
   /**
+   * @remarks
+   * Entity group ID.
+   * 
    * @example
    * eg-b79f65d11fb94e779867cf937c3a3002
    */
   entityGroupId?: string;
   /**
+   * @remarks
+   * User ID to which the cluster belongs.
+   * 
+   * @example
+   * 12xxxx
+   */
+  entityUserId?: string;
+  /**
+   * @remarks
+   * VPC ID.
+   * 
    * @example
    * vpc-bp18fgg3ffxa9czna40xt
    */
@@ -30,6 +57,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
       clusterId: 'clusterId',
       disablePolicyShare: 'disablePolicyShare',
       entityGroupId: 'entityGroupId',
+      entityUserId: 'entityUserId',
       vpcId: 'vpcId',
     };
   }
@@ -40,6 +68,7 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
       clusterId: 'string',
       disablePolicyShare: 'boolean',
       entityGroupId: 'string',
+      entityUserId: 'string',
       vpcId: 'string',
     };
   }
@@ -55,11 +84,17 @@ export class CreateIntegrationPolicyRequestEntityGroup extends $dara.Model {
 
 export class CreateIntegrationPolicyRequestTags extends $dara.Model {
   /**
+   * @remarks
+   * Tag `key` value.
+   * 
    * @example
    * use
    */
   key?: string;
   /**
+   * @remarks
+   * Tag `value` value.
+   * 
    * @example
    * database
    */
@@ -88,14 +123,23 @@ export class CreateIntegrationPolicyRequestTags extends $dara.Model {
 }
 
 export class CreateIntegrationPolicyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Entity group for creating the policy. Policies can be quickly created using the entity group, and `clusterId` and `vpcId` are independent of each other.
+   */
   entityGroup?: CreateIntegrationPolicyRequestEntityGroup;
   /**
+   * @remarks
+   * Policy name
+   * 
    * @example
    * prod-database
    */
   policyName?: string;
   /**
    * @remarks
+   * Policy type: CS/ECS/Cloud
+   * 
    * This parameter is required.
    * 
    * @example
@@ -103,12 +147,22 @@ export class CreateIntegrationPolicyRequest extends $dara.Model {
    */
   policyType?: string;
   /**
+   * @remarks
+   * Resource group ID.
+   * 
    * @example
    * rg-aekz2km4kmhtbii
    */
   resourceGroupId?: string;
+  /**
+   * @remarks
+   * Resource tags.
+   */
   tags?: CreateIntegrationPolicyRequestTags[];
   /**
+   * @remarks
+   * Workspace.
+   * 
    * @example
    * prometheus
    */