@alicloud/polardbx20200202 3.4.2 → 3.5.0

package/src/models/DescribeCdcInfoResponseBody.ts

@@ -4,36 +4,57 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeCdcInfoResponseBodyDataInstanceTopologyListPhysicalNodes extends $dara.Model {
   /**
+   * @remarks
+   * The zone in which the instance resides.
+   * 
    * @example
    * cn-hangzhou-h
    */
   AZone?: string;
   /**
+   * @remarks
+   * The disk size. Unit: MB.
+   * 
    * @example
    * 204800
    */
   disk?: number;
   /**
+   * @remarks
+   * The instance specifications.
+   * 
    * @example
    * polarx.x4.large.2e.cdc
    */
   nodeClass?: string;
   /**
+   * @remarks
+   * The node ID.
+   * 
    * @example
    * ***
    */
   nodeId?: string;
   /**
+   * @remarks
+   * The name of the node.
+   * 
    * @example
    * pxc-c-***
    */
   nodeName?: string;
   /**
+   * @remarks
+   * The instance status.
+   * 
    * @example
    * ACTIVATION
    */
   status?: string;
   /**
+   * @remarks
+   * The instance version.
+   * 
    * @example
    * polarx-cdc-kernel-***
    */
@@ -73,32 +94,54 @@ export class DescribeCdcInfoResponseBodyDataInstanceTopologyListPhysicalNodes ex
 
 export class DescribeCdcInfoResponseBodyDataInstanceTopologyList extends $dara.Model {
   /**
+   * @remarks
+   * The cluster type.
+   * 
    * @example
    * BINLOG_X
    */
   clusterType?: string;
   /**
+   * @remarks
+   * The remarks on the instance type.
+   * 
    * @example
    * ***
    */
   comment?: string;
   /**
+   * @remarks
+   * The name of the multi-stream group.
+   * 
    * @example
    * test
    */
   groupName?: string;
   /**
+   * @remarks
+   * The split level.
+   * 
    * @example
    * RECORD
    */
   hashLevel?: string;
   /**
+   * @remarks
+   * The name of the instance.
+   * 
    * @example
    * pxc-***
    */
   instanceName?: string;
+  /**
+   * @remarks
+   * The array of nodes.
+   */
   physicalNodes?: DescribeCdcInfoResponseBodyDataInstanceTopologyListPhysicalNodes[];
   /**
+   * @remarks
+   * The number of splits.
+   * 
    * @example
    * 2
    */
@@ -141,12 +184,17 @@ export class DescribeCdcInfoResponseBodyDataInstanceTopologyList extends $dara.M
 
 export class DescribeCdcInfoResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The number of days that binlogs are retained.
+   * 
    * @example
    * 15
    */
   binlogPersistTime?: number;
   /**
    * @remarks
+   * The size of the binlog.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -155,6 +203,8 @@ export class DescribeCdcInfoResponseBodyData extends $dara.Model {
   binlogSize?: number;
   /**
    * @remarks
+   * The latest CDC version.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -162,15 +212,25 @@ export class DescribeCdcInfoResponseBodyData extends $dara.Model {
    */
   cdcNewVersion?: string;
   /**
+   * @remarks
+   * The checksum switch status.
+   * 
    * @example
    * ON
    */
   checkSumSwitch?: string;
   /**
+   * @remarks
+   * Indicates whether bidirectional replication is supported.
+   * 
    * @example
    * true
    */
   enableCyclicReplication?: boolean;
+  /**
+   * @remarks
+   * The list of instances.
+   */
   instanceTopologyList?: DescribeCdcInfoResponseBodyDataInstanceTopologyList[];
   /**
    * @remarks
@@ -183,6 +243,9 @@ export class DescribeCdcInfoResponseBodyData extends $dara.Model {
    */
   serverId?: number;
   /**
+   * @remarks
+   * Indicates whether multi-stream CDC is supported.
+   * 
    * @example
    * true
    */
@@ -226,9 +289,15 @@ export class DescribeCdcInfoResponseBodyData extends $dara.Model {
 }
 
 export class DescribeCdcInfoResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The instance data.
+   */
   data?: DescribeCdcInfoResponseBodyData;
   /**
    * @remarks
+   * The HTTP status code of the request.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -245,6 +314,8 @@ export class DescribeCdcInfoResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
+   * Indicates whether the request was successful.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeCdcVersionListRequest.ts

@@ -4,12 +4,18 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeCdcVersionListRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the instance.
+   * 
    * @example
    * pxc-bjrl7****k2vp7
    */
   DBInstanceName?: string;
   instanceName?: string;
   /**
+   * @remarks
+   * The ID of the region in which the instance resides.
+   * 
    * @example
    * cn-beijing
    */

package/src/models/DescribeCdcVersionListResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeCdcVersionListResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the associated legacy project. You can ignore this parameter.
+   */
   versionList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -29,6 +33,10 @@ export class DescribeCdcVersionListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeCdcVersionListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeCdcVersionListResponseBodyData;
   /**
    * @remarks

package/src/models/DescribeCharacterSetRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeCharacterSetRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeCharacterSetRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The ID of the region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeCharacterSetResponseBody.ts

@@ -3,8 +3,20 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeCharacterSetResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The character sets supported by the instance. Valid values:
+   * 
+   * - utf8mb4
+   * - gbk
+   * - latin1
+   * - utf8.
+   */
   characterSet?: string[];
   /**
+   * @remarks
+   * The storage type of databases in the target instance. Currently, only polarx is supported.
+   * 
    * @example
    * polarx
    */
@@ -36,18 +48,31 @@ export class DescribeCharacterSetResponseBodyData extends $dara.Model {
 }
 
 export class DescribeCharacterSetResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeCharacterSetResponseBodyData;
   /**
+   * @remarks
+   * The response message. "success" is returned if the request is successful. Otherwise, an error code is returned.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 709C1E40-092D-4A3D-9958-6D7438******
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeColdDataBasicInfoResponseBody.ts

@@ -3,14 +3,38 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeColdDataBasicInfoResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The number of backup sets.
+   */
   backupSetCount?: number;
+  /**
+   * @remarks
+   * The data size of valid backup sets.
+   */
   backupSetSpaceSize?: number;
+  /**
+   * @remarks
+   * The underlying storage cloud service.
+   */
   cloudProduct?: string;
+  /**
+   * @remarks
+   * The data size of cold storage.
+   */
   currentSpaceSize?: number;
   dataRedundancyType?: string;
+  /**
+   * @remarks
+   * Indicates whether cold storage is enabled.
+   */
   enableStatus?: boolean;
   readAccessNum?: number;
   regionId?: string;
+  /**
+   * @remarks
+   * The storage volume name.
+   */
   volumeName?: string;
   writeAccessNum?: number;
   static names(): { [key: string]: string } {
@@ -53,7 +77,15 @@ export class DescribeColdDataBasicInfoResponseBodyData extends $dara.Model {
 }
 
 export class DescribeColdDataBasicInfoResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The details.
+   */
   data?: DescribeColdDataBasicInfoResponseBodyData;
+  /**
+   * @remarks
+   * requestId
+   */
   requestId?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeColumnarClassListRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeColumnarClassListRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class DescribeColumnarClassListRequest extends $dara.Model {
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * pxc-shrvdc****wtf5uk-cdc
    */
   instanceName?: string;
   /**
    * @remarks
+   * The region in which the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeColumnarClassListResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeColumnarClassListResponseBodyDataClassCodeList extends $dara.Model {
   /**
+   * @remarks
+   * The instance specification.
+   * 
    * @example
    * polarx.n8.large.col
    */
   classCode?: string;
   /**
+   * @remarks
+   * The number of CPU cores.
+   * 
    * @example
    * 2
    */
   cpuCore?: string;
   /**
+   * @remarks
+   * The memory size. Unit: GB.
+   * 
    * @example
    * 2048
    */
@@ -74,6 +83,10 @@ export class DescribeColumnarClassListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeColumnarClassListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeColumnarClassListResponseBodyData;
   /**
    * @remarks

package/src/models/DescribeColumnarInfoRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeColumnarInfoRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,9 @@ export class DescribeColumnarInfoRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * > You can call the [DescribeRegions](https://help.aliyun.com/document_detail/196841.html) operation to query the regions supported by PolarDB-X, including region IDs.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeColumnarInfoResponseBody.ts

@@ -4,31 +4,49 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeColumnarInfoResponseBodyDataInstanceTopologyListPhysicalNodes extends $dara.Model {
   /**
+   * @remarks
+   * The zone in which the instance resides.
+   * 
    * @example
    * cn-hangzhou-h
    */
   AZone?: string;
   /**
+   * @remarks
+   * The disk size, in MB.
+   * 
    * @example
    * 204800
    */
   disk?: number;
   /**
+   * @remarks
+   * The instance specifications.
+   * 
    * @example
    * polarx.n8.medium.col
    */
   nodeClass?: string;
   /**
+   * @remarks
+   * The node ID.
+   * 
    * @example
    * ***
    */
   nodeId?: string;
   /**
+   * @remarks
+   * The instance status.
+   * 
    * @example
    * ACTIVATION
    */
   status?: string;
   /**
+   * @remarks
+   * The instance version.
+   * 
    * @example
    * polarx-col-kernel-5.4.20-20250819_17555906
    */
@@ -66,15 +84,25 @@ export class DescribeColumnarInfoResponseBodyDataInstanceTopologyListPhysicalNod
 
 export class DescribeColumnarInfoResponseBodyDataInstanceTopologyList extends $dara.Model {
   /**
+   * @remarks
+   * The instance type description.
+   * 
    * @example
    * ***
    */
   comment?: string;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * pxc-***
    */
   instanceName?: string;
+  /**
+   * @remarks
+   * The node array.
+   */
   physicalNodes?: DescribeColumnarInfoResponseBodyDataInstanceTopologyListPhysicalNodes[];
   static names(): { [key: string]: string } {
     return {
@@ -106,12 +134,17 @@ export class DescribeColumnarInfoResponseBodyDataInstanceTopologyList extends $d
 
 export class DescribeColumnarInfoResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The number of days that binlogs are retained.
+   * 
    * @example
    * 30
    */
   binlogPersistTime?: number;
   /**
    * @remarks
+   * The binlog size.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -119,17 +152,25 @@ export class DescribeColumnarInfoResponseBodyData extends $dara.Model {
    */
   binlogSize?: number;
   /**
+   * @remarks
+   * The checksum switch.
+   * 
    * @example
    * ON
    */
   checkSumSwitch?: string;
   /**
+   * @remarks
+   * The instance specifications.
+   * 
    * @example
    * polarx.n8.medium.col
    */
   classCode?: string;
   /**
    * @remarks
+   * The new column store version.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -137,10 +178,17 @@ export class DescribeColumnarInfoResponseBodyData extends $dara.Model {
    */
   columnarNewVersion?: string;
   /**
+   * @remarks
+   * The column store version.
+   * 
    * @example
    * polarx-col-kernel-5.4.20-20250819_17555906
    */
   columnarVersion?: string;
+  /**
+   * @remarks
+   * The instance list.
+   */
   instanceTopologyList?: DescribeColumnarInfoResponseBodyDataInstanceTopologyList[];
   /**
    * @remarks
@@ -191,9 +239,15 @@ export class DescribeColumnarInfoResponseBodyData extends $dara.Model {
 }
 
 export class DescribeColumnarInfoResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeColumnarInfoResponseBodyData;
   /**
    * @remarks
+   * The HTTP status code.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -210,6 +264,8 @@ export class DescribeColumnarInfoResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
+   * Indicates whether the request was successful.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeColumnarVersionListRequest.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeColumnarVersionListRequest extends $dara.Model {
   /**
+   * @remarks
+   * The name of the instance.
+   * 
    * @example
    * pxc-hzjasd****
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The region in which the instance resides.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/DescribeColumnarVersionListResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeColumnarVersionListResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The version list.
+   */
   versionList?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -29,6 +33,10 @@ export class DescribeColumnarVersionListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeColumnarVersionListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The parameter details.
+   */
   data?: DescribeColumnarVersionListResponseBodyData;
   /**
    * @remarks

package/src/models/DescribeComponentPropetiesRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeComponentPropetiesRequest extends $dara.Model {
   /**
    * @remarks
+   * The commodity code.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeComponentPropetiesRequest extends $dara.Model {
   commodityCode?: string;
   /**
    * @remarks
+   * The resource group ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,12 +25,21 @@ export class DescribeComponentPropetiesRequest extends $dara.Model {
   componentName?: string;
   /**
    * @remarks
+   * The region in which the instance resides. > You can call the [describeregions](https://help.aliyun.com/document_detail/196841.html) operation to query the regions supported by PolarDB-X, including region IDs.
+   * 
    * This parameter is required.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The storage type.
+   * 
+   * @example
+   * cloud_auto
+   */
   storageType?: string;
   static names(): { [key: string]: string } {
     return {