@alicloud/polardbx20200202 3.4.2 → 3.5.0

package/src/models/DescribeDbinstanceAttributeResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDBInstanceAttributeResponseBodyDBInstanceConnAddrs extends $dara.Model {
   /**
+   * @remarks
+   * The endpoint.
+   * 
    * @example
    * polardbx-xxx.aliyuncs.com
    */
   connectionString?: string;
   /**
+   * @remarks
+   * The connection port number.
+   * 
    * @example
    * 3306
    */
   port?: number;
   /**
+   * @remarks
+   * The connection type. **VPC** indicates an internal network connection. **PUBLIC** indicates a public network connection.
+   * 
    * @example
    * VPC
    */
@@ -26,8 +35,18 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstanceConnAddrs extends
    * vpc-xxxxxx
    */
   VPCId?: string;
+  /**
+   * @remarks
+   * The vSwitch ID.
+   * 
+   * @example
+   * vsw-*********
+   */
   vSwitchId?: string;
   /**
+   * @remarks
+   * The internal CloudInstanceId within the VPC. You can ignore this parameter.
+   * 
    * @example
    * pxc-zkralxpc5d****
    */
@@ -64,24 +83,50 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstanceConnAddrs extends
 }
 
 export class DescribeDBInstanceAttributeResponseBodyDBInstanceDBNodes extends $dara.Model {
+  /**
+   * @remarks
+   * The name of the compute node.
+   * 
+   * @example
+   * pxc-i-********
+   */
   computeNodeId?: string;
   /**
+   * @remarks
+   * The name of the storage node.
+   * 
    * @example
    * pxc-xdb-xxxxxx
    */
   dataNodeId?: string;
+  /**
+   * @remarks
+   * The logical node ID.
+   * 
+   * @example
+   * pxi-*********
+   */
   id?: string;
   /**
+   * @remarks
+   * The node specifications.
+   * 
    * @example
    * polarx.x4.large.2e
    */
   nodeClass?: string;
   /**
+   * @remarks
+   * The region ID of the node.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The zone in which the node resides.
+   * 
    * @example
    * cn-hangzhou-a
    */
@@ -148,11 +193,17 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstanceGdnMemberList exte
 
 export class DescribeDBInstanceAttributeResponseBodyDBInstanceTagSet extends $dara.Model {
   /**
+   * @remarks
+   * The tag key.
+   * 
    * @example
    * key2
    */
   key?: string;
   /**
+   * @remarks
+   * The tag value.
+   * 
    * @example
    * value2
    */
@@ -181,86 +232,211 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstanceTagSet extends $da
 }
 
 export class DescribeDBInstanceAttributeResponseBodyDBInstance extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the In-Memory Column Index feature is supported.
+   * 
+   * @example
+   * true
+   */
   canNotCreateColumnar?: boolean;
   /**
+   * @remarks
+   * The CN node specifications. Valid values:
+   * - **polarx.x4.medium.2e**: 2 cores, 8 GB
+   * - **polarx.x4.large.2e**: 4 cores, 16 GB
+   * - **polarx.x8.large.2e**: 4 cores, 32 GB
+   * - **polarx.x4.xlarge.2e**: 8 cores, 32 GB
+   * - **polarx.x8.xlarge.2e**: 8 cores, 64 GB
+   * - **polarx.x4.2xlarge.2e**: 16 cores, 64 GB
+   * - **polarx.x8.2xlarge.2e**: 16 cores, 128 GB
+   * - **polarx.x4.4xlarge.2e**: 32 cores, 128 GB
+   * - **polarx.x8.4xlarge.2e**: 32 cores, 256 GB
+   * - **polarx.st.8xlarge.2e**: 60 cores, 470 GB
+   * - **polarx.st.12xlarge.2e**: 90 cores, 720 GB.
+   * 
    * @example
    * polarx.x4.xlarge.2e
    */
   cnNodeClassCode?: string;
   /**
+   * @remarks
+   * The number of CN nodes.
+   * 
    * @example
    * 2
    */
   cnNodeCount?: number;
+  /**
+   * @remarks
+   * The name of the column store engine instance.
+   * 
+   * @example
+   * xxxx
+   */
   columnarInstanceName?: string;
+  /**
+   * @remarks
+   * The column store read-only instance information.
+   */
   columnarReadDBInstances?: string[];
   /**
+   * @remarks
+   * The commodity code of the instance. The value is fixed as drds_polarxpost_public_cn.
+   * 
    * @example
    * drds_polarxpost_public_cn
    */
   commodityCode?: string;
+  /**
+   * @remarks
+   * The endpoint information.
+   */
   connAddrs?: DescribeDBInstanceAttributeResponseBodyDBInstanceConnAddrs[];
+  /**
+   * @remarks
+   * The internal network connection string.
+   * 
+   * @example
+   * pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com
+   */
   connectionString?: string;
   cpuType?: string;
   /**
+   * @remarks
+   * The time when the instance was created.
+   * 
    * @example
    * 2021-08-31T08:56:25.000+0000
    */
   createTime?: string;
   /**
+   * @remarks
+   * The instance type. Valid values:
+   * 
+   * - **ReadWrite**: primary instance.
+   * - **ReadOnly**: read-only instance.
+   * 
    * @example
    * ReadWrite
    */
   DBInstanceType?: string;
   /**
+   * @remarks
+   * The node specifications of the instance.
+   * 
    * @example
    * polarx.x4.large.2e
    */
   DBNodeClass?: string;
   /**
+   * @remarks
+   * The number of instance nodes.
+   * 
    * @example
    * 2
    */
   DBNodeCount?: number;
+  /**
+   * @remarks
+   * The database node information.
+   */
   DBNodes?: DescribeDBInstanceAttributeResponseBodyDBInstanceDBNodes[];
   /**
+   * @remarks
+   * The database type. The value is fixed as polarx.
+   * 
    * @example
    * polarx
    */
   DBType?: string;
   /**
+   * @remarks
+   * The database engine version.
+   * 
    * @example
    * 5.5
    */
   DBVersion?: string;
   /**
+   * @remarks
+   * The description of the instance.
+   * 
    * @example
    * test instance
    */
   description?: string;
+  /**
+   * @remarks
+   * Indicates whether the DN nodes of the instance have different specifications. Valid values:
+   * 
+   * - true: The specifications are different.
+   * - false: The specifications are the same.
+   * 
+   * @example
+   * false
+   */
   differentDNSpec?: boolean;
   /**
+   * @remarks
+   * The DN node specifications. Valid values:
+   * - **mysql.n2.medium.25**: 2 cores, 4 GB
+   * - **mysql.n4.medium.25**: 2 cores, 8 GB
+   * - **mysql.x8.medium.25**: 2 cores, 16 GB
+   * - **mysql.n2.large.25**: 4 cores, 8 GB
+   * - **mysql.n4.large.25**: 4 cores, 16 GB
+   * - **mysql.x8.large.25**: 4 cores, 32 GB
+   * - **mysql.n2.xlarge.25**: 8 cores, 16 GB
+   * - **mysql.n4.xlarge.25**: 8 cores, 32 GB
+   * - **mysql.x8.xlarge.25**: 8 cores, 64 GB
+   * - **mysql.n4.2xlarge.25**: 16 cores, 64 GB
+   * - **mysql.x8.2xlarge.25**: 16 cores, 128 GB
+   * - **mysql.x4.4xlarge.25**: 32 cores, 128 GB
+   * - **mysql.x8.4xlarge.25**: 32 cores, 256 GB
+   * - **mysql.st.8xlarge.25**: 60 cores, 470 GB
+   * - **mysql.st.12xlarge.25**: 90 cores, 720 GB.
+   * 
    * @example
    * mysql.x8.large.25
    */
   dnNodeClassCode?: string;
   /**
+   * @remarks
+   * The number of DN nodes.
+   * 
    * @example
    * 2
    */
   dnNodeCount?: number;
   /**
+   * @remarks
+   * The disk space of the DN data nodes, in GB.
+   */
+  dnStorageSpace?: string;
+  /**
+   * @remarks
+   * The database type. The value is fixed as polarx.
+   * 
    * @example
    * polarx
    */
   engine?: string;
   engineVersion?: string;
   /**
+   * @remarks
+   * The expiration time. The time is in the yyyy-MM-ddTHH:mm:ss.sss+0000 format (UTC).
+   * 
    * @example
    * 2022-08-31T16:00:00.000+0000
    */
   expireDate?: string;
   /**
+   * @remarks
+   * Indicates whether the instance has expired. Valid values:
+   * 
+   * - **true**: The instance has expired.
+   * - **false**: The instance is running normally.
+   * 
    * @example
    * false
    */
@@ -269,11 +445,17 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstance extends $dara.Mod
   gdnMemberList?: DescribeDBInstanceAttributeResponseBodyDBInstanceGdnMemberList[];
   gdnRole?: string;
   /**
+   * @remarks
+   * The ID of the primary instance. If this parameter is not returned, the instance is a primary instance.
+   * 
    * @example
    * pxc-zkralxpc5d****
    */
   id?: string;
   /**
+   * @remarks
+   * The instance DPI engine version code. This is an internal parameter.
+   * 
    * @example
    * 18
    */
@@ -284,41 +466,75 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstance extends $dara.Mod
    */
   LTSVersions?: string[];
   /**
+   * @remarks
+   * The latest kernel version supported by the instance.
+   * 
    * @example
    * polarx-kernel_5.4.11-16301083_xcluster-20210805
    */
   latestMinorVersion?: string;
   /**
+   * @remarks
+   * The lock mode of the instance. Valid values:
+   * 
+   * - **Unlock**: The instance is running normally.
+   * - **ManualLock**: The instance is manually locked.
+   * - **LockByExpiration**: The instance is automatically locked due to expiration.
+   * - **LockByRestoration**: The instance is automatically locked before a rollback.
+   * - **LockByDiskQuota**: The instance is automatically locked because the storage is full.
+   * - **LockReadInstanceByDiskQuota**: The read-only instance is automatically locked because the storage is full.
+   * 
    * @example
    * Unlock
    */
   lockMode?: string;
   /**
+   * @remarks
+   * The end time of the maintenance window. The time is in UTC. Add 8 hours to obtain the maintenance window displayed in the console.
+   * 
    * @example
    * 06:00
    */
   maintainEndTime?: string;
   /**
+   * @remarks
+   * The start time of the maintenance window. The time is in UTC. Add 8 hours to obtain the maintenance window displayed in the console.
+   * 
    * @example
    * 06:00
    */
   maintainStartTime?: string;
   /**
+   * @remarks
+   * The current kernel version.
+   * 
    * @example
    * polarx-kernel_5.4.11-16301083_xcluster-20210805
    */
   minorVersion?: string;
   /**
+   * @remarks
+   * The network type of the instance. Only VPC is supported, which indicates a virtual private cloud (VPC).
+   * 
    * @example
    * VPC
    */
   network?: string;
   /**
+   * @remarks
+   * The billing method of the instance. Valid values:
+   * 
+   * - **Postpaid**: pay-as-you-go.
+   * - **Prepaid**: subscription.
+   * 
    * @example
    * Postpaid
    */
   payType?: string;
   /**
+   * @remarks
+   * The internal network connection port.
+   * 
    * @example
    * 3306
    */
@@ -326,71 +542,129 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstance extends $dara.Mod
   primaryInstanceId?: string;
   /**
    * @remarks
-   * 主可用区。
+   * The primary zone.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * cn-shenzhen-e
    */
   primaryZone?: string;
+  /**
+   * @remarks
+   * The list of read-only instance names.
+   */
   readDBInstances?: string[];
   /**
+   * @remarks
+   * The region in which the instance resides.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
-   * rg-xxxx
+   * rg-*********
    */
   resourceGroupId?: string;
   /**
+   * @remarks
+   * The three-role mode status. Valid values:
+   * 
+   * - **false**: Disabled.
+   * - **true**: Enabled.
+   * 
    * @example
    * false
    */
   rightsSeparationEnabled?: boolean;
   /**
+   * @remarks
+   * The three-role mode status. Valid values:
+   * 
+   * - **disabled**: Disabled.
+   * - **enabled**: Enabled.
+   * - **processing**: Being processed.
+   * - **unknown**: Unknown. The instance may be disconnected.
+   * 
    * @example
    * disabled
    */
   rightsSeparationStatus?: string;
   /**
    * @remarks
-   * 次可用区。
+   * The secondary zone.
+   * 
+   * @example
+   * cn-shenzhen-a
    */
   secondaryZone?: string;
   /**
+   * @remarks
+   * The instance edition. Valid values:
+   * 
+   * - **enterprise**: Enterprise Edition.
+   * - **standard**: Standard Edition.
+   * 
    * @example
    * enterprise
    */
   series?: string;
   specCategory?: string;
   /**
+   * @remarks
+   * The instance status. For more information, see [Instance status table](https://help.aliyun.com/document_detail/339826.html).
+   * 
    * @example
    * Running
    */
   status?: string;
   storageType?: string;
   /**
+   * @remarks
+   * The used storage space, in bytes.
+   * 
    * @example
    * 17042505728
    */
   storageUsed?: number;
+  /**
+   * @remarks
+   * The tag set.
+   */
   tagSet?: DescribeDBInstanceAttributeResponseBodyDBInstanceTagSet[];
   /**
    * @remarks
-   * 第三可用区。
+   * The third zone.
+   * 
+   * @example
+   * cn-shenzhen-e
    */
   tertiaryZone?: string;
   /**
    * @remarks
-   * 拓扑类型：
+   * The topology type. Valid values:
    * 
-   * - **3azones**：三可用区；
-   * - **1azone**：单可用区。
+   * - **3azones**: three-zone deployment.
+   * - **1azone**: single-zone deployment.
    * 
    * This parameter is required.
+   * 
+   * @example
+   * 3azones
    */
   topologyType?: string;
   /**
+   * @remarks
+   * The instance type. Valid values:
+   * 
+   * - **ReadWrite**: primary instance.
+   * - **ReadOnly**: read-only instance.
+   * 
    * @example
    * ReadWrite
    */
@@ -403,8 +677,18 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstance extends $dara.Mod
    * vpc-xxxxx
    */
   VPCId?: string;
+  /**
+   * @remarks
+   * The vSwitch ID.
+   * 
+   * @example
+   * vsw-********
+   */
   vSwitchId?: string;
   /**
+   * @remarks
+   * The zone in which the instance resides.
+   * 
    * @example
    * cn-hangzhou-a
    */
@@ -431,6 +715,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstance extends $dara.Mod
       differentDNSpec: 'DifferentDNSpec',
       dnNodeClassCode: 'DnNodeClassCode',
       dnNodeCount: 'DnNodeCount',
+      dnStorageSpace: 'DnStorageSpace',
       engine: 'Engine',
       engineVersion: 'EngineVersion',
       expireDate: 'ExpireDate',
@@ -494,6 +779,7 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstance extends $dara.Mod
       differentDNSpec: 'boolean',
       dnNodeClassCode: 'string',
       dnNodeCount: 'number',
+      dnStorageSpace: 'string',
       engine: 'string',
       engineVersion: 'string',
       expireDate: 'string',
@@ -566,8 +852,15 @@ export class DescribeDBInstanceAttributeResponseBodyDBInstance extends $dara.Mod
 }
 
 export class DescribeDBInstanceAttributeResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The database instance information.
