@alicloud/polardbx20200202 3.4.2 → 3.5.0

package/src/models/DescribeEnabledCrossRegionsResponseBody.ts

@@ -3,6 +3,10 @@ import * as $dara from '@darabonba/typescript';
 
 
 export class DescribeEnabledCrossRegionsResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether VPC is supported.
+   */
   regions?: string[];
   static names(): { [key: string]: string } {
     return {
@@ -29,8 +33,15 @@ export class DescribeEnabledCrossRegionsResponseBodyData extends $dara.Model {
 }
 
 export class DescribeEnabledCrossRegionsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The parameter details.
+   */
   data?: DescribeEnabledCrossRegionsResponseBodyData[];
   /**
+   * @remarks
+   * The error message.
+   * 
    * @example
    * *****
    */
@@ -44,6 +55,9 @@ export class DescribeEnabledCrossRegionsResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeEvaluateAndImportTaskRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class DescribeEvaluateAndImportTaskRequest extends $dara.Model {
   /**
    * @remarks
+   * The region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -12,6 +14,9 @@ export class DescribeEvaluateAndImportTaskRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The ID of the link task.
+   * 
    * @example
    * etx-szr2rr6i*****
    */

package/src/models/DescribeEvaluateAndImportTaskResponseBody.ts

@@ -4,97 +4,161 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeEvaluateAndImportTaskResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The business ID of the import task.
+   * 
    * @example
    * 26842
    */
   bid?: string;
+  /**
+   * @remarks
+   * The summary information.
+   * 
+   * @example
+   * "{\\"structureImportResult\\":{\\"status\\":\\"finish\\",\\"finishedNum\\":382,\\"totalNum\\":382,\\"percentage\\":100},\\"switchTips\\":\\"正向同步延迟较小时才允许开始正向切换\\",\\"autoTableSuggestionSwitch\\":false,\\"structureAlterationMap\\":{},\\"acceptFilterMap\\":{\\"fr_import\\":[\\"dy_dr_new\\"],\\"e3plus_drp_prod_new\\":[],\\"qbtong_prod\\":[],\\"e3plus_account_prod\\":[],\\"e3plus_drp_prod\\":[]},\\"structChunkMap\\":{},\\"count\\":1,\\"requestId\\":\\"9380D025-C9B1-51D6-A4B9-733C4879CC4A\\"}",
+   */
   context?: string;
   /**
+   * @remarks
+   * The creator of the import task.
+   * 
    * @example
    * 346650
    */
   creator?: string;
   /**
+   * @remarks
+   * Indicates whether the import task is successful.
+   * 
    * @example
    * false
    */
   deleted?: boolean;
   /**
+   * @remarks
+   * The timestamp when the task was created.
+   * 
    * @example
    * 2025-06-08T15:00Z
    */
   gmtCreated?: number;
   /**
+   * @remarks
+   * The modification time in timestamp format.
+   * 
    * @example
    * 1605080537000
    */
   gmtModified?: number;
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * 76251
    */
   id?: number;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The name of the slink destination database.
+   * 
    * @example
    * fr_import
    */
   slinkDstDb?: string;
   /**
+   * @remarks
+   * The instance ID of the destination.
+   * 
    * @example
    * pxc-hzrehc60jz5zye
    */
   slinkDstResId?: string;
   /**
+   * @remarks
+   * The username for the data connection of the destination.
+   * 
    * @example
    * dts_dtdba
    */
   slinkDstUserName?: string;
   /**
+   * @remarks
+   * The name of the slink source database.
+   * 
    * @example
    * fr_import
    */
   slinkSrcDb?: string;
   /**
+   * @remarks
+   * The instance ID of the source.
+   * 
    * @example
    * drdshbga69378w4p
    */
   slinkSrcResId?: string;
   /**
+   * @remarks
+   * The resource type of the source.
+   * 
    * @example
    * POLARX1
    */
   slinkSrcResType?: string;
   /**
+   * @remarks
+   * The username for the data connection of the source.
+   * 
    * @example
    * dtdba
    */
   slinkSrcUserName?: string;
   /**
+   * @remarks
+   * The stage of the synchronization.
+   * 
    * @example
    * DATA_IMPORT_RUNNING
    */
   slinkStage?: string;
   /**
+   * @remarks
+   * The running status of the synchronization.
+   * 
    * @example
    * IMPORT_RUNNING
    */
   slinkStatus?: string;
   /**
+   * @remarks
+   * The description of the slink task.
+   * 
    * @example
    * drdsprod_to_2.0
    */
   slinkTaskDesc?: string;
   /**
+   * @remarks
+   * The slink task ID.
+   * 
    * @example
    * etx-szr2rr6i*****
    */
   slinkTaskId?: string;
   /**
+   * @remarks
+   * The synchronization type.
+   * 
    * @example
    * evaluate_import
    */
@@ -159,18 +223,31 @@ export class DescribeEvaluateAndImportTaskResponseBodyData extends $dara.Model {
 }
 
 export class DescribeEvaluateAndImportTaskResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned result.
+   */
   data?: DescribeEvaluateAndImportTaskResponseBodyData;
   /**
+   * @remarks
+   * The response message. This parameter is empty when the request succeeds. If the request fails, an exception message is returned, such as an error code.
+   * 
    * @example
    * Success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 73559800-****-11ec-bd40-99cfcff3fe1e
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * true
    */

package/src/models/DescribeEvaluateAndImportTasksRequest.ts

@@ -4,17 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeEvaluateAndImportTasksRequest extends $dara.Model {
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 0
    */
   pageSize?: number;
   /**
    * @remarks
+   * The region where 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

package/src/models/DescribeEvaluateAndImportTasksResponseBody.ts

@@ -4,96 +4,153 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeEvaluateAndImportTasksResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The business ID of the import task.
+   * 
    * @example
    * 26842
    */
   bid?: string;
   /**
+   * @remarks
+   * The creator of the import task.
+   * 
    * @example
    * 346650
    */
   creator?: string;
   /**
+   * @remarks
+   * Indicates whether the task is deleted.
+   * 
    * @example
    * fase
    */
   deleted?: boolean;
   /**
+   * @remarks
+   * The task creation timestamp, in milliseconds.
+   * 
    * @example
    * 2025-01-08T15:00Z
    */
   gmtCreated?: number;
   /**
+   * @remarks
+   * The modification time of the metadata information.
+   * 
    * @example
    * 2025-04-02T02:10:59Z
    */
   gmtModified?: number;
   /**
+   * @remarks
+   * The task ID.
+   * 
    * @example
    * ap-northeast-1
    */
   id?: number;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-zhangjiakou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The name of the slink destination database.
+   * 
    * @example
    * e3plus_*****_prod
    */
   slinkDstDb?: string;
   /**
+   * @remarks
+   * The instance ID of the destination.
+   * 
    * @example
    * pxc-hzrehc****5zye
    */
   slinkDstResId?: string;
   /**
+   * @remarks
+   * The username for the data connection of the destination.
+   * 
    * @example
    * dts_temp_2_23
    */
   slinkDstUserName?: string;
   /**
+   * @remarks
+   * The name of the slink source database.
+   * 
    * @example
    * stock
    */
   slinkSrcDb?: string;
   /**
+   * @remarks
+   * The instance ID of the source.
+   * 
    * @example
    * drdshbga*****w4p
    */
   slinkSrcResId?: string;
   /**
+   * @remarks
+   * The resource type of the source.
+   * 
    * @example
    * RDS_MYSQL
    */
   slinkSrcResType?: string;
   /**
+   * @remarks
+   * The username for the data connection of the source.
+   * 
    * @example
    * dtdba
    */
   slinkSrcUserName?: string;
   /**
+   * @remarks
+   * The stage of the synchronization task.
+   * 
    * @example
    * DATA_IMPORT_RUNNING
    */
   slinkStage?: string;
   /**
+   * @remarks
+   * The running status of the synchronization task.
+   * 
    * @example
    * IMPORT_NOT_BEGIN
    */
   slinkStatus?: string;
   /**
+   * @remarks
+   * The description of the slink task.
+   * 
    * @example
    * test
    */
   slinkTaskDesc?: string;
   /**
+   * @remarks
+   * The slink task ID.
+   * 
    * @example
    * etx-szr2rr6i*****
    */
   slinkTaskId?: string;
   /**
+   * @remarks
+   * The synchronization type.
+   * 
    * @example
    * evaluate_import
    */
@@ -156,33 +213,55 @@ export class DescribeEvaluateAndImportTasksResponseBodyData extends $dara.Model
 }
 
 export class DescribeEvaluateAndImportTasksResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The task details.
+   */
   data?: DescribeEvaluateAndImportTasksResponseBodyData[];
   /**
+   * @remarks
+   * The returned message. > This parameter is empty when the request succeeds. When the request fails, exception information (such as error codes) is returned.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The number of entries per page.
+   * 
    * @example
    * 0
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 81519FDE-713B-****-B6F1-231479A4C9DB
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request was successful.
+   * 
    * @example
    * True
    */
   success?: boolean;
   /**
+   * @remarks
+   * The total number of entries.
+   * 
    * @example
    * 0
    */

package/src/models/DescribeEventsRequest.ts

@@ -4,22 +4,33 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeEventsRequest extends $dara.Model {
   /**
+   * @remarks
+   * The end time.
+   * 
    * @example
    * 2021-10-18T03:07:25Z
    */
   endTime?: string;
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page size.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -27,6 +38,9 @@ export class DescribeEventsRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The start time.
+   * 
    * @example
    * 2021-10-18T03:07:25Z
    */

package/src/models/DescribeEventsResponseBody.ts

@@ -4,56 +4,89 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeEventsResponseBodyEventItems extends $dara.Model {
   /**
+   * @remarks
+   * The event ID.
+   * 
    * @example
    * 50421290
    */
   eventId?: number;
   /**
+   * @remarks
+   * The event name.
+   * 
    * @example
    * ModifySecurityIps
    */
   eventName?: string;
   /**
+   * @remarks
+   * The supplementary information.
+   * 
    * @example
    * {\\"Domain\\": \\"rds-cn-hangzhou.aliyuncs.com\\"}
    */
   eventPayload?: string;
   /**
+   * @remarks
+   * The reason.
+   * 
    * @example
    * FROM_USER
    */
   eventReason?: string;
   /**
+   * @remarks
+   * The record time.
+   * 
    * @example
    * 2021-10-15T06:39:49Z
    */
   eventRecordTime?: string;
   /**
+   * @remarks
+   * The event time.
+   * 
    * @example
    * 2021-10-15T06:35:00Z
    */
   eventTime?: string;
   /**
+   * @remarks
+   * The event type.
+   * 
    * @example
    * SecurityManagement
    */
   eventType?: string;
   /**
+   * @remarks
+   * The event user type.
+   * 
    * @example
    * USRE
    */
   eventUserType?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */
   regionId?: string;
   /**
+   * @remarks
+   * The resource name.
+   * 
    * @example
    * px-bp1v8udesc89g156g
    */
   resourceName?: string;
   /**
+   * @remarks
+   * The resource type.
+   * 
    * @example
    * instance
    */
@@ -100,23 +133,39 @@ export class DescribeEventsResponseBodyEventItems extends $dara.Model {
 }
 
 export class DescribeEventsResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The event items.
+   */
   eventItems?: DescribeEventsResponseBodyEventItems[];
   /**
+   * @remarks
+   * The page number.
+   * 
    * @example
    * 1
    */
   pageNumber?: number;
   /**
+   * @remarks
+   * The page size.
+   * 
    * @example
    * 20
    */
   pageSize?: number;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 4748127A-6D50-432C-B635-433467074C27
    */
   requestId?: string;
   /**
+   * @remarks
+   * The total number of pages.
+   * 
    * @example
    * 20
    */

package/src/models/DescribeGdnInstancesRequest.ts

@@ -4,12 +4,20 @@ import * as $dara from '@darabonba/typescript';
 
 export class DescribeGdnInstancesRequest extends $dara.Model {
   /**
+   * @remarks
+   * The message filter type.
+   * 
    * @example
    * gdn_id、
    * polarx_id
    */
   filterType?: string;
   /**
+   * @remarks
+   * The filter value for querying resources.
+   * 
+   * This parameter is used together with FilterKey.
+   * 
    * @example
    * gdn-***、
    * pxc-***
@@ -17,23 +25,32 @@ export class DescribeGdnInstancesRequest extends $dara.Model {
   filterValue?: string;
   /**
    * @remarks
-   * GDN ID。
+   * The GDN ID.
    * 
    * @example
    * gdn-***
    */
   GDNId?: string;
   /**
+   * @remarks
+   * The page number. The value must be a positive integer that does not exceed the maximum value of the Integer data type. Default value: 1.
+   * 
    * @example
    * 50
    */
   pageNum?: string;
   /**
+   * @remarks
+   * The page size.
+   * 
    * @example
    * 30
    */
   pageSize?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */