@alicloud/polardbx20200202 3.4.2 → 3.5.0

package/src/models/DescribeComponentPropetiesResponseBody.ts

@@ -3,18 +3,36 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeComponentPropetiesResponseBodyProperties extends $dara.Model {
+  /**
+   * @remarks
+   * The name.
+   * 
+   * @example
+   * 4核32G
+   */
   name?: string;
   /**
+   * @remarks
+   * The display order of the commodity module property.
+   * 
+   * The returned content varies depending on the commodity module.
+   * 
    * @example
    * 1
    */
   orderIndex?: string;
   /**
+   * @remarks
+   * The commodity module.
+   * 
    * @example
    * dn_node_spec
    */
   propertyCode?: string;
   /**
+   * @remarks
+   * The label value.
+   * 
    * @example
    * 172.27.35.
    */
@@ -47,6 +65,10 @@ export class DescribeComponentPropetiesResponseBodyProperties extends $dara.Mode
 }
 
 export class DescribeComponentPropetiesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The export parameters of the exception event.
+   */
   properties?: DescribeComponentPropetiesResponseBodyProperties[];
   /**
    * @remarks

package/src/models/DescribeCustomEndpointListRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeCustomEndpointListRequest extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to check if the compute node (CN) has been deleted.
+   * 
    * @example
    * true
    */
   checkDeleteCN?: boolean;
   /**
+   * @remarks
+   * The IDs of custom endpoints.
+   * 
    * @example
    * pxe-b6e****no4pfap1s
    */
   customEndpointIds?: string;
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -22,6 +30,9 @@ export class DescribeCustomEndpointListRequest extends $dara.Model {
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The region in which the instance resides.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/DescribeCustomEndpointListResponseBody.ts

@@ -9,51 +9,82 @@ export class DescribeCustomEndpointListResponseBodyDataEndpoints extends $dara.M
    */
   cnNames?: string[];
   /**
+   * @remarks
+   * The endpoint of the instance.
+   * 
    * @example
    * pxc-shra****zq0j01.polarx.rds.aliyuncs.com
    */
   connectionString?: string;
   /**
+   * @remarks
+   * The ID of the custom endpoint.
+   * 
    * @example
    * pxe-b6e****o4pfap1s
    */
   customEndpointId?: string;
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * pxc-hz****zoxherr7
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The name of the custom endpoint.
+   * 
    * @example
    * Name
    */
   name?: string;
   /**
+   * @remarks
+   * Indicates whether a node automatically joins the cluster and starts providing services after the node is added or recovered.
+   * 
    * @example
    * true
    */
   nodeAutoEnter?: string;
   /**
+   * @remarks
+   * To query the metrics of a read-only node in a cloud-native read/write splitting architecture instance, set this parameter to **READONLY** and specify the **NodeId** parameter.
+   * >  In other cases, you do not need to specify this parameter or you can set it to **MASTER**.
+   * 
    * @example
    * same_azone_as_last
    */
   nodeRole?: string;
   /**
+   * @remarks
+   * The port used to connect to the instance.
+   * 
    * @example
    * 3306
    */
   port?: number;
   /**
+   * @remarks
+   * The status of the custom endpoint.
+   * 
    * @example
    * created
    */
   status?: string;
   /**
+   * @remarks
+   * The ID of the vSwitch.
+   * 
    * @example
    * vsw-8vbkw****5yh4nrd639ih
    */
   vSwitchId?: string;
   /**
+   * @remarks
+   * The ID of the virtual private cloud (VPC) in which the endpoint resides.
+   * 
    * @example
    * vpc-uf61h****dj1zg5fqp5x7
    */
@@ -104,10 +135,17 @@ export class DescribeCustomEndpointListResponseBodyDataEndpoints extends $dara.M
 
 export class DescribeCustomEndpointListResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * Indicates whether the node can be deleted.
+   * 
    * @example
    * 0
    */
   canDeleteCount?: number;
+  /**
+   * @remarks
+   * The details of the endpoints.
+   */
   endpoints?: DescribeCustomEndpointListResponseBodyDataEndpoints[];
   static names(): { [key: string]: string } {
     return {
@@ -136,6 +174,10 @@ export class DescribeCustomEndpointListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeCustomEndpointListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The data struct.
+   */
   data?: DescribeCustomEndpointListResponseBodyData;
   /**
    * @remarks

package/src/models/DescribeDataImportTaskInfoRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDataImportTaskInfoRequest extends $dara.Model {
   /**
+   * @remarks
+   * The page number of failed records.
+   * 
    * @example
    * 1
    */
   failPageNumber?: number;
   /**
+   * @remarks
+   * The number of failed records to display per page.
+   * 
    * @example
    * 10
    */
   failPageSize?: number;
   /**
    * @remarks
+   * The region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -23,6 +31,8 @@ export class DescribeDataImportTaskInfoRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The task ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -30,11 +40,17 @@ export class DescribeDataImportTaskInfoRequest extends $dara.Model {
    */
   slinkTaskId?: string;
   /**
+   * @remarks
+   * The page number of successful records.
+   * 
    * @example
    * 1
    */
   successPageNumber?: number;
   /**
+   * @remarks
+   * The number of successful records to display per page.
+   * 
    * @example
    * 15
    */

package/src/models/DescribeDataImportTaskInfoResponseBody.ts

@@ -4,26 +4,41 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfoServiceDetailListTaskDetailList extends $dara.Model {
   /**
+   * @remarks
+   * The delay time.
+   * 
    * @example
    * 58329
    */
   delay?: number;
   /**
+   * @remarks
+   * The most recent error message.
+   * 
    * @example
    * null
    */
   lastError?: string;
   /**
+   * @remarks
+   * The physical database name.
+   * 
    * @example
    * drds_test
    */
   physicalDbName?: string;
   /**
+   * @remarks
+   * The data import progress.
+   * 
    * @example
    * 0
    */
   progress?: number;
   /**
+   * @remarks
+   * The performance and runtime metrics collected during the execution of the data migration or import task.
+   * 
    * @example
    * {
    *   "applyCount": 0,
@@ -34,16 +49,25 @@ export class DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfoS
    */
   statistics?: string;
   /**
+   * @remarks
+   * The task status.
+   * 
    * @example
    * active
    */
   status?: string;
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * fc3b1568-ad96-****-adca-dfe018b38077
    */
   taskId?: number;
   /**
+   * @remarks
+   * The task type.
+   * 
    * @example
    * FULL_COPY
    */
@@ -85,17 +109,32 @@ export class DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfoS
 
 export class DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfoServiceDetailList extends $dara.Model {
   /**
+   * @remarks
+   * The service detail ID.
+   * 
    * @example
    * 1991609
    */
   id?: number;
   /**
+   * @remarks
+   * The task execution status.
+   * 
    * @example
    * FINISHED
    */
   status?: string;
+  /**
+   * @remarks
+   * The task details.
+   */
   taskDetailList?: DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfoServiceDetailListTaskDetailList[];
   /**
+   * @remarks
+   * Valid values:
+   * - FULL_COPY: full replication.
+   * - INC_COPY: incremental replication.
+   * 
    * @example
    * FULL_COPY
    */
@@ -132,20 +171,33 @@ export class DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfoS
 
 export class DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfo extends $dara.Model {
   /**
+   * @remarks
+   * The progress ID.
+   * 
    * @example
    * 1
    */
   fsmId?: number;
   /**
+   * @remarks
+   * The state identifier in a data migration or synchronization task.
+   * 
    * @example
    * RECON_FINISHED_CATCH_UP
    */
   fsmState?: string;
   /**
+   * @remarks
+   * The status in a data migration, import, or synchronization system.
+   * 
    * @example
    * IMPORT_NOT_BEGIN
    */
   fsmStatus?: string;
+  /**
+   * @remarks
+   * The data import task details.
+   */
   serviceDetailList?: DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfoServiceDetailList[];
   static names(): { [key: string]: string } {
     return {
@@ -178,6 +230,10 @@ export class DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfo
 }
 
 export class DescribeDataImportTaskInfoResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The task details.
+   */
   dataImportTaskDetailInfo?: DescribeDataImportTaskInfoResponseBodyDataDataImportTaskDetailInfo;
   static names(): { [key: string]: string } {
     return {
@@ -205,22 +261,38 @@ export class DescribeDataImportTaskInfoResponseBodyData extends $dara.Model {
 
 export class DescribeDataImportTaskInfoResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The return code. This parameter is empty when the request succeeds. When the request fails, an exception message such as an error code is returned.
+   * 
    * @example
    * 200
    */
   code?: number;
+  /**
+   * @remarks
+   * The returned result set.
+   */
   data?: DescribeDataImportTaskInfoResponseBodyData;
   /**
+   * @remarks
+   * The returned message. This parameter has a value only when the task status is success. Otherwise, an empty value is returned.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 9B2F3840-5C98-****-B269-2D5C3A31797C
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeDbListRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDbListRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,12 +14,17 @@ export class DescribeDbListRequest extends $dara.Model {
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The database name.
+   * 
    * @example
    * db_name
    */
   DBName?: string;
   /**
    * @remarks
+   * The region ID of the instance.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/DescribeDbListResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeDbListResponseBodyDataAccounts extends $dara.Model {
   /**
+   * @remarks
+   * The account name.
+   * 
    * @example
    * root4test
    */
   accountName?: string;
   /**
+   * @remarks
+   * The account privilege.
+   * 
    * @example
    * ReadWrite
    */
@@ -37,23 +43,39 @@ export class DescribeDbListResponseBodyDataAccounts extends $dara.Model {
 }
 
 export class DescribeDbListResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The list of accounts.
+   */
   accounts?: DescribeDbListResponseBodyDataAccounts[];
   /**
+   * @remarks
+   * The character set.
+   * 
    * @example
    * utf8mb4
    */
   characterSetName?: string;
   /**
+   * @remarks
+   * The database description.
+   * 
    * @example
    * test
    */
   DBDescription?: string;
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * pxc-********
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The database name.
+   * 
    * @example
    * test
    */
@@ -91,18 +113,31 @@ export class DescribeDbListResponseBodyData extends $dara.Model {
 }
 
 export class DescribeDbListResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The list of databases.
+   */
   data?: DescribeDbListResponseBodyData[];
   /**
+   * @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
    * C458B1E8-1683-3645-B154-6BA32080EEA
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeDbinstanceAttributeRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeDBInstanceAttributeRequest extends $dara.Model {
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class DescribeDBInstanceAttributeRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The region in which the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,6 +24,9 @@ export class DescribeDBInstanceAttributeRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the resource group.
+   * 
    * @example
    * rg-aekzaxhezhs5***
    */