@alicloud/cms20240330 9.2.2 → 10.0.1

package/src/models/EntityGroupBase.ts

@@ -5,11 +5,17 @@ import { EntityDiscoverRule } from "./EntityDiscoverRule";
 
 export class EntityGroupBaseEntityQueries extends $dara.Model {
   /**
+   * @remarks
+   * The entity type.
+   * 
    * @example
    * acs.ecs.instance
    */
   entityType?: string;
   /**
+   * @remarks
+   * The Structured Process Language (SPL) search statement.
+   * 
    * @example
    * .entity with(type=\\"acs.ecs.instance\\") | where region_id in (\\"cn-beijing\\")
    */
@@ -38,26 +44,60 @@ export class EntityGroupBaseEntityQueries extends $dara.Model {
 }
 
 export class EntityGroupBase extends $dara.Model {
+  /**
+   * @remarks
+   * The entity description.
+   * 
+   * @example
+   * ECS 实例
+   */
   description?: string;
   /**
+   * @remarks
+   * The entity ID.
+   * 
    * @example
    * eg-1234567890
    */
   entityGroupId?: string;
+  /**
+   * @remarks
+   * The entity name.
+   * 
+   * @example
+   * ECS 全部实体
+   */
   entityGroupName?: string;
+  /**
+   * @remarks
+   * A collection of entity query rules.
+   */
   entityQueries?: EntityGroupBaseEntityQueries[];
+  /**
+   * @remarks
+   * The rule for entity discovery.
+   */
   entityRules?: EntityDiscoverRule;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-heyuan
    */
   regionId?: string;
   /**
+   * @remarks
+   * The user ID.
+   * 
    * @example
    * 1654218***343050
    */
   userId?: string;
   /**
+   * @remarks
+   * The workspace.
+   * 
    * @example
    * default-cms-1654218***343050-cn-hangzhou
    */

package/src/models/EventResourceForEventView.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class EventResourceForEventViewEntity extends $dara.Model {
   /**
+   * @remarks
+   * The product domain to which the resource belongs.
+   * 
    * @example
    * "ECS"
    */
   domain?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * "i-bp123456"
    */
   entityId?: string;
   /**
+   * @remarks
+   * The specific type of the resource.
+   * 
    * @example
    * "Instance"
    */
   entityType?: string;
   /**
+   * @remarks
+   * Extra properties of the resource.
+   * 
    * @example
    * { "name": "web-server-01", "ip": "10.0.0.1" }
    */
@@ -54,8 +66,15 @@ export class EventResourceForEventViewEntity extends $dara.Model {
 }
 
 export class EventResourceForEventView extends $dara.Model {
+  /**
+   * @remarks
+   * The resource entity.
+   */
   entity?: EventResourceForEventViewEntity;
   /**
+   * @remarks
+   * The tags.
+   * 
    * @example
    * { "env": "prod", "project": "payment-gateway" }
    */

package/src/models/EventResourceForIncidentView.ts

@@ -4,25 +4,44 @@ import * as $dara from '@darabonba/typescript';
 
 export class EventResourceForIncidentView extends $dara.Model {
   /**
+   * @remarks
+   * The domain of the resource type.
+   * 
    * @example
    * rum
    */
   domain?: string;
   /**
+   * @remarks
+   * The entity ID.
+   * 
    * @example
    * default
    */
   entityId?: string;
   /**
+   * @remarks
+   * The entity type.
+   * 
    * @example
    * "Instance"
    */
   entityType?: string;
   /**
+   * @remarks
+   * The string that describes the properties of the resource.
+   * 
    * @example
    * "{"name":"web-server-01","ip":"10.0.0.1"}"
    */
   probs?: string;
+  /**
+   * @remarks
+   * The tags.
+   * 
+   * @example
+   * [{\\"value\\":\\"测试\\",\\"key\\":\\"环境\\"}]
+   */
   tags?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/ExecuteQueryRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ExecuteQueryRequest extends $dara.Model {
   /**
    * @remarks
+   * The query statement to execute.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ExecuteQueryRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
+   * The query type. Valid values: SQL and SPL.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ExecuteQueryResponseBody.ts

@@ -4,21 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class ExecuteQueryResponseBodyMeta extends $dara.Model {
   /**
+   * @remarks
+   * The number of scanned or processed log entries.
+   * 
    * @example
    * 1
    */
   affectedRows?: number;
   /**
+   * @remarks
+   * The number of log entries returned.
+   * 
    * @example
    * 1
    */
   count?: number;
   /**
+   * @remarks
+   * The query execution time in milliseconds.
+   * 
    * @example
    * 1231243
    */
   elapsedMillisecond?: number;
   /**
+   * @remarks
+   * The query completion status. A value of `Complete` indicates that the query has finished.
+   * 
    * @example
    * Complete
    */
@@ -51,9 +63,20 @@ export class ExecuteQueryResponseBodyMeta extends $dara.Model {
 }
 
 export class ExecuteQueryResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * An array of log entries. Each object in the array represents a log entry.
+   */
   data?: { [key: string]: string }[];
+  /**
+   * @remarks
+   * Metadata about the query execution.
+   */
   meta?: ExecuteQueryResponseBodyMeta;
   /**
+   * @remarks
+   * The unique request ID.
+   * 
    * @example
    * 3B311FD9-A60B-55E0-A896-A0C73*********
    */

package/src/models/FilterCondition.ts

@@ -0,0 +1,45 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class FilterCondition extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the field to filter on.
+   */
+  field?: string;
+  /**
+   * @remarks
+   * The comparison operator, such as `equals` or `startsWith`.
+   */
+  op?: string;
+  /**
+   * @remarks
+   * The value to match for the specified field and operator.
+   */
+  value?: string;
+  static names(): { [key: string]: string } {
+    return {
+      field: 'field',
+      op: 'op',
+      value: 'value',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      field: 'string',
+      op: 'string',
+      value: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/FilterSetting.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class FilterSettingConditions extends $dara.Model {
   /**
+   * @remarks
+   * The field.
+   * 
    * @example
    * severity
    */
   field?: string;
   /**
+   * @remarks
+   * The comparison operator.
+   * 
    * @example
    * EQ
    */
   op?: string;
   /**
+   * @remarks
+   * The value.
+   * 
    * @example
    * CRITICAL
    */
@@ -44,13 +53,23 @@ export class FilterSettingConditions extends $dara.Model {
 }
 
 export class FilterSetting extends $dara.Model {
+  /**
+   * @remarks
+   * The subscription conditions.
+   */
   conditions?: FilterSettingConditions[];
   /**
+   * @remarks
+   * The expression.
+   * 
    * @example
    * 1 and 2 or 3
    */
   expression?: string;
   /**
+   * @remarks
+   * The relationship between conditions.
+   * 
    * @example
    * AND
    */

package/src/models/GetAddonCodeTemplateRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAddonCodeTemplateRequest extends $dara.Model {
   /**
+   * @remarks
+   * The language. Valid values: zh (Chinese) and en (English). Default value: zh.
+   * 
    * @example
    * zh
    */
   aliyunLang?: string;
   /**
+   * @remarks
+   * The type of environment. Valid values: CS (Container Service) and ECS.
+   * 
    * @example
    * Client
    */
   environmentType?: string;
   /**
+   * @remarks
+   * The version of the component.
+   * 
    * @example
    * 0.1.0
    */

package/src/models/GetAddonCodeTemplateResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAddonCodeTemplateResponseBodyCodes extends $dara.Model {
   /**
+   * @remarks
+   * The code template.
+   * 
    * @example
    * javascript\\nnpm install @arms/rum-miniapp --save
    */
   codeTemplate?: string;
   /**
+   * @remarks
+   * The name of the code template.
+   * 
    * @example
    * cs-default-CS-cs-default-1753236205394-cs-default-CS-kubeApiserver
    */
@@ -37,10 +43,14 @@ export class GetAddonCodeTemplateResponseBodyCodes extends $dara.Model {
 }
 
 export class GetAddonCodeTemplateResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of code templates.
+   */
   codes?: GetAddonCodeTemplateResponseBodyCodes[];
   /**
    * @remarks
-   * Id of the request
+   * The ID of the request.
    * 
    * @example
    * 0CEC5375-C554-562B-A65F-***

package/src/models/GetAddonReleaseResponseBody.ts

@@ -6,7 +6,7 @@ import { EntityGroupBase } from "./EntityGroupBase";
 export class GetAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
   /**
    * @remarks
-   * First transition time.
+   * The time when the phase first transitioned.
    * 
    * @example
    * 2024-11-04T16:10:22+08:00
@@ -14,7 +14,7 @@ export class GetAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
   firstTransitionTime?: string;
   /**
    * @remarks
-   * Last transition time.
+   * The time when the phase last transitioned.
    * 
    * @example
    * 2024-11-04T16:10:22+08:00
@@ -22,7 +22,7 @@ export class GetAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
   lastTransitionTime?: string;
   /**
    * @remarks
-   * Details.
+   * The detailed message.
    * 
    * @example
    * The addon loaded successfully
@@ -30,7 +30,7 @@ export class GetAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
   message?: string;
   /**
    * @remarks
-   * Phase status.
+   * The status of the phase.
    * 
    * @example
    * True
@@ -38,7 +38,7 @@ export class GetAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Phase type.
+   * The type of the phase.
    * 
    * @example
    * Loaded
@@ -76,7 +76,7 @@ export class GetAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
 export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   /**
    * @remarks
-   * Addon component name.
+   * The name of the add-on component.
    * 
    * @example
    * cs-gpu
@@ -84,7 +84,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   addonName?: string;
   /**
    * @remarks
-   * Number of alert rules.
+   * The number of alert rules.
    * 
    * @example
    * 6
@@ -92,12 +92,12 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   alertRuleCount?: number;
   /**
    * @remarks
-   * Installation phase information.
+   * Information about the installation phases.
    */
   conditions?: GetAddonReleaseResponseBodyReleaseConditions[];
   /**
    * @remarks
-   * Component configuration information.
+   * The configuration information of the component.
    * 
    * @example
    * {"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}
@@ -105,7 +105,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * Connection time.
+   * The time when the add-on was accessed.
    * 
    * @example
    * 2024-11-04T16:10:12+08:00
@@ -113,7 +113,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * Number of dashboards.
+   * The number of dashboards.
    * 
    * @example
    * 3
@@ -121,12 +121,12 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   dashboardCount?: number;
   /**
    * @remarks
-   * Entity details.
+   * The details of the entity.
    */
   entityRules?: EntityGroupBase;
   /**
    * @remarks
-   * Environment type.
+   * The type of the environment.
    * 
    * @example
    * CS
@@ -134,7 +134,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   envType?: string;
   /**
    * @remarks
-   * Environment ID.
+   * The ID of the environment.
    * 
    * @example
    * policy-xxxxxxxxxxx
@@ -142,7 +142,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * Number of plugins.
+   * The number of plug-ins.
    * 
    * @example
    * 2
@@ -150,7 +150,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   exporterCount?: number;
   /**
    * @remarks
-   * Whether there is a configuration.
+   * Indicates whether a configuration exists.
    * 
    * @example
    * true
@@ -158,7 +158,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   haveConfig?: boolean;
   /**
    * @remarks
-   * User ID for connection.
+   * The ID of the user who accessed the add-on.
    * 
    * @example
    * 1707xxxxxxxxxxxx
@@ -166,7 +166,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   installUserId?: string;
   /**
    * @remarks
-   * Language.
+   * The language.
    * 
    * @example
    * zh
@@ -174,7 +174,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   language?: string;
   /**
    * @remarks
-   * Whether it is a managed component.
+   * Indicates whether the component is a managed component.
    * 
    * @example
    * true
@@ -182,7 +182,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   managed?: boolean;
   /**
    * @remarks
-   * Parent AddonRelease ID.
+   * The ID of the parent add-on release.
    * 
    * @example
    * policy-xxxxxxxxxxxxx
@@ -190,7 +190,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   parentAddonReleaseId?: string;
   /**
    * @remarks
-   * Policy ID.
+   * The ID of the policy.
    * 
    * @example
    * policy-xxxxxxxxxxxxx
@@ -198,7 +198,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   policyId?: string;
   /**
    * @remarks
-   * Region ID.
+   * The ID of the region.
    * 
    * @example
    * cn-hangzhou
@@ -206,7 +206,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * Release ID.
+   * The ID of the release.
    * 
    * @example
    * 7339d808-66f9-4d40-83fa-xxxxxxxxxxx
@@ -214,7 +214,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   releaseId?: string;
   /**
    * @remarks
-   * The name of the Release.
+   * The name of the release.
    * 
    * @example
    * test-gpu-integration-name
@@ -222,7 +222,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   releaseName?: string;
   /**
    * @remarks
-   * Component scenario.
+   * The scenario of the component.
    * 
    * @example
    * container
@@ -230,7 +230,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   scene?: string;
   /**
    * @remarks
-   * Component status.
+   * The status of the component.
    * 
    * @example
    * running
@@ -238,7 +238,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Update time.
+   * The time when the release was last updated.
    * 
    * @example
    * 2024-11-04T16:10:12+08:00
@@ -246,7 +246,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * Owner user ID.
+   * The ID of the user to which the release belongs.
    * 
    * @example
    * 1707xxxxxxxxxxxx
@@ -254,7 +254,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   userId?: string;
   /**
    * @remarks
-   * Component version.
+   * The version of the component.
    * 
    * @example
    * 0.0.2
@@ -262,7 +262,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * Workspace.
+   * The workspace.
    * 
    * @example
    * default
@@ -346,7 +346,7 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
 export class GetAddonReleaseResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Component configuration.
+   * The configuration of the component.
    * 
    * @example
    * {"install":{"mode":"auto-install","listenPort":"9400"},"discoverMode":"instances","discover":{"instances":"worker-k8s-for-cs-c126d87c76218487e83ab322017f11b44"},"scrapeInterval":"15","enableSecuritecs-nodeyGroupInjection":"true","metricTags":""}
@@ -354,12 +354,12 @@ export class GetAddonReleaseResponseBody extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * Detailed information.
+   * The details of the release.
    */
   release?: GetAddonReleaseResponseBodyRelease;
   /**
    * @remarks
-   * Request ID.
+   * The ID of the request.
    * 
    * @example
    * 0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8

package/src/models/GetAddonRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAddonRequest extends $dara.Model {
   /**
+   * @remarks
+   * The language of the response. Valid values: zh and en. Default value: zh.
+   * 
    * @example
    * zh
    */
   aliyunLang?: string;
   /**
+   * @remarks
+   * The version number of the add-on.
+   * 
    * @example
    * *
    */