@alicloud/polardbx20200202 3.4.2 → 3.5.0

package/src/models/DescribeDbinstanceSslresponseBody.ts

@@ -4,16 +4,28 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDBInstanceSSLResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The domain name bound to the certificate.
+   * 
    * @example
    * pxc-sddddddcym7g7w****.polarx.singapore.rds.aliyuncs.com
    */
   certCommonName?: string;
   /**
+   * @remarks
+   * Indicates whether SSL is enabled for the instance:
+   * 
+   * - **true**: enabled
+   * - **false**: disabled
+   * 
    * @example
    * false
    */
   SSLEnabled?: boolean;
   /**
+   * @remarks
+   * The expiration time of the SSL certificate.
+   * 
    * @example
    * 2022-11-04T09:39:07Z
    */
@@ -44,8 +56,15 @@ export class DescribeDBInstanceSSLResponseBodyData extends $dara.Model {
 }
 
 export class DescribeDBInstanceSSLResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data structure.
+   */
   data?: DescribeDBInstanceSSLResponseBodyData;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C458B1E8-1683-3645-B154-6BA32080EEA
    */

package/src/models/DescribeDbinstanceTderequest.ts

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

package/src/models/DescribeDbinstanceTderesponseBody.ts

@@ -4,6 +4,12 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDBInstanceTDEResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether TDE is enabled. Valid values:
+   * 
+   * - 0: TDE is disabled.
+   * - 1: TDE is enabled.
+   * 
    * @example
    * 0
    */
@@ -30,8 +36,15 @@ export class DescribeDBInstanceTDEResponseBodyData extends $dara.Model {
 }
 
 export class DescribeDBInstanceTDEResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeDBInstanceTDEResponseBodyData;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C458B1E8-1683-3645-B154-6BA32080EEA
    */

package/src/models/DescribeDbinstanceTopologyRequest.ts

@@ -5,22 +5,47 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBInstanceTopologyRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
    * pxc-********
    */
   DBInstanceName?: string;
+  /**
+   * @remarks
+   * The end time of the time range for querying historical instances in the topology. Format: yyyy-MM-dd HH:mm:ss.
+   * 
+   * @example
+   * 2021-10-22T10:30:45Z 04:00:00
+   */
   endTime?: string;
+  /**
+   * @remarks
+   * Specifies whether to query the historical topology.
+   * 
+   * @example
+   * true
+   */
   minuteSimple?: boolean;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
+  /**
+   * @remarks
+   * The start time of the time range for querying historical instances in the topology. Format: yyyy-MM-dd HH:mm:ss.
+   * 
+   * @example
+   * 2021-10-21T10:30:45Z 04:00:00
+   */
   startTime?: string;
   static names(): { [key: string]: string } {
     return {

package/src/models/DescribeDbinstanceTopologyResponseBody.ts

@@ -3,13 +3,76 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyHistoryItems extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the node is activated. For the compute layer, only the node in the primary zone is activated. After a primary/secondary switchover is performed on the instance, the standby compute node becomes the primary node. All storage layer nodes are activated.
+   * 
+   * @example
+   * true
+   */
   activated?: boolean;
+  /**
+   * @remarks
+   * The zone of the node. If the node is an RDS node, the zones of multiple child nodes are separated with a delimiter (,).
+   * 
+   * @example
+   * cn-hangzhou-a
+   */
   azone?: string;
+  /**
+   * @remarks
+   * The node type. Valid values:
+   * 
+   * - **polarx_cn**: compute node.
+   * - **polarx_store**: data node.
+   * - **polarx_gms**: GMS node.
+   * 
+   * @example
+   * 节点角色
+   */
   characterType?: string;
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * @example
+   * 304726049
+   */
   DBInstanceId?: string;
+  /**
+   * @remarks
+   * The instance name.
+   * 
+   * @example
+   * pxc-sprcym7g7w****
+   */
   DBInstanceName?: string;
+  /**
+   * @remarks
+   * The physical instance name.
+   * 
+   * @example
+   * pxc-unrbk8oyz**********
+   */
   phyInstanceName?: string;
+  /**
+   * @remarks
+   * The region of the node. If the node is an RDS node, the regions of multiple child nodes are separated with a delimiter (,).
+   * 
+   * @example
+   * cn-hangzhou
+   */
   region?: string;
+  /**
+   * @remarks
+   * The role of the node. Valid values:
+   * 
+   * - **master**: primary node
+   * - **standby**: secondary node.
+   * 
+   * @example
+   * master
+   */
   role?: string;
   static names(): { [key: string]: string } {
     return {
@@ -48,11 +111,21 @@ export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyHist
 
 export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItemsAzoneRoleList extends $dara.Model {
   /**
+   * @remarks
+   * The zone of a node in the RDS three-node cluster.
+   * 
    * @example
    * cn-hangzhou-a
    */
   azone?: string;
   /**
+   * @remarks
+   * The role of a node in the RDS three-node cluster. Valid values:
+   * 
+   * - **leader**: primary node
+   * - **follower**: secondary node
+   * - **logger**: logger node.
+   * 
    * @example
    * leader
    */
@@ -82,16 +155,25 @@ export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItem
 
 export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItemsConnectionIp extends $dara.Model {
   /**
+   * @remarks
+   * The connection information.
+   * 
    * @example
    * pxc-xdb-m-pxcdym7g7w********.mysql.singapore.rds.aliyuncs.com
    */
   connectionString?: string;
   /**
+   * @remarks
+   * The internal connection type. The value is fixed to 1, which indicates the classic network.
+   * 
    * @example
    * 1
    */
   DBInstanceNetType?: number;
   /**
+   * @remarks
+   * The port.
+   * 
    * @example
    * 3306
    */
@@ -123,99 +205,255 @@ export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItem
 
 export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItems extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the node is activated. For the compute layer, only the node in the primary zone is activated. After a primary/secondary switchover is performed on the instance, the standby compute node becomes the primary node. All storage layer nodes are activated.
+   * 
    * @example
    * true
    */
   activated?: boolean;
   /**
+   * @remarks
+   * The zone of the node. If the node is an RDS node, the zones of multiple child nodes are separated with a delimiter (,).
+   * 
    * @example
    * cn-hangzhou-a
    */
   azone?: string;
+  /**
+   * @remarks
+   * The data information list of the RDS three-node cluster.
+   */
   azoneRoleList?: DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItemsAzoneRoleList[];
+  /**
+   * @remarks
+   * The node type. Valid values:
+   * 
+   * - **polarx_cn**: compute node.
+   * - **polarx_store**: data node.
+   * - **polarx_gms**: GMS node.
+   * 
+   * @example
+   * 节点角色
+   */
   characterType?: string;
+  /**
+   * @remarks
+   * The data struct.
+   */
   connectionIp?: DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItemsConnectionIp[];
+  /**
+   * @remarks
+   * The connection type.
+   * 
+   * @example
+   * 不展示
+   */
   DBInstanceConnType?: number;
   /**
+   * @remarks
+   * The time when the instance was created.
+   * 
    * @example
    * 2021-10-21T10:30:45Z
    */
   DBInstanceCreateTime?: string;
+  /**
+   * @remarks
+   * The instance description.
+   * 
+   * @example
+   * 不展示
+   */
   DBInstanceDescription?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * 304726049
    */
   DBInstanceId?: string;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * pxc-i-tk6t4z****
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The instance status.
+   * 
    * @example
    * 8
    */
   DBInstanceStatus?: number;
+  /**
+   * @remarks
+   * The description of the instance status.
+   * 
+   * @example
+   * 不展示
+   */
   DBInstanceStatusDescription?: string;
   /**
+   * @remarks
+   * The disk size.
+   * 
    * @example
    * 3145728
    */
   diskSize?: number;
   /**
+   * @remarks
+   * The engine type. Valid values:
+   * 
+   * - **mysql**
+   * - **polarx_cdc**
+   * - **polarx_dn**
+   * 
    * @example
    * mysql
    */
   engine?: string;
   /**
+   * @remarks
+   * The engine version. Default value: 2.0.
+   * 
    * @example
    * 5.7
    */
   engineVersion?: string;
   instanceClusterName?: string;
   /**
+   * @remarks
+   * Indicates whether the node is locked. Valid values:
+   * 
+   * - **0**: Not locked.
+   * - **1**: Locked.
+   * 
    * @example
    * 0
    */
   lockMode?: number;
+  /**
+   * @remarks
+   * The reason why the instance is locked.
+   * 
+   * @example
+   * 不展示
+   */
   lockReason?: string;
+  /**
+   * @remarks
+   * The end time of the O&M window.
+   * 
+   * @example
+   * 不展示
+   */
   maintainEndTime?: string;
+  /**
+   * @remarks
+   * The start time of the O&M window.
+   * 
+   * @example
+   * 不展示
+   */
   maintainStartTime?: string;
   /**
+   * @remarks
+   * The maximum number of connections.
+   * 
    * @example
    * 4000
    */
   maxConnections?: number;
   /**
+   * @remarks
+   * The maximum IOPS.
+   * 
    * @example
    * 7000
    */
   maxIops?: number;
   /**
+   * @remarks
+   * The 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.large.2e
    */
   nodeClass?: string;
+  /**
+   * @remarks
+   * The physical instance name.
+   * 
+   * @example
+   * pxc-unrbk8oyz**********
+   */
   phyInstanceName?: string;
   readType?: string;
   /**
+   * @remarks
+   * The region of the node. If the node is an RDS node, the regions of multiple child nodes are separated with a delimiter (,).
+   * 
    * @example
    * cn-hangzhou
    */
   region?: string;
   /**
+   * @remarks
+   * The role of the node. Valid values:
+   * 
+   * - **master**: primary node
+   * - **standby**: secondary node.
+   * 
    * @example
    * master
    */
   role?: string;
   /**
+   * @remarks
+   * The node status. Valid values:
+   * 
+   * - **0**: Running.
+   * - **1**: Creating.
+   * - **2**: Abnormal.
+   * - **3**: Expired.
+   * - **4**: Releasing.
+   * - **5**: Released.
+   * - **6**: Locked.
+   * 
    * @example
    * 0
    */
   status?: string;
+  /**
+   * @remarks
+   * The storage usage, in MB.
+   * 
+   * @example
+   * 16681
+   */
   storageUsed?: string;
   /**
+   * @remarks
+   * The logger node version.
+   * 
    * @example
    * polarx-cdc-kernel-2.0.0-3985896
    */
@@ -307,69 +545,126 @@ export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItem
 
 export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopology extends $dara.Model {
   /**
+   * @remarks
+   * Indicates that LVS is used for load balancing.
+   * 
    * @example
    * lvs
    */
   DBInstanceConnType?: string;
   /**
+   * @remarks
+   * The time when the instance was created. Format: yyyy-MM-dd HH:mm:ss.
+   * 
    * @example
    * 2021-10-21T10:30:45Z 04:00:00
    */
   DBInstanceCreateTime?: string;
   /**
+   * @remarks
+   * The instance description.
+   * 
    * @example
-   * pxc-sprcym7g7wj7k
+   * pxc-sprcym7******
    */
   DBInstanceDescription?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * 304726047
    */
   DBInstanceId?: string;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * pxc-sprcym7g7w****
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The instance status.
+   * 
    * @example
    * 8
    */
   DBInstanceStatus?: number;
   /**
+   * @remarks
+   * The description of the instance status.
+   * 
    * @example
    * TDE_MODIFYING
    */
   DBInstanceStatusDescription?: string;
   /**
+   * @remarks
+   * The number of storage nodes.
+   * 
    * @example
    * 1
    */
   DBInstanceStorage?: number;
   /**
+   * @remarks
+   * The engine type. Default value: polarx.
+   * 
    * @example
    * polarx
    */
   engine?: string;
   /**
+   * @remarks
+   * The engine version. Default value: 2.0.
+   * 
    * @example
    * 2.0
    */
   engineVersion?: string;
+  /**
+   * @remarks
+   * The list of historical nodes.
+   */
   historyItems?: DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyHistoryItems[];
+  /**
+   * @remarks
+   * The list of nodes.
+   */
   items?: DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopologyItems[];
   /**
+   * @remarks
+   * The lock status. Valid values:
+   * 
+   * - **0**: Not locked.
+   * - **1**: Locked.
+   * 
    * @example
    * 0
    */
   lockMode?: number;
+  /**
+   * @remarks
+   * The reason why the instance is locked.
+   * 
+   * @example
+   * 欠费
+   */
   lockReason?: string;
   /**
+   * @remarks
+   * The end time of the O&M window. Format: HH:mm:ss.
+   * 
    * @example
    * 05:00:00
    */
   maintainEndTime?: string;
   /**
+   * @remarks
+   * The start time of the O&M window. Format: HH:mm:ss.
+   * 
    * @example
    * 04:00:00
    */
@@ -432,6 +727,10 @@ export class DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopology ext
 }
 
 export class DescribeDBInstanceTopologyResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The topology information.
+   */
   logicInstanceTopology?: DescribeDBInstanceTopologyResponseBodyDataLogicInstanceTopology;
   static names(): { [key: string]: string } {
     return {
@@ -458,8 +757,15 @@ export class DescribeDBInstanceTopologyResponseBodyData extends $dara.Model {
 }
 
 export class DescribeDBInstanceTopologyResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeDBInstanceTopologyResponseBodyData;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * C458B1E8-1683-3645-B154-6BA32080EEA
    */

package/src/models/DescribeDbinstanceViaEndpointRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBInstanceViaEndpointRequest extends $dara.Model {
   /**
    * @remarks
+   * The endpoint of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,7 +15,12 @@ export class DescribeDBInstanceViaEndpointRequest extends $dara.Model {
   endpoint?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
    */
   regionId?: string;
   static names(): { [key: string]: string } {