@alicloud/cms20240330 3.2.4 → 3.3.0

package/src/models/ListIntegrationPolicyCustomScrapeJobRulesResponseBody.ts

@@ -4,35 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListIntegrationPolicyCustomScrapeJobRulesResponseBodyCustomScrapeJobRulesScrapeConfigs extends $dara.Model {
   /**
+   * @remarks
+   * Scraping job name
+   * 
    * @example
    * mysql-exporter
    */
   jobName?: string;
   /**
+   * @remarks
+   * Detailed information.
+   * 
    * @example
    * successful
    */
   message?: string;
   /**
+   * @remarks
+   * Metrics path
+   * 
    * @example
    * /metrics
    */
   metricsPath?: string;
   /**
+   * @remarks
+   * Call method.
+   * 
    * @example
    * http
    */
   scheme?: string;
   /**
+   * @remarks
+   * Scrape interval
+   * 
    * @example
    * 30s
    */
   scrapeInterval?: string;
   /**
+   * @remarks
+   * Scrape timeout
+   * 
    * @example
    * 60s
    */
   scrapeTimeout?: string;
+  /**
+   * @remarks
+   * Service discovery configuration
+   */
   serviceDiscoveryConfigs?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -72,56 +94,90 @@ export class ListIntegrationPolicyCustomScrapeJobRulesResponseBodyCustomScrapeJo
 
 export class ListIntegrationPolicyCustomScrapeJobRulesResponseBodyCustomScrapeJobRules extends $dara.Model {
   /**
+   * @remarks
+   * Addon name.
+   * 
    * @example
    * cloud-ecs
    */
   addonName?: string;
   /**
+   * @remarks
+   * Addon Release name
+   * 
    * @example
    * release-12345678
    */
   addonReleaseName?: string;
   /**
+   * @remarks
+   * Addon version
+   * 
    * @example
    * 0.0.1
    */
   addonVersion?: string;
   /**
+   * @remarks
+   * Configuration yaml
+   * 
    * @example
    * scrape_cofnigs:
    * - jobxxxxxx
    */
   configYaml?: string;
   /**
+   * @remarks
+   * Enable status
+   * 
    * @example
    * mini
    */
   enableStatus?: string;
   /**
+   * @remarks
+   * Encrypt yaml
+   * 
    * @example
    * true
    */
   encryptYaml?: boolean;
   /**
+   * @remarks
+   * Matched pod count
+   * 
    * @example
    * 1
    */
   matchedPodCount?: number;
   /**
+   * @remarks
+   * Detailed information.
+   * 
    * @example
    * ok
    */
   message?: string;
   /**
+   * @remarks
+   * Service name.
+   * 
    * @example
    * dlab1
    */
   name?: string;
   /**
+   * @remarks
+   * Namespace
+   * 
    * @example
    * prod-data
    */
   namespace?: string;
+  /**
+   * @remarks
+   * Custom configurations
+   */
   scrapeConfigs?: ListIntegrationPolicyCustomScrapeJobRulesResponseBodyCustomScrapeJobRulesScrapeConfigs[];
   static names(): { [key: string]: string } {
     return {
@@ -169,19 +225,29 @@ export class ListIntegrationPolicyCustomScrapeJobRulesResponseBodyCustomScrapeJo
 
 export class ListIntegrationPolicyCustomScrapeJobRulesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Cluster ID.
+   * 
    * @example
    * et15prod-et15storage
    */
   clusterId?: string;
+  /**
+   * @remarks
+   * Custom scraping job rules
+   */
   customScrapeJobRules?: ListIntegrationPolicyCustomScrapeJobRulesResponseBodyCustomScrapeJobRules[];
   /**
+   * @remarks
+   * Policy ID.
+   * 
    * @example
    * policy-15abcc24c06f4797832b5954198e1ed1
    */
   policyId?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 0CEC5375-C554-562B-A65F-9A629907C1F0

package/src/models/ListIntegrationPolicyDashboardsRequest.ts

@@ -4,12 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListIntegrationPolicyDashboardsRequest extends $dara.Model {
   /**
+   * @remarks
+   * Addon Name.
+   * 
    * @example
    * cs-default
    */
   addonName?: string;
+  /**
+   * @remarks
+   * Query Language
+   * 
+   * @example
+   * zh
+   */
   language?: string;
   /**
+   * @remarks
+   * Component Scenario.
+   * 
    * @example
    * databse
    */

package/src/models/ListIntegrationPolicyDashboardsResponseBody.ts

@@ -3,13 +3,68 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class ListIntegrationPolicyDashboardsResponseBodyDashboards extends $dara.Model {
+  /**
+   * @remarks
+   * Dashboard engine:
+   * grafana: shared grafana.
+   * cms: cms self-developed dashboard engine.
+   * 
+   * @example
+   * grafana
+   */
   engine?: string;
+  /**
+   * @remarks
+   * UID of the dashboard folder.
+   * 
+   * @example
+   * Env-AAA
+   */
   folderUid?: string;
+  /**
+   * @remarks
+   * Dashboard name
+   * 
+   * @example
+   * k8s-pod
+   */
   name?: string;
+  /**
+   * @remarks
+   * Region
+   * 
+   * @example
+   * cn-hongkong
+   */
   region?: string;
+  /**
+   * @remarks
+   * List of tags.
+   */
   tags?: string[];
+  /**
+   * @remarks
+   * Title of the UI module (not name)
+   * 
+   * @example
+   * test
+   */
   title?: string;
+  /**
+   * @remarks
+   * ID of the current Alibaba Cloud primary account, read-only
+   * 
+   * @example
+   * 1258199346721590
+   */
   uid?: string;
+  /**
+   * @remarks
+   * pagerDuty integration webhook. Supports V1 and V2 versions
+   * 
+   * @example
+   * https://agi.alicdn.com/user/0/0_0_5255362686.png?x-oss-process=image/quality,q_75/format,jpg&file=1734574878007.jpg
+   */
   url?: string;
   static names(): { [key: string]: string } {
     return {
@@ -50,16 +105,23 @@ export class ListIntegrationPolicyDashboardsResponseBodyDashboards extends $dara
 }
 
 export class ListIntegrationPolicyDashboardsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * List of dashboards.
+   */
   dashboards?: ListIntegrationPolicyDashboardsResponseBodyDashboards[];
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * CD8BA7D6-995D-578D-9941-78B0FECD14B5
    */
   requestId?: string;
   /**
+   * @remarks
+   * Number of components.
+   * 
    * @example
    * 1
    */

package/src/models/ListIntegrationPolicyPodMonitorsRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListIntegrationPolicyPodMonitorsRequest extends $dara.Model {
   /**
+   * @remarks
+   * Addon Release name.
+   * 
    * @example
    * release-123456789
    */
   addonReleaseName?: string;
   /**
+   * @remarks
+   * Whether to encrypt Yaml.
+   * 
    * @example
    * true
    */
   encryptYaml?: boolean;
   /**
+   * @remarks
+   * Namespace.
+   * 
    * @example
    * default
    */

package/src/models/ListIntegrationPolicyPodMonitorsResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListIntegrationPolicyPodMonitorsResponseBodyPodMonitorsEndpoints extends $dara.Model {
   /**
+   * @remarks
+   * Collection interval
+   * 
    * @example
    * 30s
    */
   interval?: string;
   /**
+   * @remarks
+   * Number of matched targets
+   * 
    * @example
    * 1
    */
   matchedTargetCount?: number;
   /**
+   * @remarks
+   * Metric collection path
+   * 
    * @example
    * /metrics
    */
   path?: string;
   /**
+   * @remarks
+   * Port number
+   * 
    * @example
    * 9100
    */
   port?: string;
   /**
+   * @remarks
+   * Target port
+   * 
    * @example
    * https
    */
@@ -59,47 +74,78 @@ export class ListIntegrationPolicyPodMonitorsResponseBodyPodMonitorsEndpoints ex
 
 export class ListIntegrationPolicyPodMonitorsResponseBodyPodMonitors extends $dara.Model {
   /**
+   * @remarks
+   * Addon name.
+   * 
    * @example
    * cloud-ecs
    */
   addonName?: string;
   /**
+   * @remarks
+   * Addon Release name.
+   * 
    * @example
    * release-2345678
    */
   addonReleaseName?: string;
   /**
+   * @remarks
+   * Addon version.
+   * 
    * @example
    * 0.0.1
    */
   addonVersion?: string;
   /**
+   * @remarks
+   * Configuration yaml.
+   * 
    * @example
    * apiVersion: xxxxx
    */
   configYaml?: string;
   /**
+   * @remarks
+   * Enable status.
+   * 
    * @example
    * run
    */
   enableStatus?: string;
   /**
+   * @remarks
+   * Encrypt yaml.
+   * 
    * @example
    * YXBpVmVyc2lvbjogeHh4eHgK
    */
   encryptYaml?: boolean;
+  /**
+   * @remarks
+   * Instance endpoints.
+   */
   endpoints?: ListIntegrationPolicyPodMonitorsResponseBodyPodMonitorsEndpoints[];
   /**
+   * @remarks
+   * Number of matched pods
+   * 
    * @example
    * 3
    */
   matchedPodCount?: number;
   /**
+   * @remarks
+   * Collection name.
+   * 
    * @example
    * znzmo_entity_test
    */
   name?: string;
   /**
+   * @remarks
+   * Namespace
+   * 
    * @example
    * sla-ns-d5aeb2b4f91b47
    */
@@ -147,16 +193,30 @@ export class ListIntegrationPolicyPodMonitorsResponseBodyPodMonitors extends $da
 }
 
 export class ListIntegrationPolicyPodMonitorsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Cluster ID.
+   * 
+   * @example
+   * et15prod-et15storage
+   */
   clusterId?: string;
+  /**
+   * @remarks
+   * PodMonitor list
+   */
   podMonitors?: ListIntegrationPolicyPodMonitorsResponseBodyPodMonitors[];
   /**
+   * @remarks
+   * Policy ID.
+   * 
    * @example
    * policy-c9efed2b99c348d49e589c5f780fc074
    */
   policyId?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * CD8BA7D6-995D-578D-9941-78B0FECD14B5

package/src/models/ListIntegrationPolicyStorageRequirementsRequest.ts

@@ -4,12 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class ListIntegrationPolicyStorageRequirementsRequest extends $dara.Model {
   /**
+   * @remarks
+   * Addon Release Name
+   * 
    * @example
    * release-1234357
    */
   addonName?: string;
+  /**
+   * @remarks
+   * Name of AddonRelease.
+   * 
+   * @example
+   * kafka-17201012937917
+   */
   addonReleaseName?: string;
   /**
+   * @remarks
+   * Storage Type, LogStore/Prometheus/TraceStore/EventStore/EntityStore.
+   * 
    * @example
    * LogStore
    */