+   */
   DBInstance?: DescribeDBInstanceAttributeResponseBodyDBInstance;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 9B2F3840-5C98-475C-B269-2D5C3A31797C
    */

package/src/models/DescribeDbinstanceConfigRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBInstanceConfigRequest extends $dara.Model {
   /**
    * @remarks
+   * The configuration identifier. Default value: htap.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeDBInstanceConfigRequest extends $dara.Model {
   configName?: string;
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class DescribeDBInstanceConfigRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The ID of the region in which the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeDbinstanceConfigResponseBody.ts

@@ -4,11 +4,36 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDBInstanceConfigResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The configuration key.
+   * 
    * @example
    * htap
    */
   configName?: string;
+  /**
+   * @remarks
+   * The configuration item. The following parameters are included:
+   * 
+   * - attendHtapList: the list of instances for which HTAP is enabled.
+   * - autoAttendHtap: specifies whether to automatically add newly created read-only instances to the HTAP list.
+   * - delayExecutionStrategy: when the read-only instance lag reaches the value specified by storageDelayThreshold, read-only traffic is routed back to the primary instance. Default value: 1. Valid values: 0 and 1.
+   * - enableConsistentReplicaRead: specifies whether to enable consistent reads.
+   * - storageDelayThreshold: the latency threshold for read-only instances. Default value: 3s. Valid values: 0 to 86400.
+   * - enableHtap: specifies whether to enable HTAP.
+   * - masterReadWeight: the read weight of the primary node. A value of 100 indicates that 100% of traffic is routed to the primary node. Valid values: 0 to 100.
+   * 
+   * @example
+   * {\\"attendHtapList\\":[\\"pxc-hzruyzes08****\\"],\\"autoAttendHtap\\":\\"true\\",\\"delayExecutionStrategy\\":1,\\"enableConsistentReplicaRead\\":true,\\"enableHtap\\":\\"true\\",\\"masterReadWeight\\":100,\\"storageDelayThreshold\\":3}
+   */
   configValue?: string;
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * @example
+   * pxc-sprcym7g7w****
+   */
   dbInstanceName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -36,8 +61,15 @@ export class DescribeDBInstanceConfigResponseBodyData extends $dara.Model {
 }
 
 export class DescribeDBInstanceConfigResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeDBInstanceConfigResponseBodyData;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C458B1E8-1683-3645-B154-6BA32080EEA
    */

package/src/models/DescribeDbinstanceEndpointResponseBody.ts

@@ -158,6 +158,10 @@ export class DescribeDBInstanceEndpointResponseBodyDataItemsRealServer extends $
    * 3306
    */
   port?: string;
+  /**
+   * @example
+   * 节点id
+   */
   replicaId?: number;
   /**
    * @example
@@ -266,9 +270,6 @@ export class DescribeDBInstanceEndpointResponseBody extends $dara.Model {
    */
   nextToken?: string;
   /**
-   * @remarks
-   * Id of the request
-   * 
    * @example
    * A501A191-BD70-5E50-98A9-C2A486A82****
    */

package/src/models/DescribeDbinstanceSslrequest.ts

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