@alicloud/dds20151201 8.3.0 → 8.4.1

package/dist/models/DescribeDbinstancesRequest.d.ts

@@ -2,11 +2,13 @@ import * as $dara from '@darabonba/typescript';
 export declare class DescribeDBInstancesRequestTag extends $dara.Model {
     /**
      * @remarks
-     * The tag key of the instance. Valid values of N: **1** to **20**.
+     * The key of tag N. The value of N must be in the range of **1** to **20**.
      *
-     * *   The key cannot start with `aliyun`, `acs:`, `http://`, or `https://`.
-     * *   It can be up to 64 characters in length.
-     * *   It cannot be an empty string.
+     * - The tag key cannot start with `aliyun`, `acs:`, `http://`, or `https://`.
+     *
+     * - The tag key can be up to 64 characters in length.
+     *
+     * - The tag key cannot be an empty string.
      *
      * @example
      * testdatabase
@@ -14,11 +16,13 @@ export declare class DescribeDBInstancesRequestTag extends $dara.Model {
     key?: string;
     /**
      * @remarks
-     * The tag value of the instance. Valid values of N: **1** to **20**.
+     * The value of tag N. The value of N must be in the range of **1** to **20**.
+     *
+     * - The tag value cannot start with `aliyun`, `acs`:, `http://`, or `https://`.
      *
-     * *   The value cannot start with `aliyun`, `acs:`, `http://`, or `https://`.
-     * *   The value can be up to 128 characters in length.
-     * *   It can be an empty string.
+     * - The tag value can be up to 128 characters in length.
+     *
+     * - The tag value can be an empty string.
      *
      * @example
      * apitest
@@ -40,8 +44,9 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
      * @remarks
      * The billing method of the instance. Valid values:
      *
-     * *   **PrePaid**: subscription
-     * *   **PostPaid**: pay-as-you-go
+     * - **PrePaid**: subscription.
+     *
+     * - **PostPaid**: pay-as-you-go.
      *
      * @example
      * PrePaid
@@ -49,7 +54,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     chargeType?: string;
     /**
      * @remarks
-     * The endpoint of the node. You can call the [DescribeDBInstanceAttribute](https://help.aliyun.com/document_detail/62010.html) operation to query the endpoint of the node.
+     * The endpoint of the node. You can call the [DescribeDBInstanceAttribute](https://help.aliyun.com/document_detail/62010.html) operation to query the endpoint.
      *
      * @example
      * dds-bp1ea17b41abecf43****.mongodb.rds.aliyuncs.com
@@ -57,7 +62,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     connectionDomain?: string;
     /**
      * @remarks
-     * The instance type. For more information about valid values, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
+     * The instance type. For more information, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
      *
      * @example
      * dds.mongo.mid
@@ -65,11 +70,13 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     DBInstanceClass?: string;
     /**
      * @remarks
-     * The name of the instance. The name must meet the following requirements:
+     * The instance name. The name must meet the following requirements:
+     *
+     * - It must start with a Chinese character or a letter.
      *
-     * *   The name must start with a letter.
-     * *   It can contain digits, letters, underscores (_), and hyphens (-).
-     * *   It must be 2 to 256 characters in length.
+     * - It can contain digits, Chinese characters, letters, underscores (_), and hyphens (-).
+     *
+     * - It must be 2 to 256 characters in length.
      *
      * @example
      * Test database
@@ -85,7 +92,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     DBInstanceId?: string;
     /**
      * @remarks
-     * The state of the instance. For more information about valid values, see [Instance states](https://help.aliyun.com/document_detail/63870.html).
+     * The instance status. For more information, see [Instance states](https://help.aliyun.com/document_detail/63870.html).
      *
      * @example
      * Running
@@ -93,10 +100,15 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     DBInstanceStatus?: string;
     /**
      * @remarks
-     * The architecture of the instance. Valid values:
+     * The instance architecture. Valid values:
+     *
+     * - **sharding**: sharded cluster instance.
+     *
+     * - **replicate**: replica set or standalone instance. This is the default value.
      *
-     * *   **sharding**: sharded cluster instance
-     * *   **replicate**: replica set or standalone instance
+     * <props="china">
+     *
+     * - **serverless**: serverless instance.
      *
      * @example
      * sharding
@@ -104,11 +116,13 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     DBInstanceType?: string;
     /**
      * @remarks
-     * The type of the node in the instance. This parameter is used to filter standard or test instance.
+     * Filters instances by type. Valid values:
+     *
+     * 1. customized: standalone instances and DBFS instances.
+     *
+     * 2. standard: standard instances, which include replica set and sharded cluster instances.
      *
-     * 1.  Valid value for a standalone or DBFS instance.
-     * 2.  Valid value for a standard instance that comes in the replica set or sharded cluster architecture: standard
-     * 3.  Valid value when all instances are displayed: default
+     * 3. default: all instances.
      *
      * @example
      * default
@@ -116,7 +130,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     DBNodeType?: string;
     /**
      * @remarks
-     * The database engine of the instance. Set the value to **MongoDB**.
+     * The database engine. Set the value to **MongoDB**.
      *
      * @example
      * MongoDB
@@ -124,14 +138,21 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     engine?: string;
     /**
      * @remarks
-     * The database engine version of the instance.
+     * The database engine version. Valid values:
      *
-     * *   **6.0**
-     * *   **5.0**
-     * *   **4.4**
-     * *   **4.2**
-     * *   **4.0**
-     * *   **3.4**
+     * - **7.0**
+     *
+     * - **6.0**
+     *
+     * - **5.0**
+     *
+     * - **4.4**
+     *
+     * - **4.2**
+     *
+     * - **4.0**
+     *
+     * - **3.4**
      *
      * @example
      * 4.0
@@ -139,18 +160,19 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     engineVersion?: string;
     /**
      * @remarks
-     * The time when the instance expires.
+     * The expiration time of the instance. The time is in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. This parameter is used to filter instances that expire on or before the specified time.
      *
      * @example
-     * 2019-12-26T16:00Z
+     * 2019-12-26T16:00:00Z
      */
     expireTime?: string;
     /**
      * @remarks
-     * Specifies whether the instance has expired. Valid values:
+     * The expiration status of the instance. Valid values:
      *
-     * *   **true**
-     * *   **false**
+     * - **true**: The instance is expired.
+     *
+     * - **false**: The instance is not expired.
      *
      * @example
      * true
@@ -160,8 +182,9 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
      * @remarks
      * The network type of the instance. Valid values:
      *
-     * *   **Classic**
-     * *   **VPC**
+     * - **Classic**: classic network.
+     *
+     * - **VPC**: virtual private cloud (VPC).
      *
      * @example
      * VPC
@@ -171,7 +194,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     ownerId?: number;
     /**
      * @remarks
-     * The number of the page to return. The value of this parameter must be an integer that is greater than 0. Default value: **1**.
+     * The page number. The value must be greater than 0 and no greater than the maximum value of the integer data type. Default value: **1**.
      *
      * @example
      * 1
@@ -181,9 +204,11 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
      * @remarks
      * The number of entries to return on each page. Valid values:
      *
-     * *   **30** (default)
-     * *   **50**
-     * *   **100**
+     * - **30** (default)
+     *
+     * - **50**
+     *
+     * - **100**
      *
      * @example
      * 30
@@ -191,7 +216,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     pageSize?: 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.
+     * The region ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the region ID.
      *
      * @example
      * cn-hangzhou
@@ -201,9 +226,11 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
      * @remarks
      * The number of nodes in the replica set instance. Valid values:
      *
-     * *   **3**
-     * *   **5**
-     * *   **7**
+     * - **3**
+     *
+     * - **5**
+     *
+     * - **7**
      *
      * @example
      * 3
@@ -211,7 +238,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     replicationFactor?: string;
     /**
      * @remarks
-     * The ID of the resource group.
+     * The resource group ID.
      *
      * @example
      * rg-acfmyiu4ekp****
@@ -226,7 +253,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     tag?: DescribeDBInstancesRequestTag[];
     /**
      * @remarks
-     * The vSwitch ID of the instance.
+     * The vSwitch ID of the VPC.
      *
      * @example
      * vsw-bp1vj604nj5a9zz74****
@@ -234,7 +261,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     vSwitchId?: string;
     /**
      * @remarks
-     * The VPC ID of the instance.
+     * The VPC ID.
      *
      * @example
      * vpc-bp1n3i15v90el48nx****
@@ -242,7 +269,7 @@ export declare class DescribeDBInstancesRequest extends $dara.Model {
     vpcId?: string;
     /**
      * @remarks
-     * The zone ID of the instance. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the most recent zone list.
+     * The zone ID. You can call the [DescribeRegions](https://help.aliyun.com/document_detail/61933.html) operation to query the zone ID.
      *
      * @example
      * cn-hangzhou-b

package/dist/models/DescribeDbinstancesRequest.js.map

@@ -1 +1 @@
-{"version":3,"file":"DescribeDbinstancesRequest.js","sourceRoot":"","sources":["../../src/models/DescribeDbinstancesRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,6BAA8B,SAAQ,KAAK,CAAC,KAAK;IAyB5D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,GAAG,EAAE,KAAK;YACV,KAAK,EAAE,OAAO;SACf,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,GAAG,EAAE,QAAQ;YACb,KAAK,EAAE,QAAQ;SAChB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA9CD,sEA8CC;AAED,MAAa,0BAA2B,SAAQ,KAAK,CAAC,KAAK;IAqNzD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,YAAY;YACxB,gBAAgB,EAAE,kBAAkB;YACpC,eAAe,EAAE,iBAAiB;YAClC,qBAAqB,EAAE,uBAAuB;YAC9C,YAAY,EAAE,cAAc;YAC5B,gBAAgB,EAAE,kBAAkB;YACpC,cAAc,EAAE,gBAAgB;YAChC,UAAU,EAAE,YAAY;YACxB,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,eAAe;YAC9B,UAAU,EAAE,YAAY;YACxB,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,aAAa;YAC1B,YAAY,EAAE,cAAc;YAC5B,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,QAAQ,EAAE,UAAU;YACpB,iBAAiB,EAAE,mBAAmB;YACtC,eAAe,EAAE,iBAAiB;YAClC,oBAAoB,EAAE,sBAAsB;YAC5C,eAAe,EAAE,iBAAiB;YAClC,GAAG,EAAE,KAAK;YACV,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,QAAQ;YACpB,gBAAgB,EAAE,QAAQ;YAC1B,eAAe,EAAE,QAAQ;YACzB,qBAAqB,EAAE,QAAQ;YAC/B,YAAY,EAAE,QAAQ;YACtB,gBAAgB,EAAE,QAAQ;YAC1B,cAAc,EAAE,QAAQ;YACxB,UAAU,EAAE,QAAQ;YACpB,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,QAAQ;YACvB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,QAAQ;YACjB,WAAW,EAAE,QAAQ;YACrB,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,QAAQ;YAClB,iBAAiB,EAAE,QAAQ;YAC3B,eAAe,EAAE,QAAQ;YACzB,oBAAoB,EAAE,QAAQ;YAC9B,eAAe,EAAE,QAAQ;YACzB,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,6BAA6B,EAAE;YACnE,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AA7RD,gEA6RC"}
+{"version":3,"file":"DescribeDbinstancesRequest.js","sourceRoot":"","sources":["../../src/models/DescribeDbinstancesRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA6C;AAC7C,6DAA+C;AAG/C,MAAa,6BAA8B,SAAQ,KAAK,CAAC,KAAK;IA6B5D,MAAM,CAAC,KAAK;QACV,OAAO;YACL,GAAG,EAAE,KAAK;YACV,KAAK,EAAE,OAAO;SACf,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,GAAG,EAAE,QAAQ;YACb,KAAK,EAAE,QAAQ;SAChB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AAlDD,sEAkDC;AAED,MAAa,0BAA2B,SAAQ,KAAK,CAAC,KAAK;IA4OzD,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,YAAY;YACxB,gBAAgB,EAAE,kBAAkB;YACpC,eAAe,EAAE,iBAAiB;YAClC,qBAAqB,EAAE,uBAAuB;YAC9C,YAAY,EAAE,cAAc;YAC5B,gBAAgB,EAAE,kBAAkB;YACpC,cAAc,EAAE,gBAAgB;YAChC,UAAU,EAAE,YAAY;YACxB,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,eAAe;YAC9B,UAAU,EAAE,YAAY;YACxB,OAAO,EAAE,SAAS;YAClB,WAAW,EAAE,aAAa;YAC1B,YAAY,EAAE,cAAc;YAC5B,OAAO,EAAE,SAAS;YAClB,UAAU,EAAE,YAAY;YACxB,QAAQ,EAAE,UAAU;YACpB,QAAQ,EAAE,UAAU;YACpB,iBAAiB,EAAE,mBAAmB;YACtC,eAAe,EAAE,iBAAiB;YAClC,oBAAoB,EAAE,sBAAsB;YAC5C,eAAe,EAAE,iBAAiB;YAClC,GAAG,EAAE,KAAK;YACV,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAK;QACV,OAAO;YACL,UAAU,EAAE,QAAQ;YACpB,gBAAgB,EAAE,QAAQ;YAC1B,eAAe,EAAE,QAAQ;YACzB,qBAAqB,EAAE,QAAQ;YAC/B,YAAY,EAAE,QAAQ;YACtB,gBAAgB,EAAE,QAAQ;YAC1B,cAAc,EAAE,QAAQ;YACxB,UAAU,EAAE,QAAQ;YACpB,MAAM,EAAE,QAAQ;YAChB,aAAa,EAAE,QAAQ;YACvB,UAAU,EAAE,QAAQ;YACpB,OAAO,EAAE,QAAQ;YACjB,WAAW,EAAE,QAAQ;YACrB,YAAY,EAAE,QAAQ;YACtB,OAAO,EAAE,QAAQ;YACjB,UAAU,EAAE,QAAQ;YACpB,QAAQ,EAAE,QAAQ;YAClB,QAAQ,EAAE,QAAQ;YAClB,iBAAiB,EAAE,QAAQ;YAC3B,eAAe,EAAE,QAAQ;YACzB,oBAAoB,EAAE,QAAQ;YAC9B,eAAe,EAAE,QAAQ;YACzB,GAAG,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,6BAA6B,EAAE;YACnE,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,IAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,KAAK,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;QACD,KAAK,CAAC,QAAQ,EAAE,CAAC;IACnB,CAAC;IAED,YAAY,GAA4B;QACtC,KAAK,CAAC,GAAG,CAAC,CAAC;IACb,CAAC;CACF;AApTD,gEAoTC"}