@alicloud/cms20240330 9.2.2 → 10.0.1

package/src/models/CreateAddonReleaseResponseBody.ts

@@ -6,7 +6,7 @@ import { EntityGroupBase } from "./EntityGroupBase";
 export class CreateAddonReleaseResponseBodyReleaseConditions 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 CreateAddonReleaseResponseBodyReleaseConditions 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 CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
   lastTransitionTime?: string;
   /**
    * @remarks
-   * Detailed information.
+   * The details of the phase.
    * 
    * @example
    * The addon loaded successfully
@@ -30,7 +30,7 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
   message?: string;
   /**
    * @remarks
-   * Phase status.
+   * The status of the phase.
    * 
    * @example
    * {\\"phase\\": \\"Created\\", \\"executionDetails\\": [], \\"invocations\\": [], \\"latestExecError\\": {\\"message\\": \\"\\", \\"code\\": \\"\\", \\"requestId\\": \\"\\", \\"extraInfo\\": \\"\\", \\"title\\": \\"\\"}}
@@ -38,7 +38,7 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
   status?: string;
   /**
    * @remarks
-   * Phase type.
+   * The type of the phase.
    * 
    * @example
    * Loaded
@@ -76,7 +76,7 @@ export class CreateAddonReleaseResponseBodyReleaseConditions extends $dara.Model
 export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   /**
    * @remarks
-   * The Addon name of the component being monitored.
+   * The name of the integrated add-on.
    * 
    * @example
    * cs-gpu
@@ -84,7 +84,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   addonName?: string;
   /**
    * @remarks
-   * Number of alert groups.
+   * The number of alert rules.
    * 
    * @example
    * 6
@@ -92,12 +92,12 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   alertRuleCount?: number;
   /**
    * @remarks
-   * Component installation phase information.
+   * The information about the add-on installation phases.
    */
   conditions?: CreateAddonReleaseResponseBodyReleaseConditions[];
   /**
    * @remarks
-   * Component configuration.
+   * The configuration of the add-on.
    * 
    * @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 CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   config?: string;
   /**
    * @remarks
-   * Connection time.
+   * The time when the add-on was integrated.
    * 
    * @example
    * 2024-11-05T15:21:30+08:00
@@ -113,7 +113,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * Number of dashboards.
+   * The number of dashboards.
    * 
    * @example
    * 3
@@ -121,12 +121,12 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   dashboardCount?: number;
   /**
    * @remarks
-   * Entity details.
+   * The details of the entity.
    */
   entityRules?: EntityGroupBase;
   /**
    * @remarks
-   * Environment type.
+   * The environment type.
    * 
    * @example
    * CS
@@ -134,7 +134,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   envType?: string;
   /**
    * @remarks
-   * Environment ID.
+   * The environment ID.
    * 
    * @example
    * policy-xxxxxxxxxxx
@@ -142,7 +142,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   environmentId?: string;
   /**
    * @remarks
-   * Number of plugins.
+   * The number of exporters.
    * 
    * @example
    * 2
@@ -150,7 +150,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   exporterCount?: number;
   /**
    * @remarks
-   * Whether it has configuration.
+   * Indicates whether a configuration is available.
    * 
    * @example
    * true
@@ -158,7 +158,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   haveConfig?: boolean;
   /**
    * @remarks
-   * ID of the user who installed it.
+   * The ID of the user who installed the add-on.
    * 
    * @example
    * 1654218965xxxxxx
@@ -166,7 +166,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   installUserId?: string;
   /**
    * @remarks
-   * Language.
+   * The language.
    * 
    * @example
    * zh
@@ -174,7 +174,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   language?: string;
   /**
    * @remarks
-   * Whether it is a managed component.
+   * Indicates whether the add-on is a managed add-on.
    * 
    * @example
    * true
@@ -182,7 +182,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   managed?: boolean;
   /**
    * @remarks
-   * Parent AddonReleaseId.
+   * The ID of the parent AddonRelease.
    * 
    * @example
    * policy-xxxxxxxxxxx
@@ -190,7 +190,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   parentAddonReleaseId?: string;
   /**
    * @remarks
-   * Policy environment ID.
+   * The ID of the environment policy.
    * 
    * @example
    * policy-xxxxxxxxxx
@@ -198,7 +198,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   policyId?: string;
   /**
    * @remarks
-   * Region ID.
+   * The region ID.
    * 
    * @example
    * cn-hangzhou
@@ -206,7 +206,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
-   * ReleaseID after installation.
+   * The ID of the release.
    * 
    * @example
    * 2e898e60-5e6a-46d1-a994-xxxxxxxxxx
@@ -214,7 +214,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   releaseId?: string;
   /**
    * @remarks
-   * Name of the Release.
+   * The name of the release.
    * 
    * @example
    * test-gpu-integration-name
@@ -222,7 +222,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   releaseName?: string;
   /**
    * @remarks
-   * Component scenario.
+   * The scenario of the add-on.
    * 
    * @example
    * 1
@@ -230,7 +230,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   scene?: string;
   /**
    * @remarks
-   * Component status.
+   * The status of the add-on.
    * 
    * @example
    * 200
@@ -238,7 +238,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * Update time.
+   * The time when the add-on was last updated.
    * 
    * @example
    * 2024-09-13T02:21:02Z
@@ -246,7 +246,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   updateTime?: string;
   /**
    * @remarks
-   * ID of the owner user.
+   * The user ID.
    * 
    * @example
    * 165421896xxxxxx
@@ -254,7 +254,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   userId?: string;
   /**
    * @remarks
-   * Component version.
+   * The version of the add-on.
    * 
    * @example
    * 1.0.0
@@ -262,7 +262,7 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
   version?: string;
   /**
    * @remarks
-   * Workspace.
+   * The workspace.
    * 
    * @example
    * default
@@ -346,12 +346,12 @@ export class CreateAddonReleaseResponseBodyRelease extends $dara.Model {
 export class CreateAddonReleaseResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Accessed component information.
+   * The information about the integrated add-on.
    */
   release?: CreateAddonReleaseResponseBodyRelease;
   /**
    * @remarks
-   * Request ID.
+   * The request ID.
    * 
    * @example
    * 0CEC5375-C554-562B-A65F-9A629907C1F0

package/src/models/CreateAggTaskGroupRequest.ts

@@ -46,7 +46,7 @@ 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.
+   * Currently only the "RecordingRuleYaml" format is supported, which must conform to the RecordingRule format requirements of open-source Prometheus.
    * 
    * This parameter is required.
    * 
@@ -62,7 +62,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   aggTaskGroupConfig?: string;
   /**
    * @remarks
-   * Aggregation task group configuration type, default is “RecordingRuleYaml” (open-source Prometheus RecordingRule format).
+   * Aggregation task group configuration type. Default: "RecordingRuleYaml" (open-source Prometheus RecordingRule format).
    * 
    * @example
    * RecordingRuleYaml
@@ -80,7 +80,7 @@ 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.
+   * The specific scheduling expression when the scheduling mode is set to "Cron". For example, "0/1 * * * *" means scheduling every 1 minute starting from minute 0.
    * 
    * @example
    * 0/1 * * * *
@@ -88,7 +88,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   cronExpr?: string;
   /**
    * @remarks
-   * Fixed delay time for scheduling, in seconds, default is 30.
+   * Fixed delay time for scheduling. Unit: seconds. Default: 30.
    * 
    * @example
    * 30
@@ -96,7 +96,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   delay?: number;
   /**
    * @remarks
-   * Description of the aggregation task group.
+   * Aggregation task group description.
    * 
    * @example
    * desc
@@ -104,7 +104,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   description?: string;
   /**
    * @remarks
-   * The second-level timestamp corresponding to the start time of the schedule.
+   * Second-level timestamp corresponding to the scheduling start time.
    * 
    * @example
    * 1724996015
@@ -112,7 +112,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   fromTime?: number;
   /**
    * @remarks
-   * Maximum number of retries for executing the aggregation task, default is 20.
+   * Maximum number of retries for executing aggregation tasks. Default: 20.
    * 
    * @example
    * 20
@@ -120,7 +120,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   maxRetries?: number;
   /**
    * @remarks
-   * Maximum retry time for executing the aggregation task, in seconds, default is 600.
+   * Maximum retry duration for executing aggregation tasks. Unit: seconds. Default: 600.
    * 
    * @example
    * 600
@@ -128,7 +128,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   maxRunTimeInSeconds?: number;
   /**
    * @remarks
-   * Pre-check configuration, no configuration by default. The input string needs to be correctly parsed as JSON.
+   * Pre-check configuration. Not configured by default. The input string must be valid 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"}
@@ -136,7 +136,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   precheckString?: string;
   /**
    * @remarks
-   * Scheduling mode, either “Cron” or “FixedRate”, default is “FixedRate”.
+   * Scheduling mode. "Cron" or "FixedRate". Default: "FixedRate".
    * 
    * @example
    * FixedRate
@@ -144,7 +144,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   scheduleMode?: string;
   /**
    * @remarks
-   * Scheduling time expression, recommended “@s” or “@m”, indicating the alignment granularity of the scheduling time window, default is “@m”.
+   * Scheduling time expression. "@s" or "@m" is recommended, indicating the granularity of scheduling time window alignment. Default: "@m".
    * 
    * @example
    * @m
@@ -152,7 +152,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   scheduleTimeExpr?: string;
   /**
    * @remarks
-   * Status of the aggregation task group, either “Running” or “Stopped”. Default is Running.
+   * Aggregation task group status. "Running" or "Stopped". Default: Running.
    * 
    * @example
    * Running
@@ -165,7 +165,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   tags?: CreateAggTaskGroupRequestTags[];
   /**
    * @remarks
-   * The target Prometheus instance ID of the aggregation task group.
+   * Target Prometheus instance ID of the aggregation task group.
    * 
    * This parameter is required.
    * 
@@ -175,7 +175,7 @@ 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.
+   * Second-level timestamp corresponding to the scheduling end time. 0 means scheduling will not stop.
    * 
    * @example
    * 0
@@ -183,7 +183,7 @@ export class CreateAggTaskGroupRequest extends $dara.Model {
   toTime?: number;
   /**
    * @remarks
-   * Whether to overwrite and update if a resource with the same name exists when creating an aggregation task group.
+   * Whether to override and update when a resource with the same name exists during aggregation task group creation.
    * 
    * @example
    * true

package/src/models/CreateAggTaskGroupResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class CreateAggTaskGroupResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Summary of the aggregation task group configuration.
+   * Digest of the aggregation task group configuration.
    * 
    * @example
    * a54136014dc386a92c83a6ef1e97ff22

package/src/models/CreateAlertWebhookRequest.ts

@@ -4,27 +4,50 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAlertWebhookRequest extends $dara.Model {
   /**
+   * @remarks
+   * The content type. Valid values:
+   * 
+   * - JSON (default)
+   * 
+   * - FORM
+   * 
    * @example
    * JSON
    */
   contentType?: string;
   /**
    * @remarks
-   * headers
+   * The headers.
    */
   headers?: { [key: string]: string };
   /**
+   * @remarks
+   * The language. Valid values:
+   * 
+   * - zh_CN
+   * 
+   * - en_US
+   * 
    * @example
    * zh_CN
    */
   lang?: string;
   /**
+   * @remarks
+   * The request method. Valid values:
+   * 
+   * - GET
+   * 
+   * - POST
+   * 
    * @example
    * GET
    */
   method?: string;
   /**
    * @remarks
+   * The name of the webhook.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -33,6 +56,8 @@ export class CreateAlertWebhookRequest extends $dara.Model {
   name?: string;
   /**
    * @remarks
+   * The URL for the alert callback.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -40,6 +65,9 @@ export class CreateAlertWebhookRequest extends $dara.Model {
    */
   url?: string;
   /**
+   * @remarks
+   * The unique ID of the webhook.
+   * 
    * @example
    * test
    */

