@alicloud/dds20151201 8.0.0 → 8.1.0

package/src/models/DescribeDbinstanceSwitchLogResponseBody.ts

@@ -0,0 +1,151 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDBInstanceSwitchLogResponseBodyLogItems extends $dara.Model {
+  /**
+   * @remarks
+   * The ID of the replica set instance or the ID of the node on which a primary/secondary switchover is performed.
+   * 
+   * @example
+   * dds-uf68f1b5a57exxxx
+   */
+  nodeId?: string;
+  /**
+   * @remarks
+   * The code that indicates the reason of a primary/secondary switchover. Valid values:
+   * 
+   * *   USER_CONSOLE_OPERATION: The switchover is manually performed.
+   * *   OPERATION_AND_MAINTENANCE: Potential risks exist.
+   * *   MACHINE_DOWNTIME: The host is offline.
+   * *   PRIMARY_UNHEALTHY: An exception occurs on the primary node of the instance.
+   * *   SECONDARY_UNHEALTHY: An exception occurs on the secondary node of the instance.
+   * *   MULTIPLE_NODE_FAILURES: An exception occurs on multiple nodes of the instance.
+   * 
+   * @example
+   * USER_CONSOLE_OPERATION
+   */
+  switchCode?: string;
+  /**
+   * @remarks
+   * The switchover status. Valid values: **1** and **0**. The value 1 indicates a successful primary/secondary switchover and the value 0 indicates a failed primary/secondary switchover.
+   * 
+   * @example
+   * 1
+   */
+  switchStatus?: string;
+  /**
+   * @remarks
+   * The point in time when a primary/secondary switchover was performed. The time follows the ISO 8601 standard in the *yyyy-mm-dd*T*hh:mm:ss*Z format. The time is displayed in UTC.
+   * 
+   * @example
+   * 2023-02-07T18:00:00Z
+   */
+  switchTime?: string;
+  static names(): { [key: string]: string } {
+    return {
+      nodeId: 'NodeId',
+      switchCode: 'SwitchCode',
+      switchStatus: 'SwitchStatus',
+      switchTime: 'SwitchTime',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      nodeId: 'string',
+      switchCode: 'string',
+      switchStatus: 'string',
+      switchTime: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class DescribeDBInstanceSwitchLogResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * @example
+   * dds-uf68f1b5a57exxxx
+   */
+  DBInstanceId?: string;
+  /**
+   * @remarks
+   * The primary/secondary switchover logs.
+   */
+  logItems?: DescribeDBInstanceSwitchLogResponseBodyLogItems[];
+  /**
+   * @remarks
+   * The page number returned.
+   * 
+   * @example
+   * 1
+   */
+  pageNumber?: number;
+  /**
+   * @remarks
+   * The number of entries returned on each page.
+   * 
+   * @example
+   * 30
+   */
+  pageSize?: number;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * ECBCA991-XXXX-XXXX-834C-B3E8007F33AA
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The number of primary/secondary switching entries.
+   * 
+   * @example
+   * 1
+   */
+  totalCount?: number;
+  static names(): { [key: string]: string } {
+    return {
+      DBInstanceId: 'DBInstanceId',
+      logItems: 'LogItems',
+      pageNumber: 'PageNumber',
+      pageSize: 'PageSize',
+      requestId: 'RequestId',
+      totalCount: 'TotalCount',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBInstanceId: 'string',
+      logItems: { 'type': 'array', 'itemType': DescribeDBInstanceSwitchLogResponseBodyLogItems },
+      pageNumber: 'number',
+      pageSize: 'number',
+      requestId: 'string',
+      totalCount: 'number',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.logItems)) {
+      $dara.Model.validateArray(this.logItems);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDbinstanceTdeinfoRequest.ts

@@ -0,0 +1,48 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDBInstanceTDEInfoRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The instance ID.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * dds-bpxxxxxxxx
+   */
+  DBInstanceId?: string;
+  ownerAccount?: string;
+  ownerId?: number;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  static names(): { [key: string]: string } {
+    return {
+      DBInstanceId: 'DBInstanceId',
+      ownerAccount: 'OwnerAccount',
+      ownerId: 'OwnerId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      DBInstanceId: 'string',
+      ownerAccount: 'string',
+      ownerId: 'number',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDbinstanceTdeinfoResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeDBInstanceTDEInfoResponseBody } from "./DescribeDbinstanceTdeinfoResponseBody";
+
+
+export class DescribeDBInstanceTDEInfoResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeDBInstanceTDEInfoResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeDBInstanceTDEInfoResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDbinstanceTdeinfoResponseBody.ts

@@ -0,0 +1,88 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDBInstanceTDEInfoResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * 实例的自定义密钥。
+   * 
+   * 目前仅以下地域支持BYOK（Bring Your Own Key，用户可以自行管理和拥有加密密钥）：
+   * - 华东1（杭州）
+   * - 华东2（上海）
+   * - 华北2（北京）
+   * - 华南1（深圳）
+   * - 中国（香港）
+   * - 新加坡
+   * - 马来西亚（吉隆坡）
+   * 
+   * > 支持BYOK，用户可以管理且拥有密钥，系统将返回用户的自定义密钥；不支持BYOK，用户不可管理密钥，系统将返回字符串`NoActiveBYOK`。
+   * 
+   * @example
+   * 2axxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+   */
+  encryptionKey?: string;
+  /**
+   * @remarks
+   * 加密算法。
+   * 
+   * @example
+   * aes-256-cbc
+   */
+  encryptorName?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * F4DD0E29-361B-42F2-9301-B0048CCCE5D6
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * 指定待授权角色的全局资源描述符ARN（Alibaba Cloud Resource Name）信息。
+   * 
+   * @example
+   * acs:ram::123456789012****:role/aliyunrdsinstanceencryptiondefaultrole
+   */
+  roleARN?: string;
+  /**
+   * @remarks
+   * The TDE status. Valid values:
+   * 
+   * *   **enabled**
+   * *   **disabled**
+   * 
+   * @example
+   * enabled
+   */
+  TDEStatus?: string;
+  static names(): { [key: string]: string } {
+    return {
+      encryptionKey: 'EncryptionKey',
+      encryptorName: 'EncryptorName',
+      requestId: 'RequestId',
+      roleARN: 'RoleARN',
+      TDEStatus: 'TDEStatus',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      encryptionKey: 'string',
+      encryptorName: 'string',
+      requestId: 'string',
+      roleARN: 'string',
+      TDEStatus: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDbinstancesOverviewRequest.ts

@@ -0,0 +1,193 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class DescribeDBInstancesOverviewRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The billing method of the instance. Valid values:
+   * 
+   * *   **PrePaid**: subscription
+   * *   **PostPaid**: pay-as-you-go
+   * 
+   * @example
+   * PostPaid
+   */
+  chargeType?: string;
+  /**
+   * @remarks
+   * The database engine version of the instance. Valid values: **5.0**, **4.4**, **4.2**, **4.0**, and **3.4**.
+   * 
+   * @example
+   * 4.0
+   */
+  engineVersion?: string;
+  /**
+   * @remarks
+   * The instance type. The instance type varies based on the instance architecture. For more information about instance types supported by different instance architectures, see the following references:
+   * 
+   * *   [Standalone instance types](https://help.aliyun.com/document_detail/311407.html)
+   * *   [Replica set instance types](https://help.aliyun.com/document_detail/311410.html)
+   * *   [Sharded cluster instance types](https://help.aliyun.com/document_detail/311414.html)
+   * 
+   * @example
+   * dds.mongo.2xlarge
+   */
+  instanceClass?: string;
+  /**
+   * @remarks
+   * The ID of the instance for which you want to query the overview information.
+   * 
+   * > 
+   * 
+   * *   If you do not specify this parameter, the overview information of all instances within this account is queried.
+   * 
+   * *   Separate the instance IDs with commas (,).
+   * 
+   * @example
+   * dds-bp12c5b040dc****
+   */
+  instanceIds?: string;
+  /**
+   * @remarks
+   * The state of the instance. For more information about valid values, see [Instance states](https://help.aliyun.com/document_detail/63870.html).
+   * 
+   * @example
+   * Running
+   */
+  instanceStatus?: string;
+  /**
+   * @remarks
+   * The architecture of the instance. Valid values:
+   * 
+   * *   **sharding**: sharded cluster instance
+   * *   **replicate**: replica set or standalone instance
+   * 
+   * > 
+   * 
+   * *   To query the overview information of a sharded cluster instance, you must set the parameter to **sharding**.
+   * 
+   * *   If you do not specify this parameter, the overview information of all instances within this account is queried.
+   * 
+   * @example
+   * replicate
+   */
+  instanceType?: string;
+  /**
+   * @remarks
+   * The network type of the instance. Valid values:
+   * 
+   * *   **Classic**: classic network
+   * *   **VPC**: Virtual Private Cloud (VPC)
+   * 
+   * @example
+   * Classic
+   */
+  networkType?: string;
+  ownerAccount?: string;
+  ownerId?: number;
+  /**
+   * @remarks
+   * The region ID of the instance. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the most recent region list.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * cn-hangzhou
+   */
+  regionId?: string;
+  /**
+   * @remarks
+   * The ID of the resource group to which the instance belongs. For more information, see [View the basic information of a resource group](https://help.aliyun.com/document_detail/151181.html).
+   * 
+   * @example
+   * rg-acfmyiu4ekp****
+   */
+  resourceGroupId?: string;
+  resourceOwnerAccount?: string;
+  resourceOwnerId?: number;
+  /**
+   * @remarks
+   * Specifies whether to display instance tags. Default value: False.
+   * 
+   * @example
+   * false
+   */
+  showTags?: boolean;
+  /**
+   * @remarks
+   * The ID of the vSwitch to which the instance is connected.
+   * 
+   * @example
+   * vsw-bp1e7clcw529l773d****
+   */
+  vSwitchId?: string;
+  /**
+   * @remarks
+   * The ID of the VPC in which the instance is deployed.
+   * 
+   * @example
+   * vpc-bp1nme44gek34slfc****
+   */
+  vpcId?: string;
+  /**
+   * @remarks
+   * The zone ID of the instance.
+   * 
+   * @example
+   * cn-hangzhou-b
+   */
+  zoneId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      chargeType: 'ChargeType',
+      engineVersion: 'EngineVersion',
+      instanceClass: 'InstanceClass',
+      instanceIds: 'InstanceIds',
+      instanceStatus: 'InstanceStatus',
+      instanceType: 'InstanceType',
+      networkType: 'NetworkType',
+      ownerAccount: 'OwnerAccount',
+      ownerId: 'OwnerId',
+      regionId: 'RegionId',
+      resourceGroupId: 'ResourceGroupId',
+      resourceOwnerAccount: 'ResourceOwnerAccount',
+      resourceOwnerId: 'ResourceOwnerId',
+      showTags: 'ShowTags',
+      vSwitchId: 'VSwitchId',
+      vpcId: 'VpcId',
+      zoneId: 'ZoneId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      chargeType: 'string',
+      engineVersion: 'string',
+      instanceClass: 'string',
+      instanceIds: 'string',
+      instanceStatus: 'string',
+      instanceType: 'string',
+      networkType: 'string',
+      ownerAccount: 'string',
+      ownerId: 'number',
+      regionId: 'string',
+      resourceGroupId: 'string',
+      resourceOwnerAccount: 'string',
+      resourceOwnerId: 'number',
+      showTags: 'boolean',
+      vSwitchId: 'string',
+      vpcId: 'string',
+      zoneId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/DescribeDbinstancesOverviewResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { DescribeDBInstancesOverviewResponseBody } from "./DescribeDbinstancesOverviewResponseBody";
+
+
+export class DescribeDBInstancesOverviewResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: DescribeDBInstancesOverviewResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: DescribeDBInstancesOverviewResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+