@alicloud/dds20151201 7.1.0 → 7.1.1

package/dist/client.d.ts

@@ -7654,6 +7654,12 @@ export declare class DescribeReplicaSetRoleResponse extends $tea.Model {
 export declare class DescribeRestoreDBInstanceListRequest extends $tea.Model {
     /**
      * @remarks
+     * Find instances created after the specified time, formatted as <i>yyyy-MM-dd</i>T<i>HH:00:00</i>Z (UTC time).
+     *
+     * >
+     * > - The time must be on the hour.
+     * > - The time cannot be earlier than 7 days before the current time.
+     *
      * This parameter is required.
      *
      * @example
@@ -7662,6 +7668,8 @@ export declare class DescribeRestoreDBInstanceListRequest extends $tea.Model {
     creationTimeAfter?: string;
     /**
      * @remarks
+     * The instance ID.
+     *
      * This parameter is required.
      *
      * @example
@@ -7671,11 +7679,17 @@ export declare class DescribeRestoreDBInstanceListRequest extends $tea.Model {
     ownerAccount?: string;
     ownerId?: number;
     /**
+     * @remarks
+     * The page number.
+     *
      * @example
      * 1
      */
     pageNumber?: number;
     /**
+     * @remarks
+     * The number of entries returned per page.
+     *
      * @example
      * 30
      */
@@ -7693,23 +7707,39 @@ export declare class DescribeRestoreDBInstanceListRequest extends $tea.Model {
     });
 }
 export declare class DescribeRestoreDBInstanceListResponseBody extends $tea.Model {
+    /**
+     * @remarks
+     * DB instances list.
+     */
     DBInstances?: DescribeRestoreDBInstanceListResponseBodyDBInstances;
     /**
+     * @remarks
+     * The page number.
+     *
      * @example
      * 1
      */
     pageNumber?: number;
     /**
+     * @remarks
+     * The number of entries returned per page.
+     *
      * @example
      * 30
      */
     pageSize?: number;
     /**
+     * @remarks
+     * The request ID.
+     *
      * @example
      * 1AF0AD89-ED4F-44AD-B65F-BFC1D5Cxxxxx
      */
     requestId?: string;
     /**
+     * @remarks
+     * The number of instances in the query results.
+     *
      * @example
      * 5
      */
@@ -8208,7 +8238,7 @@ export declare class DescribeShardingNetworkAddressResponseBody extends $tea.Mod
     compatibleConnections?: DescribeShardingNetworkAddressResponseBodyCompatibleConnections;
     /**
      * @remarks
-     * The endpoints of ApsaraDB for MongoDB instances.
+     * The endpoints of the ApsaraDB for MongoDB sharded cluster instance.
      */
     networkAddresses?: DescribeShardingNetworkAddressResponseBodyNetworkAddresses;
     /**
@@ -19892,57 +19922,116 @@ export declare class DescribeReplicaSetRoleResponseBodyReplicaSets extends $tea.
 }
 export declare class DescribeRestoreDBInstanceListResponseBodyDBInstancesDBInstance extends $tea.Model {
     /**
+     * @remarks
+     * The time of instance creation, formatted as <i>yyyy-MM-dd</i>T<i>HH:00:00</i>Z (UTC time).
+     *
      * @example
      * 2022-01-02T07:43:59Z
      */
     creationTime?: string;
+    /**
+     * @remarks
+     * The description of the instance.
+     *
+     * @example
+     * test-database
+     */
     DBInstanceDescription?: string;
     /**
+     * @remarks
+     * The instance ID.
+     *
      * @example
      * dds-bp12c5b040dc****
      */
     DBInstanceId?: string;
     /**
+     * @remarks
+     * The status of the instance. For more information, see [Instance states](https://help.aliyun.com/document_detail/63870.html).
+     *
      * @example
      * Running
      */
     DBInstanceStatus?: string;
     /**
+     * @remarks
+     * The architecture of the instance. Valid values:
+     *
+     * *   **sharding**: sharded cluster instance
+     * *   **replicate**: replica set or standalone instance
+     *
      * @example
      * replicate
      */
     DBInstanceType?: string;
     /**
+     * @remarks
+     * The database engine version of the instance. Valid values:
+     *
+     * *   **7.0**
+     * *   **6.0**
+     * *   **5.0**
+     * *   **4.4**
+     * *   **4.2**
+     * *   **4.0**
+     * *   **3.4**
+     *
      * @example
      * 4.2
      */
     engineVersion?: string;
     /**
+     * @remarks
+     * The secondary availability zone 2 for the instance when implementing multi-AZ deployment.
+     *
      * @example
      * cn-hangzhou-h
      */
     hiddenZoneId?: string;
     /**
+     * @remarks
+     * Specifies whether the instance is deleted. Valid values:
+     *
+     * *   **0**: not deleted
+     * *   **1**: deleted
+     *
      * @example
      * 0
      */
     isDeleted?: number;
     /**
+     * @remarks
+     * The locked state of the instance, value description:
+     * - Unlock: Normal.
+     * - ManualLock: Manually triggered lock.
+     * - LockByExpiration: Automatically locked due to expiration.
+     * - LockByRestoration: Automatically locked before restoration.
+     * - LockByDiskQuota: Automatically locked due to disk quota exceeded.
+     *
      * @example
      * Unlock
      */
     lockMode?: string;
     /**
+     * @remarks
+     * The region ID of the instance.
+     *
      * @example
      * cn-hangzhou
      */
     regionId?: string;
     /**
+     * @remarks
+     * The secondary availability zone 1 for the instance when implementing multi-AZ deployment.
+     *
      * @example
      * cn-hangzhou-i
      */
     secondaryZoneId?: string;
     /**
+     * @remarks
+     * The zone ID of the instance.
+     *
      * @example
      * cn-hangzhou-g
      */
@@ -20283,6 +20372,16 @@ export declare class DescribeShardingNetworkAddressResponseBodyCompatibleConnect
     });
 }
 export declare class DescribeShardingNetworkAddressResponseBodyNetworkAddressesNetworkAddress extends $tea.Model {
+    /**
+     * @remarks
+     * The public endpoint type. Valid values:
+     *
+     * *   **SRV**
+     * *   **Normal**
+     *
+     * @example
+     * SRV
+     */
     connectionType?: string;
     /**
      * @remarks
@@ -20359,6 +20458,13 @@ export declare class DescribeShardingNetworkAddressResponseBodyNetworkAddressesN
      * Primary
      */
     role?: string;
+    /**
+     * @remarks
+     * Txt record which can be used to store MongoDB-related meta data, such as version, configuration parameters and etc. With the combination of txt record and other technology, for example SRV record, the MongoDB client can complete the complex service discovery and configuration passing.
+     *
+     * @example
+     * mongo.example.com. IN TXT "config=replicaSet=myReplicaSet"
+     */
     txtRecord?: string;
     /**
      * @remarks
@@ -21856,12 +21962,16 @@ export default class Client extends OpenApi {
      */
     describeReplicaSetRole(request: DescribeReplicaSetRoleRequest): Promise<DescribeReplicaSetRoleResponse>;
     /**
+     * Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.
+     *
      * @param request - DescribeRestoreDBInstanceListRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeRestoreDBInstanceListResponse
      */
     describeRestoreDBInstanceListWithOptions(request: DescribeRestoreDBInstanceListRequest, runtime: $Util.RuntimeOptions): Promise<DescribeRestoreDBInstanceListResponse>;
     /**
+     * Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.
+     *
      * @param request - DescribeRestoreDBInstanceListRequest
      * @returns DescribeRestoreDBInstanceListResponse
      */

package/dist/client.js

@@ -15686,6 +15686,8 @@ class Client extends openapi_client_1.default {
         return await this.describeReplicaSetRoleWithOptions(request, runtime);
     }
     /**
+     * Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.
+     *
      * @param request - DescribeRestoreDBInstanceListRequest
      * @param runtime - runtime options for this request RuntimeOptions
      * @returns DescribeRestoreDBInstanceListResponse
@@ -15734,6 +15736,8 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new DescribeRestoreDBInstanceListResponse({}));
     }
     /**
+     * Queries ApsaraDB for MongoDB instances whose backups are restored within seven days.
+     *
      * @param request - DescribeRestoreDBInstanceListRequest
      * @returns DescribeRestoreDBInstanceListResponse
      */