@alicloud/cms20240330 3.2.3 → 3.2.5

package/src/models/DeletePrometheusViewResponseBody.ts

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

package/src/models/DeleteServiceResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteServiceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * 51B6A3E8-EA9E-5143-BE11-8E5F83474C95
    */

package/src/models/DeleteUmodelDataRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteUmodelDataRequest extends $dara.Model {
   /**
+   * @remarks
+   * Can specify the name of a specific Umodel data, leaving it blank means all
+   * 
    * @example
    * apm
    */
   domain?: string;
   /**
+   * @remarks
+   * Can specify the kind of a specific Umodel data, leaving it blank means all
+   * 
    * @example
    * metric_set
    */
   kind?: string;
   /**
+   * @remarks
+   * Can specify the name of a specific Umodel data, leaving it blank means all
+   * 
    * @example
    * test
    */

package/src/models/DeleteUmodelDataResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteUmodelDataResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * 111111-222-333-1111-33333
    */

package/src/models/DeleteUmodelResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteUmodelResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * request ID
+   * 
    * @example
    * 123123-3213-345-9941-345345345
    */

package/src/models/DeleteWorkspaceResponseBody.ts

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

package/src/models/GetAddonReleaseResponseBody.ts

@@ -5,26 +5,41 @@ import { EntityGroupBase } from "./EntityGroupBase";
 
 export class GetAddonReleaseResponseBodyReleaseConditions 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
+   * Details.
+   * 
    * @example
    * The addon loaded successfully
    */
   message?: string;
   /**
+   * @remarks
+   * Phase status.
+   * 
    * @example
    * True
    */
   status?: string;
   /**
+   * @remarks
+   * Phase type.
+   * 
    * @example
    * Loaded
    */
@@ -60,121 +75,195 @@ export class GetAddonReleaseResponseBodyReleaseConditions extends $dara.Model {
 
 export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
   /**
+   * @remarks
+   * Addon component name.
+   * 
    * @example
    * cs-gpu
    */
   addonName?: string;
   /**
+   * @remarks
+   * Number of alert rules.
+   * 
    * @example
    * 6
    */
   alertRuleCount?: number;
+  /**
+   * @remarks
+   * Installation phase information.
+   */
   conditions?: GetAddonReleaseResponseBodyReleaseConditions[];
   /**
+   * @remarks
+   * Component configuration information.
+   * 
    * @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-04T16:10:12+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 there is a configuration.
+   * 
    * @example
    * true
    */
   haveConfig?: boolean;
   /**
+   * @remarks
+   * User ID for connection.
+   * 
    * @example
    * 1707xxxxxxxxxxxx
    */
   installUserId?: string;
   /**
+   * @remarks
+   * Language.
+   * 
    * @example
    * zh
    */
   language?: string;
   /**
+   * @remarks
+   * Whether it is a managed component.
+   * 
    * @example
    * true
    */
   managed?: boolean;
   /**
+   * @remarks
+   * Parent AddonRelease ID.
+   * 
    * @example
    * policy-xxxxxxxxxxxxx
    */
   parentAddonReleaseId?: string;
   /**
+   * @remarks
+   * Policy ID.
+   * 
    * @example
    * policy-xxxxxxxxxxxxx
    */
   policyId?: string;
   /**
+   * @remarks
+   * Region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
    * @remarks
-   * Release ID。
+   * Release ID.
    * 
    * @example
    * 7339d808-66f9-4d40-83fa-xxxxxxxxxxx
    */
   releaseId?: string;
   /**
+   * @remarks
+   * The name of the Release.
+   * 
    * @example
    * test-gpu-integration-name
    */
   releaseName?: string;
   /**
+   * @remarks
+   * Component scenario.
+   * 
    * @example
    * container
    */
   scene?: string;
   /**
+   * @remarks
+   * Component status.
+   * 
    * @example
    * running
    */
   status?: string;
   /**
+   * @remarks
+   * Update time.
+   * 
    * @example
    * 2024-11-04T16:10:12+08:00
    */
   updateTime?: string;
   /**
+   * @remarks
+   * Owner user ID.
+   * 
    * @example
    * 1707xxxxxxxxxxxx
    */
   userId?: string;
   /**
+   * @remarks
+   * Component version.
+   * 
    * @example
    * 0.0.2
    */
   version?: string;
   /**
+   * @remarks
+   * Workspace.
+   * 
    * @example
    * default
    */
@@ -256,12 +345,22 @@ export class GetAddonReleaseResponseBodyRelease extends $dara.Model {
 
 export class GetAddonReleaseResponseBody extends $dara.Model {
   /**
+   * @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
+   * Detailed information.
+   */
   release?: GetAddonReleaseResponseBodyRelease;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 0B9377D9-C56B-5C2E-A8A4-A01D6CC3F4B8
    */

package/src/models/GetAggTaskGroupResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetAggTaskGroupResponseBodyAggTaskGroupTags extends $dara.Model {
   /**
+   * @remarks
+   * Key of the resource group tag.
+   * 
    * @example
    * key1
    */
   key?: string;
   /**
+   * @remarks
+   * The value of the resource group tag.
+   * 
    * @example
    * value1
    */
@@ -38,6 +44,9 @@ export class GetAggTaskGroupResponseBodyAggTaskGroupTags extends $dara.Model {
 
 export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
   /**
+   * @remarks
+   * Aggregation task group configuration.
+   * 
    * @example
    * groups:
    * - name: "node.rules"
@@ -49,97 +58,158 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
    */
   aggTaskGroupConfig?: string;
   /**
+   * @remarks
+   * Summary of the aggregation task group configuration.
+   * 
    * @example
    * a54136xxx
    */
   aggTaskGroupConfigHash?: string;
   /**
+   * @remarks
+   * ID of the aggregation task group.
+   * 
    * @example
    * aggTaskGroup-xx
    */
   aggTaskGroupId?: string;
   /**
+   * @remarks
+   * Name of the aggregation task group.
+   * 
    * @example
    * pipeline-aggtask-group
    */
   aggTaskGroupName?: string;
   /**
+   * @remarks
+   * Scheduling expression for the aggregation task group when the scheduling mode is \\"Cron\\".
+   * 
    * @example
    * 0 1 3 * * ? *
    */
   cronExpr?: string;
   /**
+   * @remarks
+   * Fixed delay time (in seconds) for scheduling.
+   * 
    * @example
    * 2
    */
   delay?: number;
   /**
+   * @remarks
+   * Description of the aggregation task group.
+   * 
    * @example
    * test
    */
   description?: string;
   /**
+   * @remarks
+   * Second-level timestamp corresponding to the start time of scheduling (not yet effective).
+   * 
    * @example
    * 1757409495
    */
   fromTime?: number;
   /**
+   * @remarks
+   * Maximum number of retries for executing the aggregation task.
+   * 
    * @example
    * 2
    */
   maxRetries?: number;
   /**
+   * @remarks
+   * Maximum retry time for executing the aggregation task.
+   * 
    * @example
    * 50
    */
   maxRunTimeInSeconds?: number;
   /**
+   * @remarks
+   * Pre-check configuration.
+   * 
    * @example
    * {"policy":"skip","prometheusId":"rw-xx","query":"noPrecheck","threshold":0.5,"timeout":15,"type":"none"}
    */
   precheckString?: string;
   /**
+   * @remarks
+   * Region ID.
+   * 
    * @example
    * cn-zhangjiakou
    */
   regionId?: string;
   /**
+   * @remarks
+   * Scheduling mode.
+   * 
    * @example
    * FixedRate
    */
   scheduleMode?: string;
   /**
+   * @remarks
+   * Scheduling time expression.
+   * 
    * @example
    * @m
    */
   scheduleTimeExpr?: string;
   /**
+   * @remarks
+   * ID of the source Prometheus instance for the aggregation task group.
+   * 
    * @example
    * rw-xxx
    */
   sourcePrometheusId?: string;
   /**
+   * @remarks
+   * Status of the aggregation task group.
+   * 
    * @example
    * Running
    */
   status?: string;
+  /**
+   * @remarks
+   * Resource group tags
+   */
   tags?: GetAggTaskGroupResponseBodyAggTaskGroupTags[];
   /**
+   * @remarks
+   * The target Prometheus instance ID of the aggregation task group.
+   * 
    * @example
    * rw-xxx
    */
   targetPrometheusId?: string;
   /**
+   * @remarks
+   * The second-level timestamp corresponding to the end time of the scheduling.
+   * 
    * @example
    * 1757409495
    */
   toTime?: number;
   /**
+   * @remarks
+   * The update time (timestamp) of the aggregation task group.
+   * 
    * @example
    * 1757409499000
    */
   updateTime?: string;
   /**
+   * @remarks
+   * The user to whom the aggregation task group belongs.
+   * 
    * @example
    * 123xxx
    */
@@ -209,13 +279,23 @@ export class GetAggTaskGroupResponseBodyAggTaskGroup extends $dara.Model {
 }
 
 export class GetAggTaskGroupResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Aggregation task group.
+   */
   aggTaskGroup?: GetAggTaskGroupResponseBodyAggTaskGroup;
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * 68DAF543-35DF-5762-BE90-F5C00B5DC036
    */
   requestId?: string;
   /**
+   * @remarks
+   * Whether the request was successful
+   * 
    * @example
    * True
    */

package/src/models/GetEntityStoreDataHeaders.ts

@@ -5,6 +5,9 @@ import * as $dara from '@darabonba/typescript';
 export class GetEntityStoreDataHeaders extends $dara.Model {
   commonHeaders?: { [key: string]: string };
   /**
+   * @remarks
+   * Content encoding type for the compression algorithm
+   * 
    * @example
    * gzip
    */

package/src/models/GetEntityStoreDataRequest.ts

@@ -5,6 +5,10 @@ import * as $dara from '@darabonba/typescript';
 export class GetEntityStoreDataRequest extends $dara.Model {
   /**
    * @remarks
+   * Start time of the query.
+   * 
+   * Unix timestamp format, representing the number of seconds since 1970-1-1 00:00:00 UTC.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +17,8 @@ export class GetEntityStoreDataRequest extends $dara.Model {
   from?: number;
   /**
    * @remarks
+   * Query statement
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +27,10 @@ export class GetEntityStoreDataRequest extends $dara.Model {
   query?: string;
   /**
    * @remarks
+   * End time of the query.
+   * 
+   * Unix timestamp format, representing the number of seconds since 1970-1-1 00:00:00 UTC.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/GetEntityStoreDataResponseBody.ts

@@ -3,9 +3,37 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class GetEntityStoreDataResponseBodyResponseStatusStatusItem extends $dara.Model {
+  /**
+   * @remarks
+   * Status code
+   * 
+   * @example
+   * Success,ExecuteTimeout,UModelNotExist
+   */
   code?: string;
+  /**
+   * @remarks
+   * Status level
+   * 
+   * @example
+   * Info,Warn,Error
+   */
   level?: string;
+  /**
+   * @remarks
+   * Calculation execution information
+   * 
+   * @example
+   * Query execution timeout after 30 seconds
+   */
   message?: string;
+  /**
+   * @remarks
+   * Suggestions when an error occurs during execution
+   * 
+   * @example
+   * Try to reduce the query scope or increase timeout limit, then retry
+   */
   suggestion?: string;
   static names(): { [key: string]: string } {
     return {
@@ -35,10 +63,42 @@ export class GetEntityStoreDataResponseBodyResponseStatusStatusItem extends $dar
 }
 
 export class GetEntityStoreDataResponseBodyResponseStatus extends $dara.Model {
+  /**
+   * @remarks
+   * Information during the execution process
+   * 
+   * @example
+   * {}
+   */
   executionStates?: string;
+  /**
+   * @remarks
+   * Status level
+   * 
+   * @example
+   * Info,Warn,Error
+   */
   level?: string;
+  /**
+   * @remarks
+   * Execution result
+   * 
+   * @example
+   * Success,PartialSuccess,Error
+   */
   result?: string;
+  /**
+   * @remarks
+   * Retry policy
+   * 
+   * @example
+   * None,Once,Continuous
+   */
   retryPolicy?: string;
+  /**
+   * @remarks
+   * Detailed status information list
+   */
   statusItem?: GetEntityStoreDataResponseBodyResponseStatusStatusItem[];
   static names(): { [key: string]: string } {
     return {
@@ -73,13 +133,28 @@ export class GetEntityStoreDataResponseBodyResponseStatus extends $dara.Model {
 }
 
 export class GetEntityStoreDataResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Total list of returned data
+   */
   data?: string[][];
+  /**
+   * @remarks
+   * List of request headers
+   */
   header?: string[];
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Result status
+   */
   responseStatus?: GetEntityStoreDataResponseBodyResponseStatus;
   static names(): { [key: string]: string } {
     return {