package/src/models/CreateAlertWebhookResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAlertWebhookResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The unique ID of the webhook.
+   * 
    * @example
    * test
    */
   alertWebhookId?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/CreateBizTraceRequest.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateBizTraceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The advanced configuration.
+   * 
    * @example
    * {"sample":{"strategy":"BY_APP"}}
    */
   advancedConfig?: string;
   /**
+   * @remarks
+   * The identifier for the business trace. It can contain only letters, digits, and underscores (_). The first character must be a lowercase letter.
+   * 
    * @example
    * label_env
    */
   bizTraceCode?: string;
   /**
+   * @remarks
+   * The name of the business trace.
+   * 
    * @example
    * just test
    */
   bizTraceName?: string;
   /**
+   * @remarks
+   * The configuration rules.
+   * 
    * @example
    * [{"entrancePid":"xxx@d9w3jd9j3","rpcMatcher":{"matchType":"EQUALS","pattern":"/"},"characteristics":{"operation":"OR","rules":[{"target":"CUSTOM_EXTRACT","id":"oi0b3bb7","key":"biz.test","matcher":{"matchType":"CONTAINS","pattern":["1"]}}]}}]
    */
   ruleConfig?: string;
   /**
+   * @remarks
+   * The workspace.
+   * 
    * @example
    * default-cms-xxxxxxx-cn-hangzhou
    */

package/src/models/CreateBizTraceResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateBizTraceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The ID of the business trace.
+   * 
    * @example
    * e339260ed64c95d
    */
   bizTraceId?: string;
   /**
+   * @remarks
+   * The ID of the request.
+   * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC
    */

package/src/models/CreateCloudResourceResponseBody.ts

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

package/src/models/CreateContextStoreApikeyRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreateContextStoreAPIKeyRequest extends $dara.Model {
   /**
    * @remarks
+   * The display name of the API key. Use this name to identify its purpose.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateContextStoreApikeyResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateContextStoreAPIKeyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The value of the API key. This value is returned only upon creation. Store it in a secure location.
+   * 
    * @example
    * sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    */
   apiKey?: string;
   /**
+   * @remarks
+   * The display name of the API key.
+   * 
    * @example
    * Production Service Key
    */
   name?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 3B311FD9-A60B-55E0-A896-A0C73*********
    */