@alicloud/polardbx20200202 3.4.2 → 3.6.0

package/src/models/AllocateColdDataVolumeRequest.ts

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

package/src/models/AllocateColdDataVolumeResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class AllocateColdDataVolumeResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * D6A4256F-7B83-5BD7-9AC0-72E1FAC05330
    */

package/src/models/AllocateInstancePublicConnectionRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class AllocateInstancePublicConnectionRequest extends $dara.Model {
   /**
    * @remarks
+   * The prefix of the public endpoint.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class AllocateInstancePublicConnectionRequest extends $dara.Model {
   connectionStringPrefix?: string;
   /**
    * @remarks
+   * The instance name.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -28,6 +32,8 @@ export class AllocateInstancePublicConnectionRequest extends $dara.Model {
   ownerId?: number;
   /**
    * @remarks
+   * The port of the public endpoint.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -35,6 +41,9 @@ export class AllocateInstancePublicConnectionRequest extends $dara.Model {
    */
   port?: string;
   /**
+   * @remarks
+   * The region in which the instance resides.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/AllocateInstancePublicConnectionResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class AllocateInstancePublicConnectionResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 9B2F3840-5C98-475C-B269-2D5C3A31797C
    */

package/src/models/AttachColumnarInstanceRequest.ts

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

package/src/models/AttachColumnarInstanceResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class AttachColumnarInstanceResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The name of the created instance.
+   * 
    * @example
    * pxc-xxx
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 9B2F3840-5C98-475C-B269-2D5C3A31797C
    */
   requestId?: string;
   /**
+   * @remarks
+   * The backend task ID.
+   * 
    * @example
    * 422922413
    */

package/src/models/CancelActiveOperationTasksRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CancelActiveOperationTasksRequest extends $dara.Model {
   /**
    * @remarks
+   * The event IDs, separated by commas.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class CancelActiveOperationTasksRequest extends $dara.Model {
   ids?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CancelActiveOperationTasksResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CancelActiveOperationTasksResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The event IDs, separated by commas.
+   * 
    * @example
    * 111,1223
    */
   ids?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * AE4F6C34-065F-45AA-B5DC-4B8D816F6305
    */

package/src/models/ChangeResourceGroupRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class ChangeResourceGroupRequest extends $dara.Model {
   /**
    * @remarks
+   * The ID of the new resource group.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class ChangeResourceGroupRequest extends $dara.Model {
   newResourceGroupId?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -21,6 +25,8 @@ export class ChangeResourceGroupRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The resource ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -29,10 +35,12 @@ export class ChangeResourceGroupRequest extends $dara.Model {
   resourceId?: string;
   /**
    * @remarks
+   * The resource type. Currently, only PolarDB-X 2.0 instances are supported.
+   * 
    * This parameter is required.
    * 
    * @example
-   * PolarDBXInstance
+   * polardbxinstance
    */
   resourceType?: string;
   static names(): { [key: string]: string } {

package/src/models/ChangeResourceGroupResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ChangeResourceGroupResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3WE34
    */

package/src/models/CheckCloudResourceAuthorizedRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CheckCloudResourceAuthorizedRequest extends $dara.Model {
   /**
    * @remarks
+   * The instance ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -13,6 +15,8 @@ export class CheckCloudResourceAuthorizedRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The ID of the region in which the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -20,6 +24,12 @@ export class CheckCloudResourceAuthorizedRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The global resource descriptor ARN (Alibaba Cloud Resource Name) of the authorized role. After the authorization of this role is complete, the related KMS can be used. Format: acs:ram::$accountID:role/$roleName.
+   * 
+   * - $accountID: the Alibaba Cloud account ID. To view the ID, logon to the Alibaba Cloud Management Console, move the mouse over the profile picture in the upper-right corner, and then click Security Settings.
+   * - $roleName: the RAM role name. The value is fixed as AliyunRdsInstanceEncryptionDefaultRole.
+   * 
    * @example
    * acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole
    */

package/src/models/CheckCloudResourceAuthorizedResponseBody.ts

@@ -6,11 +6,21 @@ import * as $dara from '@darabonba/typescript';
  */
 export class CheckCloudResourceAuthorizedResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The authorization status. Valid values:
+   * 
+   * - **0**: not authorized.
+   * - **1**: authorized.
+   * - **2**: KMS is not activated.
+   * 
    * @example
    * 0
    */
   authorizationState?: string;
   /**
+   * @remarks
+   * The global resource descriptor ARN (Alibaba Cloud Resource Name) of the authorized role. After the authorization of this role is complete, the related KMS can be used. Format: acs:ram::$accountID:role/$roleName.
+   * 
    * @example
    * acs:ram::123456789012****:role/AliyunRdsInstanceEncryptionDefaultRole
    */
@@ -39,8 +49,15 @@ export class CheckCloudResourceAuthorizedResponseBodyData extends $dara.Model {
 }
 
 export class CheckCloudResourceAuthorizedResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The response body.
+   */
   data?: CheckCloudResourceAuthorizedResponseBodyData;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * A501A191-BD70-5E50-98A9-C2A486A82****
    */

package/src/models/CheckSqlAuditSlsStatusRequest.ts

@@ -5,6 +5,8 @@ import * as $dara from '@darabonba/typescript';
 export class CheckSqlAuditSlsStatusRequest extends $dara.Model {
   /**
    * @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

package/src/models/CheckSqlAuditSlsStatusResponseBody.ts

@@ -4,11 +4,19 @@ import * as $dara from '@darabonba/typescript';
 
 export class CheckSqlAuditSlsStatusResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 173CA69A-3513-591D-8A09-C1EA37CBE2D9
    */
   requestId?: string;
   /**
+   * @remarks
+   * The enabling status of the SQL audit feature. Valid values:
+   * * enabled: Enabled.
+   * * disabled: Not enabled.
+   * 
    * @example
    * enabled
    */

package/src/models/CloseEngineMigrationRequest.ts

@@ -4,12 +4,24 @@ import * as $dara from '@darabonba/typescript';
 
 export class CloseEngineMigrationRequest extends $dara.Model {
   /**
+   * @remarks
+   * Specifies whether to keep binlog enabled. Valid values:
+   * 
+   * * **true**: Keeps binlog enabled.
+   * * **false**: Disables binlog.
+   * 
+   * Default value: **true**.
+   * 
+   * > Disabling binlog restarts your PolarDB cluster.
+   * 
    * @example
    * true
    */
   continueEnableBinlog?: string;
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -17,6 +29,9 @@ export class CloseEngineMigrationRequest extends $dara.Model {
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The region ID.
+   * 
    * @example
    * cn-hangzhou
    */

package/src/models/CloseEngineMigrationResponseBody.ts

@@ -4,11 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CloseEngineMigrationResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The instance ID.
+   * 
    * @example
    * pxc-hzjasd****
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The backend task ID.
+   * 
    * @example
    * 2209883
    */
@@ -38,17 +44,30 @@ export class CloseEngineMigrationResponseBodyData extends $dara.Model {
 
 export class CloseEngineMigrationResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The response code.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * The new endpoint information.
+   */
   data?: CloseEngineMigrationResponseBodyData;
   /**
+   * @remarks
+   * The HTTP status code.
+   * 
    * @example
    * 200
    */
   httpStatusCode?: string;
   /**
+   * @remarks
+   * The error message. This parameter is empty if the request is successful.
+   * 
    * @example
    * *****
    */
@@ -62,6 +81,9 @@ export class CloseEngineMigrationResponseBody extends $dara.Model {
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/ConfirmNoConnectionRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfirmNoConnectionRequest extends $dara.Model {
   /**
+   * @remarks
+   * The instance name.
+   * 
    * @example
    * pxc-hzravgpt8q****
    */
   DBInstanceName?: string;
   /**
    * @remarks
+   * The region ID.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +23,8 @@ export class ConfirmNoConnectionRequest extends $dara.Model {
   regionId?: string;
   /**
    * @remarks
+   * The unique ID of the short-link task that identifies the task to be rolled back.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/ConfirmNoConnectionResponseBody.ts

@@ -4,6 +4,9 @@ import * as $dara from '@darabonba/typescript';
 
 export class ConfirmNoConnectionResponseBodyData extends $dara.Model {
   /**
+   * @remarks
+   * The original task ID, used to match the response with the request.
+   * 
    * @example
    * etx-szr2rr6i*****
    */
@@ -30,18 +33,31 @@ export class ConfirmNoConnectionResponseBodyData extends $dara.Model {
 }
 
 export class ConfirmNoConnectionResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: ConfirmNoConnectionResponseBodyData;
   /**
+   * @remarks
+   * The additional information returned. The value success is returned if the request is successful. Otherwise, an error code is returned.
+   * 
    * @example
    * Success
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 6BA32080EEA
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/CreateAccountRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAccountRequest extends $dara.Model {
   /**
+   * @remarks
+   * The description of the account.
+   * 
    * @example
    * test
    */
   accountDescription?: string;
   /**
    * @remarks
+   * The name of the account to be created.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +23,8 @@ export class CreateAccountRequest extends $dara.Model {
   accountName?: string;
   /**
    * @remarks
+   * The password of the account to be created.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -25,12 +32,22 @@ export class CreateAccountRequest extends $dara.Model {
    */
   accountPassword?: string;
   /**
+   * @remarks
+   * The permissions to be granted to the new account on the specified database. Valid values:
+   * 
+   * - ReadWrite
+   * - ReadOnly
+   * - DMLOnly
+   * - DDLOnly.
+   * 
    * @example
    * ReadWrite
    */
   accountPrivilege?: string;
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -38,12 +55,17 @@ export class CreateAccountRequest extends $dara.Model {
    */
   DBInstanceName?: string;
   /**
+   * @remarks
+   * The name of the database to be authorized.
+   * 
    * @example
    * testdb
    */
   DBName?: string;
   /**
    * @remarks
+   * The region in which the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -51,11 +73,21 @@ export class CreateAccountRequest extends $dara.Model {
    */
   regionId?: string;
   /**
+   * @remarks
+   * The name of the security administrator account.
+   * 
+   * > If three-role mode is enabled, this parameter is required. If three-role mode is not enabled, this parameter is not required.
+   * 
    * @example
    * securityAccount
    */
   securityAccountName?: string;
   /**
+   * @remarks
+   * The password of the security administrator account.
+   * 
+   * > If three-role mode is enabled, this parameter is required. If three-role mode is not enabled, this parameter is not required.
+   * 
    * @example
    * securityPassword
    */

package/src/models/CreateAccountResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateAccountResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * The error message. This parameter is empty if the request is successful.
+   * 
    * @example
    * ****
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 9B2F3840-5C98-475C-B269-2D5C3A31797C
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */

package/src/models/CreateBackupRequest.ts

@@ -4,12 +4,17 @@ import * as $dara from '@darabonba/typescript';
 
 export class CreateBackupRequest extends $dara.Model {
   /**
+   * @remarks
+   * The backup type. Currently, only "0" is supported, which indicates fast backup.
+   * 
    * @example
    * 0
    */
   backupType?: string;
   /**
    * @remarks
+   * The name of the instance.
+   * 
    * This parameter is required.
    * 
    * @example
@@ -18,6 +23,8 @@ export class CreateBackupRequest extends $dara.Model {
   DBInstanceName?: string;
   /**
    * @remarks
+   * The region where the instance resides.
+   * 
    * This parameter is required.
    * 
    * @example

package/src/models/CreateBackupResponseBody.ts

@@ -26,18 +26,31 @@ export class CreateBackupResponseBodyData extends $dara.Model {
 }
 
 export class CreateBackupResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The returned data.
+   */
   data?: CreateBackupResponseBodyData;
   /**
+   * @remarks
+   * Empty if the request is successful. An error message is returned if the request fails.
+   * 
    * @example
    * *****
    */
   message?: string;
   /**
+   * @remarks
+   * The request ID.
+   * 
    * @example
    * 9B2F3840-5C98-475C-B269-2D5C3A31797C
    */
   requestId?: string;
   /**
+   * @remarks
+   * Indicates whether the request is successful.
+   * 
    * @example
    * true
    */