@alicloud/cms20240330 3.2.4 → 3.3.0

package/src/models/GetPrometheusInstanceResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetPrometheusInstanceResponseBodyPrometheusInstanceTags extends $dara.Model {
   /**
+   * @remarks
+   * Tag key.
+   * 
    * @example
    * openStorage
    */
   key?: string;
   /**
+   * @remarks
+   * Matched value.
+   * 
    * @example
    * 130303196111114281
    */
@@ -38,175 +44,311 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstanceTags extends $da
 
 export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.Model {
   /**
+   * @remarks
+   * Access type:
+   * readWrite, readOnly, httpReadOnly
+   * 
    * @example
    * readOnly
    */
   accessType?: string;
   /**
+   * @remarks
+   * Number of days to automatically archive and save after storage expiration. 0 means no archiving, 3650 means permanent saving.
+   * 
    * @example
-   * 165
+   * 90
    */
   archiveDuration?: number;
   /**
+   * @remarks
+   * Password-free read policy (supports IP segments and VpcId).
+   * 
    * @example
-   * 0.0.0.0/0
+   * {
+   *   "SourceIp": [
+   *     "192.168.1.0/24",
+   *     "172.168.2.22"
+   *   ],
+   *   "SourceVpc": [
+   *     "vpc-xx1",
+   *     "vpc-xx2"
+   *   ]
+   * }
    */
   authFreeReadPolicy?: string;
   /**
+   * @remarks
+   * Password-free write policy (supports IP segments and VpcId).
+   * 
    * @example
-   * 0.0.0.0/0
+   * {
+   *   "SourceIp": [
+   *     "192.168.1.0/24",
+   *     "172.168.2.22"
+   *   ],
+   *   "SourceVpc": [
+   *     "vpc-xx1",
+   *     "vpc-xx2"
+   *   ]
+   * }
    */
   authFreeWritePolicy?: string;
   /**
+   * @remarks
+   * authToken string.
+   * 
    * @example
    * eJwixxxxx
    */
   authToken?: string;
   /**
+   * @remarks
+   * Instance creation time, using UTC+0, formatted as yyyy-MM-ddTHH:mmZ.
+   * 
    * @example
    * 2025-08-10T02:07:53Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * Whether to enable password-free reading.
+   * 
    * @example
    * true
    */
   enableAuthFreeRead?: boolean;
   /**
+   * @remarks
+   * Whether to enable password-free writing.
+   * 
    * @example
    * true
    */
   enableAuthFreeWrite?: boolean;
   /**
+   * @remarks
+   * Whether to enable authentication token.
+   * 
    * @example
    * true
    */
   enableAuthToken?: boolean;
+  /**
+   * @remarks
+   * Additional information.
+   */
   extraInfo?: { [key: string]: string };
   /**
+   * @remarks
+   * URL of the visualization dashboard directory.
+   * 
    * @example
    * https://gnew.console.aliyun.com/dashboards/f/c49a80d2a551d4a20a8c4b996b0be4e52/xxxxxxx
    */
   folderUrl?: string;
   /**
+   * @remarks
+   * ID of the managed Grafana instance that is bound.
+   * 
    * @example
    * SHARED
    */
   grafanaInstanceId?: string;
+  /**
+   * @remarks
+   * Name of the managed Grafana instance that is bound.
+   * 
+   * @example
+   * 共享版
+   */
   grafanaInstanceName?: string;
   /**
+   * @remarks
+   * HTTP public network address.
+   * 
    * @example
    * http://workspace-default-cms-xxxxxxx
    */
   httpApiInterUrl?: string;
   /**
+   * @remarks
+   * HTTP intranet address.
+   * 
    * @example
    * http://workspace-default-cms-xxxxxxx
    */
   httpApiIntraUrl?: string;
   /**
    * @remarks
-   * remote-write（Prometheus for Remote Write）
+   * Prometheus instance type.
    * 
    * @example
-   * e1
+   * remote-write
    */
   instanceType?: string;
   /**
+   * @remarks
+   * Billing method:
+   * POSTPAY: Pay-as-you-go based on metric reporting volume.
+   * POSTPAY_GB: Pay-as-you-go based on metric write volume.
+   * 
    * @example
-   * prepaid
+   * POSTPAY
    */
   paymentType?: string;
   /**
+   * @remarks
+   * Time when the billing method of the instance was updated.
+   * 
    * @example
-   * null
+   * 2025-08-10T02:07:53Z
    */
   paymentTypeUpdateTime?: string;
   /**
+   * @remarks
+   * The product to which the Prometheus instance belongs (arms or cms).
+   * 
    * @example
-   * NAS
+   * cms
    */
   product?: string;
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * rw-524ada714221af267c73122af2e1
    */
   prometheusInstanceId?: string;
   /**
+   * @remarks
+   * Instance name.
+   * 
    * @example
    * test-prom-name
    */
   prometheusInstanceName?: string;
   /**
+   * @remarks
+   * Public network address of PushGateway.
+   * 
    * @example
    * http://workspace-default-cms-xxxxxxx
    */
   pushGatewayInterUrl?: string;
   /**
+   * @remarks
+   * Intranet address of PushGateway.
+   * 
    * @example
    * http://workspace-default-cms-xxxxxxx
    */
   pushGatewayIntraUrl?: string;
   /**
+   * @remarks
+   * Region ID.
+   * 
    * @example
    * cn-heyuan
    */
   regionId?: string;
   /**
+   * @remarks
+   * Public network read address.
+   * 
    * @example
    * http://workspace-default-cms-xxxxxxx
    */
   remoteReadInterUrl?: string;
   /**
+   * @remarks
+   * Intranet read address.
+   * 
    * @example
    * https://workspace-default-cms-1xxxxxxxxxx
    */
   remoteReadIntraUrl?: string;
   /**
+   * @remarks
+   * Public network write address.
+   * 
    * @example
    * https://workspace-default-cms-xxxxxxxxxx
    */
   remoteWriteInterUrl?: string;
   /**
+   * @remarks
+   * Intranet write address.
+   * 
    * @example
    * https://workspace-default-cms-xxxxxxxxxx
    */
   remoteWriteIntraUrl?: string;
   /**
+   * @remarks
+   * Resource group ID.
+   * 
    * @example
    * rg-acfm3gn5i6bigbi
    */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * Fixed value: PrometheusInstance.
+   * 
    * @example
    * Prometheus
    */
   resourceType?: string;
   /**
+   * @remarks
+   * Instance status.
+   * 
    * @example
    * Running
    */
   status?: string;
   /**
+   * @remarks
+   * Storage duration (in days).
+   * 
    * @example
    * 90
    */
   storageDuration?: number;
+  /**
+   * @remarks
+   * Supported authentication types.
+   */
   supportAuthTypes?: string[];
+  /**
+   * @remarks
+   * List of tags.
+   */
   tags?: GetPrometheusInstanceResponseBodyPrometheusInstanceTags[];
   /**
+   * @remarks
+   * User ID.
+   * 
    * @example
    * 170731234567
    */
   userId?: string;
   /**
+   * @remarks
+   * Version.
+   * 
    * @example
-   * *
+   * V1
    */
   version?: string;
   /**
+   * @remarks
+   * The workspace to which the Prometheus instance belongs.
+   * 
    * @example
-   * rum-monitor-test-aysls-pub-cn-qingdao-monitor
+   * ws1
    */
   workspace?: string;
   static names(): { [key: string]: string } {
@@ -312,10 +454,14 @@ export class GetPrometheusInstanceResponseBodyPrometheusInstance extends $dara.M
 }
 
 export class GetPrometheusInstanceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Details of the Prometheus instance.
+   */
   prometheusInstance?: GetPrometheusInstanceResponseBodyPrometheusInstance;
   /**
    * @remarks
-   * Id of the request
+   * Unique identifier for the request.
    * 
    * @example
    * 264C3E89-XXXX-XXXX-XXXX-CE9C2196C7DC

package/src/models/GetPrometheusViewRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetPrometheusViewRequest extends $dara.Model {
   /**
+   * @remarks
+   * Language environment, default is Chinese zh | en
+   * 
    * @example
    * zh
    */
   aliyunLang?: string;
   /**
+   * @remarks
+   * Resource group ID.
+   * 
    * @example
    * rg-aek2bhocin5e2na
    */

package/src/models/GetPrometheusViewResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class GetPrometheusViewResponseBodyPrometheusViewPrometheusInstances extends $dara.Model {
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * rw-63549e054ff596a4149927961dff
    */
   prometheusInstanceId?: string;
   /**
+   * @remarks
+   * Region ID
+   * 
    * @example
    * cn-north-2-gov-1
    */
   regionId?: string;
   /**
+   * @remarks
+   * User ID.
+   * 
    * @example
    * 122xxxxx
    */
@@ -45,11 +54,17 @@ export class GetPrometheusViewResponseBodyPrometheusViewPrometheusInstances exte
 
 export class GetPrometheusViewResponseBodyPrometheusViewTags extends $dara.Model {
   /**
+   * @remarks
+   * PagerDuty integration key.
+   * 
    * @example
    * global_score_series
    */
   key?: string;
   /**
+   * @remarks
+   * Tag value.
+   * 
    * @example
    * 371293199010092839
    */
@@ -79,124 +94,217 @@ export class GetPrometheusViewResponseBodyPrometheusViewTags extends $dara.Model
 
 export class GetPrometheusViewResponseBodyPrometheusView extends $dara.Model {
   /**
+   * @remarks
+   * Password-free read policy (supports IP segments and VpcId).
+   * 
    * @example
-   * 0.0.0.0/0
+   * {
+   *   "SourceIp": [
+   *     "192.168.1.0/24",
+   *     "172.168.2.22"
+   *   ],
+   *   "SourceVpc": [
+   *     "vpc-xx1",
+   *     "vpc-xx2"
+   *   ]
+   * }
    */
   authFreeReadPolicy?: string;
   /**
+   * @remarks
+   * authToken string.
+   * 
    * @example
    * eJxxxxxx
    */
   authToken?: string;
   /**
+   * @remarks
+   * Instance creation time, using UTC+0 time, format is yyyy-MM-ddTHH:mmZ.
+   * 
    * @example
    * 2025-08-10T02:07:53Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * Whether to enable password-free read.
+   * 
    * @example
    * true
    */
   enableAuthFreeRead?: boolean;
   /**
+   * @remarks
+   * Whether to enable authToken.
+   * 
    * @example
    * true
    */
   enableAuthToken?: boolean;
   /**
+   * @remarks
+   * Observability dashboard URL.
+   * 
    * @example
    * https://xxxx
    */
   folderUrl?: string;
   /**
+   * @remarks
+   * Bound managed Grafana instance ID.
+   * 
    * @example
    * g-xxx
    */
   grafanaInstanceId?: string;
   /**
+   * @remarks
+   * Bound managed Grafana instance name.
+   * 
    * @example
    * gxxx
    */
   grafanaInstanceName?: string;
   /**
+   * @remarks
+   * Public HTTP address.
+   * 
    * @example
    * http://xxxxxxxx
    */
   httpApiInterUrl?: string;
   /**
+   * @remarks
+   * Private HTTP address.
+   * 
    * @example
    * http://xxxxxxxx
    */
   httpApiIntraUrl?: string;
   /**
+   * @remarks
+   * Instance type, fixed value prom-view.
+   * 
    * @example
    * prom-view
    */
   instanceType?: string;
   /**
+   * @remarks
+   * Payment type. Currently, the fixed value is FREE (free).
+   * 
    * @example
    * FREE
    */
   paymentType?: string;
   /**
+   * @remarks
+   * Product that the prom instance belongs to.
+   * 
    * @example
    * cms
    */
   product?: string;
+  /**
+   * @remarks
+   * Prometheus instance list.
+   */
   prometheusInstances?: GetPrometheusViewResponseBodyPrometheusViewPrometheusInstances[];
   /**
+   * @remarks
+   * Prometheus view ID.
+   * 
    * @example
    * view-xxx
    */
   prometheusViewId?: string;
   /**
+   * @remarks
+   * Prometheus view name.
+   * 
    * @example
    * view1
    */
   prometheusViewName?: string;
   /**
+   * @remarks
+   * Region ID
+   * 
    * @example
    * cn-shanghai
    */
   regionId?: string;
   /**
+   * @remarks
+   * Remote read public URL.
+   * 
    * @example
    * http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read
    */
   remoteReadInterUrl?: string;
   /**
+   * @remarks
+   * Remote read intranet URL.
+   * 
    * @example
    * http://workspace-default-cms-xxx-cn-hangzhou.cn-hangzhou-intranet.log.aliyuncs.com/prometheus/workspace-default-cms-xxx-cn-hangzhou/xxx/api/v1/read
    */
   remoteReadIntraUrl?: string;
   /**
+   * @remarks
+   * Resource group ID.
+   * 
    * @example
    * rg-acfm3gn5i6bigbi
    */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * Fixed value: PrometheusView
+   * 
    * @example
    * RegistryModule
    */
   resourceType?: string;
   /**
+   * @remarks
+   * Backend data storage status
+   * 
    * @example
    * Pending2Running
    */
   status?: string;
+  /**
+   * @remarks
+   * Supported authentication types.
+   */
   supportAuthTypes?: string[];
+  /**
+   * @remarks
+   * Instance tag keys.
+   */
   tags?: GetPrometheusViewResponseBodyPrometheusViewTags[];
   /**
+   * @remarks
+   * User ID.
+   * 
    * @example
    * 11222
    */
   userId?: string;
   /**
+   * @remarks
+   * Version.
+   * 
    * @example
    * V1
    */
   version?: string;
   /**
+   * @remarks
+   * Workspace to which the environment belongs
+   * 
    * @example
    * cms-monitor-test-aysls-pub-cn-fuzhou-monitor
    */
@@ -284,6 +392,10 @@ export class GetPrometheusViewResponseBodyPrometheusView extends $dara.Model {
 }
 
 export class GetPrometheusViewResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * View instance.
+   */
   prometheusView?: GetPrometheusViewResponseBodyPrometheusView;
   /**
    * @remarks