@alicloud/cms20240330 3.2.4 → 3.3.0

package/src/models/CreateIntegrationPolicyResponseBody.ts

@@ -4,35 +4,60 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
   /**
+   * @remarks
+   * Entity group ID.
+   * 
    * @example
    * eg-b79f65d11fb94e779867cf937c3a3002
    */
   entityGroupId?: string;
   /**
+   * @remarks
+   * Policy ID.
+   * 
    * @example
    * policy-14c8e9a29b0a46da843f8781471062ff
    */
   policyId?: string;
   /**
+   * @remarks
+   * Policy name.
+   * 
    * @example
    * metrics-inner-manage
    */
   policyName?: string;
   /**
+   * @remarks
+   * Policy type.
+   * 
    * @example
    * CS
    */
   policyType?: string;
   /**
+   * @remarks
+   * Region ID.
+   * 
    * @example
    * cn-heyuan
    */
   regionId?: string;
   /**
+   * @remarks
+   * User ID.
+   * 
    * @example
    * u1234567
    */
   userId?: string;
+  /**
+   * @remarks
+   * The workspace where the Policy resides.
+   * 
+   * @example
+   * prometheus
+   */
   workspace?: string;
   static names(): { [key: string]: string } {
     return {
@@ -69,12 +94,22 @@ export class CreateIntegrationPolicyResponseBodyPolicy extends $dara.Model {
 
 export class CreateIntegrationPolicyResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Whether it is created.
+   * 
    * @example
    * true
    */
   created?: boolean;
+  /**
+   * @remarks
+   * Uploaded policy.
+   */
   policy?: CreateIntegrationPolicyResponseBodyPolicy;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * CD8BA7D6-995D-578D-9941-78B0FECD14B5
    */

package/src/models/CreatePrometheusInstanceRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePrometheusInstanceRequestTags extends $dara.Model {
   /**
+   * @remarks
+   * Tag key.
+   * 
    * @example
    * key1
    */
   key?: string;
   /**
+   * @remarks
+   * Tag value.
+   * 
    * @example
    * 110109200001214284
    */
@@ -38,6 +44,11 @@ export class CreatePrometheusInstanceRequestTags extends $dara.Model {
 
 export class CreatePrometheusInstanceRequest extends $dara.Model {
   /**
+   * @remarks
+   * The number of days to automatically archive and save after the storage expires, 0 means no archiving. The range of archiving days is as follows:
+   * * V1: 60~365 days.
+   * * V2: 60~3650 days (3650 indicates permanent storage).
+   * 
    * @example
    * 60
    * 
@@ -46,37 +57,78 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
    */
   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.
+   * 
    * @example
-   * 0.0.0.0/0
+   * {
+   *   "SourceIp": [
+   *     "192.168.1.0/24",
+   *     "172.168.2.22"
+   *   ],
+   *   "SourceVpc": [
+   *     "vpc-xx1",
+   *     "vpc-xx2"
+   *   ]
+   * }
    */
   authFreeWritePolicy?: string;
   /**
+   * @remarks
+   * Whether to enable password-free read (only supported in V2 version).
+   * 
    * @example
    * true
    */
   enableAuthFreeRead?: boolean;
   /**
+   * @remarks
+   * Whether to enable password-free write (only supported in V2 version).
+   * 
    * @example
    * true
    */
   enableAuthFreeWrite?: boolean;
   /**
+   * @remarks
+   * Whether to enable authorization Token (only supported in V1 version).
+   * 
    * @example
    * true
    */
   enableAuthToken?: boolean;
   /**
+   * @remarks
+   * Billing method:
+   * * POSTPAY: Postpaid by metric reporting volume.
+   * * POSTPAY_GB: Postpaid by metric write volume.
+   * Note, if left blank, the user\\"s default billing method configuration will be used. If the user has not configured a default, the system defaults to billing by metric reporting volume.
+   * 
    * @example
    * POSTPAY
    */
   paymentType?: string;
   /**
    * @remarks
+   * Instance name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -84,17 +136,32 @@ export class CreatePrometheusInstanceRequest extends $dara.Model {
    */
   prometheusInstanceName?: string;
   /**
+   * @remarks
+   * Instance status.
+   * 
    * @example
    * Running
    */
   status?: string;
   /**
+   * @remarks
+   * Storage duration (days):
+   * * By write volume: 90, 180.
+   * * By metric reporting volume: 15, 30, 60, 90, 180.
+   * 
    * @example
    * 90
    */
   storageDuration?: number;
+  /**
+   * @remarks
+   * Tag values.
+   */
   tags?: CreatePrometheusInstanceRequestTags[];
   /**
+   * @remarks
+   * Belonging workspace, default value: default-cms-{userId}-{regionId}.
+   * 
    * @example
    * wokspace1
    */

package/src/models/CreatePrometheusInstanceResponseBody.ts

@@ -4,13 +4,16 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePrometheusInstanceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * rw-abc123
    */
   prometheusInstanceId?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request.
    * 
    * @example
    * 264C3E89-BE6E-5F82-A484-CE9C2196C7DC

package/src/models/CreatePrometheusViewRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePrometheusViewRequestPrometheusInstances extends $dara.Model {
   /**
+   * @remarks
+   * Instance ID.
+   * 
    * @example
    * arms-1d581fac20a462dcde743d9628
    */
   prometheusInstanceId?: string;
   /**
+   * @remarks
+   * Region ID.
+   * 
    * @example
    * cn-wulanchabu
    */
   regionId?: string;
   /**
+   * @remarks
+   * User ID.
+   * 
    * @example
    * 167271234567890
    */
@@ -45,11 +54,17 @@ export class CreatePrometheusViewRequestPrometheusInstances extends $dara.Model
 
 export class CreatePrometheusViewRequestTags extends $dara.Model {
   /**
+   * @remarks
+   * Tag key.
+   * 
    * @example
    * test-key
    */
   key?: string;
   /**
+   * @remarks
+   * Tag value.
+   * 
    * @example
    * test-value
    */
@@ -79,27 +94,49 @@ export class CreatePrometheusViewRequestTags extends $dara.Model {
 
 export class CreatePrometheusViewRequest extends $dara.Model {
   /**
+   * @remarks
+   * Not enabled yet
+   * 
    * @example
-   * null
+   * {
+   *   "SourceIp": [
+   *     "192.168.1.0/24",
+   *     "172.168.2.22"
+   *   ],
+   *   "SourceVpc": [
+   *     "vpc-xx1",
+   *     "vpc-xx2"
+   *   ]
+   * }
    */
   authFreeReadPolicy?: string;
   /**
+   * @remarks
+   * Whether to support password-free read
+   * 
    * @example
    * true
    */
   enableAuthFreeRead?: boolean;
   /**
+   * @remarks
+   * Whether to support authToken
+   * 
    * @example
    * true
    */
   enableAuthToken?: boolean;
   /**
    * @remarks
+   * List of Prometheus instances.
+   * 
    * This parameter is required.
    */
   prometheusInstances?: CreatePrometheusViewRequestPrometheusInstances[];
   /**
    * @remarks
+   * Prometheus view name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -107,18 +144,31 @@ export class CreatePrometheusViewRequest extends $dara.Model {
    */
   prometheusViewName?: string;
   /**
+   * @remarks
+   * Resource group ID.
+   * 
    * @example
    * rg-acfm3gn5i6bigbi
    */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * Not enabled yet.
+   * 
    * @example
    * null
    */
   status?: string;
+  /**
+   * @remarks
+   * The operation to be performed.
+   */
   tags?: CreatePrometheusViewRequestTags[];
   /**
    * @remarks
+   * - V1: Old version
+   * - V2: New version
+   * 
    * This parameter is required.
    * 
    * @example
@@ -126,6 +176,9 @@ export class CreatePrometheusViewRequest extends $dara.Model {
    */
   version?: string;
   /**
+   * @remarks
+   * Default value: default-cms-{userId}-{regionId}
+   * 
    * @example
    * cms-monitor-test-aysls-pub-cn-zhangjiakou-spe-monitor
    */

package/src/models/CreatePrometheusViewResponseBody.ts

@@ -4,13 +4,16 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePrometheusViewResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Prometheus view ID.
+   * 
    * @example
    * cd5237f7dbd574cf9bbd648ff9efb16cd
    */
   prometheusViewId?: string;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****

package/src/models/CreatePrometheusVirtualInstanceRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CreatePrometheusVirtualInstanceRequest extends $dara.Model {
   /**
    * @remarks
+   * Each cloud product can only create one virtual instance in each region.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreatePrometheusVirtualInstanceResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.Model {
   /**
+   * @remarks
+   * Creation time
+   * 
    * @example
    * 1751520976660
    */
   createdAt?: string;
   /**
+   * @remarks
+   * HTTP API query address
+   * 
    * @example
    * http://xxxxxxx
    */
   httpApiUrl?: string;
   /**
+   * @remarks
+   * Region ID
+   * 
    * @example
    * rw-e815960b4c9ebc5c3d89790c7e82
    */
   instanceId?: string;
   /**
+   * @remarks
+   * Cloud product
+   * 
    * @example
    * ack-csi-fuse
    */
   namespace?: string;
   /**
+   * @remarks
+   * User ID
+   * 
    * @example
    * cn-zhengzhou-jva
    */
   regionId?: string;
   /**
+   * @remarks
+   * User ID
+   * 
    * @example
    * 167212345678
    */
@@ -65,10 +83,14 @@ export class CreatePrometheusVirtualInstanceResponseBodyInstance extends $dara.M
 }
 
 export class CreatePrometheusVirtualInstanceResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Instance ID
+   */
   instance?: CreatePrometheusVirtualInstanceResponseBodyInstance;
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 0B9377D9-C56B-5C2E-A8A4-************

package/src/models/CreateServiceRequest.ts

@@ -4,19 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateServiceRequest extends $dara.Model {
   /**
+   * @remarks
+   * Extended attributes.
+   * 
    * @example
    * {"language":"java"}
    */
   attributes?: string;
+  /**
+   * @remarks
+   * Service description, only valid when `serviceType=RUM`.
+   * 
+   * @example
+   * mag测试应用
+   */
   description?: string;
+  /**
+   * @remarks
+   * Display name, only valid when `serviceType=RUM`.
+   * 
+   * @example
+   * mag测试应用
+   */
   displayName?: string;
   /**
+   * @remarks
+   * Application ID, generally not required to be specified.
+   * 
    * @example
    * bx3udsi5ie@ed2ba6beebdb6de
    */
   pid?: string;
   /**
    * @remarks
+   * Service name
+   * 
    * This parameter is required.
    * 
    * @example
@@ -24,12 +46,17 @@ export class CreateServiceRequest extends $dara.Model {
    */
   serviceName?: string;
   /**
+   * @remarks
+   * Service status, not required for service creation.
+   * 
    * @example
    * Created
    */
   serviceStatus?: string;
   /**
    * @remarks
+   * Service type
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateServiceResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateServiceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Historical compatible ARMS application ID
+   * 
    * @example
    * cwzxvuc6uo@d60088ad4797d26
    */
   pid?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 3A2FA9E9-9CF1-5CB1-A808-52828F14310D
    */
   requestId?: string;
   /**
+   * @remarks
+   * Service ID
+   * 
    * @example
    * cwzxvuc6uo@4bc6b15ad81f166174ffb
    */

package/src/models/CreateTicketRequest.ts

@@ -4,11 +4,19 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateTicketRequest extends $dara.Model {
   /**
+   * @remarks
+   * - Access token expiration time (in seconds), which is the expiration time for the user to access the page interface. The default value is 86400 seconds (one day), and the range of values is from 0 to 86400 seconds (one day).
+   * - The access token expiration time is the minimum value between `accessTokenExpirationTime` and `expirationTime`.
+   * - If called through STS, the access token expiration time (i.e., the time during which the user can access the page interface) is the minimum value among `accessTokenExpirationTime`, `expirationTime`, and the STS expiration time.
+   * 
    * @example
    * 600
    */
   accessTokenExpirationTime?: number;
   /**
+   * @remarks
+   * - Expiration time (in seconds), which is the expiration time for the embedded page URL. The default value is 86400 seconds (one day), and the range of values is from 0 to 2592000 seconds (30 days).
+   * 
    * @example
    * 86400
    */

package/src/models/CreateTicketResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateTicketResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * 免登录票据。
+   * 
    * @example
    * eyJ***************.eyJ******************.KUT****************
    */

package/src/models/CreateUmodelRequest.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateUmodelRequest extends $dara.Model {
   /**
+   * @remarks
+   * Umodel description
+   * 
    * @example
    * workspace test
    */

package/src/models/CreateUmodelResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateUmodelResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Request ID
+   * 
    * @example
    * 123-0F43-23423-AC43-34234
    */
   requestId?: string;
   /**
+   * @remarks
+   * Workspace name
+   * 
    * @example
    * workspace-test
    */

package/src/models/DeleteAddonReleaseRequest.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteAddonReleaseRequest extends $dara.Model {
   /**
+   * @remarks
+   * Addon name. When AddonName is provided, it will ignore the ReleaseName parameter and batch uninstall all AddonReleases belonging to the same Addon.
+   * 
    * @example
    * cs-gpu
    */
   addonName?: string;
   /**
+   * @remarks
+   * Whether to force deletion, default is false.
+   * 
    * @example
    * false
    */
   force?: boolean;
   /**
+   * @remarks
+   * The name of the AddonRelease.
+   * 
    * @example
    * test-gpu-integration-name
    */

package/src/models/DeleteAddonReleaseResponseBody.ts

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

package/src/models/DeleteAggTaskGroupResponseBody.ts

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

package/src/models/DeleteEntityStoreResponseBody.ts

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

package/src/models/DeleteIntegrationPolicyRequest.ts

@@ -4,6 +4,10 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeleteIntegrationPolicyRequest extends $dara.Model {
   /**
+   * @remarks
+   * Whether to forcibly delete the cloud-native all-in-one machine,
+   * default value: `false`.
+   * 
    * @example
    * false
    */

package/src/models/DeletePrometheusInstanceResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class DeletePrometheusInstanceResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Id of the request
+   * ID of the request
    * 
    * @example
    * 8FDE2569-626B-5176-9844-28877A*****