@alicloud/dds20151201 5.0.0 → 5.0.1

package/dist/client.d.ts

@@ -2927,6 +2927,7 @@ export declare class DescribeSecurityIpsRequest extends $tea.Model {
     ownerId?: number;
     resourceOwnerAccount?: string;
     resourceOwnerId?: number;
+    showHDMIps?: boolean;
     static names(): {
         [key: string]: string;
     };
@@ -7262,7 +7263,8 @@ export default class Client extends OpenApi {
      */
     checkCloudResourceAuthorized(request: CheckCloudResourceAuthorizedRequest): Promise<CheckCloudResourceAuthorizedResponse>;
     /**
-      * You can call this operation to check whether an ApsaraDB for MongoDB instance meets the data recovery conditions.
+      * This operation is applicable to replica set instances or sharded cluster instances.
+      * >  After you confirm that the data recovery conditions are met by calling this operation, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
       *
       * @param request CheckRecoveryConditionRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -7270,13 +7272,27 @@ export default class Client extends OpenApi {
      */
     checkRecoveryConditionWithOptions(request: CheckRecoveryConditionRequest, runtime: $Util.RuntimeOptions): Promise<CheckRecoveryConditionResponse>;
     /**
-      * You can call this operation to check whether an ApsaraDB for MongoDB instance meets the data recovery conditions.
+      * This operation is applicable to replica set instances or sharded cluster instances.
+      * >  After you confirm that the data recovery conditions are met by calling this operation, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
       *
       * @param request CheckRecoveryConditionRequest
       * @return CheckRecoveryConditionResponse
      */
     checkRecoveryCondition(request: CheckRecoveryConditionRequest): Promise<CheckRecoveryConditionResponse>;
+    /**
+      * Database accounts can be created only for shards in sharded cluster instances that use cloud disks.
+      *
+      * @param request CreateAccountRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return CreateAccountResponse
+     */
     createAccountWithOptions(request: CreateAccountRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccountResponse>;
+    /**
+      * Database accounts can be created only for shards in sharded cluster instances that use cloud disks.
+      *
+      * @param request CreateAccountRequest
+      * @return CreateAccountResponse
+     */
     createAccount(request: CreateAccountRequest): Promise<CreateAccountResponse>;
     /**
       * ## Usage
@@ -7617,7 +7633,24 @@ export default class Client extends OpenApi {
       * @return DescribeDBInstanceSSLResponse
      */
     describeDBInstanceSSL(request: DescribeDBInstanceSSLRequest): Promise<DescribeDBInstanceSSLResponse>;
+    /**
+      * Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
+      * *   The instance is a replica set or sharded cluster instance.
+      * *   The instance uses local physical disks to store data.
+      *
+      * @param request DescribeDBInstanceSwitchLogRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeDBInstanceSwitchLogResponse
+     */
     describeDBInstanceSwitchLogWithOptions(request: DescribeDBInstanceSwitchLogRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceSwitchLogResponse>;
+    /**
+      * Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
+      * *   The instance is a replica set or sharded cluster instance.
+      * *   The instance uses local physical disks to store data.
+      *
+      * @param request DescribeDBInstanceSwitchLogRequest
+      * @return DescribeDBInstanceSwitchLogResponse
+     */
     describeDBInstanceSwitchLog(request: DescribeDBInstanceSwitchLogRequest): Promise<DescribeDBInstanceSwitchLogResponse>;
     /**
       * >  For more information about this function, see [Configure TDE](~~131048~~).
@@ -7716,7 +7749,20 @@ export default class Client extends OpenApi {
     describeInstanceAutoRenewalAttribute(request: DescribeInstanceAutoRenewalAttributeRequest): Promise<DescribeInstanceAutoRenewalAttributeResponse>;
     describeKernelReleaseNotesWithOptions(request: DescribeKernelReleaseNotesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeKernelReleaseNotesResponse>;
     describeKernelReleaseNotes(request: DescribeKernelReleaseNotesRequest): Promise<DescribeKernelReleaseNotesResponse>;
+    /**
+      * Queried keys are available only for disk encryption.
+      *
+      * @param request DescribeKmsKeysRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeKmsKeysResponse
+     */
     describeKmsKeysWithOptions(request: DescribeKmsKeysRequest, runtime: $Util.RuntimeOptions): Promise<DescribeKmsKeysResponse>;
+    /**
+      * Queried keys are available only for disk encryption.
+      *
+      * @param request DescribeKmsKeysRequest
+      * @return DescribeKmsKeysResponse
+     */
     describeKmsKeys(request: DescribeKmsKeysRequest): Promise<DescribeKmsKeysResponse>;
     /**
       * This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
@@ -7961,7 +8007,7 @@ export default class Client extends OpenApi {
     modifyAccountDescription(request: ModifyAccountDescriptionRequest): Promise<ModifyAccountDescriptionResponse>;
     /**
       * *   The instance must be in the running state when you call this operation.
-      * *   This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
+      * *   This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
       * *   You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).
       *
       * @param request ModifyAuditLogFilterRequest
@@ -7971,7 +8017,7 @@ export default class Client extends OpenApi {
     modifyAuditLogFilterWithOptions(request: ModifyAuditLogFilterRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAuditLogFilterResponse>;
     /**
       * *   The instance must be in the running state when you call this operation.
-      * *   This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
+      * *   This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
       * *   You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).
       *
       * @param request ModifyAuditLogFilterRequest
@@ -8153,7 +8199,10 @@ export default class Client extends OpenApi {
      */
     modifyInstanceAutoRenewalAttribute(request: ModifyInstanceAutoRenewalAttributeRequest): Promise<ModifyInstanceAutoRenewalAttributeResponse>;
     /**
-      * You can call this operation to enable or disable password-free access from the same VPC as an ApsaraDB for MongoDB instance.
+      * Before you call this operation, make sure that the following requirements are met:
+      * *   A replica set or sharded cluster instance is used.
+      * *   The database version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
+      * *   The instance is in a VPC. If the network type is Classic Network, you can call the [ModifyDBInstanceNetworkType](~~62138~~) operation to switch the network type to VPC.
       *
       * @param request ModifyInstanceVpcAuthModeRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -8161,7 +8210,10 @@ export default class Client extends OpenApi {
      */
     modifyInstanceVpcAuthModeWithOptions(request: ModifyInstanceVpcAuthModeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyInstanceVpcAuthModeResponse>;
     /**
-      * You can call this operation to enable or disable password-free access from the same VPC as an ApsaraDB for MongoDB instance.
+      * Before you call this operation, make sure that the following requirements are met:
+      * *   A replica set or sharded cluster instance is used.
+      * *   The database version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
+      * *   The instance is in a VPC. If the network type is Classic Network, you can call the [ModifyDBInstanceNetworkType](~~62138~~) operation to switch the network type to VPC.
       *
       * @param request ModifyInstanceVpcAuthModeRequest
       * @return ModifyInstanceVpcAuthModeResponse
@@ -8202,7 +8254,7 @@ export default class Client extends OpenApi {
      */
     modifyNodeSpecBatch(request: ModifyNodeSpecBatchRequest): Promise<ModifyNodeSpecBatchResponse>;
     /**
-      * ## Precautions
+      * ### Precautions
       * *   The instance must be in the Running state when you call this operation.
       * *   If you call this operation to modify specific instance parameters and the modification for part of the parameters can take effect only after an instance restart, the instance is automatically restarted after this operation is called. You can call the [DescribeParameterTemplates](~~67618~~) operation to query the parameters that take effect only after the instance is restarted.
       *
@@ -8212,7 +8264,7 @@ export default class Client extends OpenApi {
      */
     modifyParametersWithOptions(request: ModifyParametersRequest, runtime: $Util.RuntimeOptions): Promise<ModifyParametersResponse>;
     /**
-      * ## Precautions
+      * ### Precautions
       * *   The instance must be in the Running state when you call this operation.
       * *   If you call this operation to modify specific instance parameters and the modification for part of the parameters can take effect only after an instance restart, the instance is automatically restarted after this operation is called. You can call the [DescribeParameterTemplates](~~67618~~) operation to query the parameters that take effect only after the instance is restarted.
       *
@@ -8252,7 +8304,20 @@ export default class Client extends OpenApi {
     modifySecurityGroupConfiguration(request: ModifySecurityGroupConfigurationRequest): Promise<ModifySecurityGroupConfigurationResponse>;
     modifySecurityIpsWithOptions(request: ModifySecurityIpsRequest, runtime: $Util.RuntimeOptions): Promise<ModifySecurityIpsResponse>;
     modifySecurityIps(request: ModifySecurityIpsRequest): Promise<ModifySecurityIpsResponse>;
+    /**
+      * The actions performed by this operation for a task vary based on the current state of the task. The supported actions for a task can be obtained from the value of the actionInfo parameter in the DescribeHistoryTasks operation.
+      *
+      * @param request ModifyTaskInfoRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return ModifyTaskInfoResponse
+     */
     modifyTaskInfoWithOptions(request: ModifyTaskInfoRequest, runtime: $Util.RuntimeOptions): Promise<ModifyTaskInfoResponse>;
+    /**
+      * The actions performed by this operation for a task vary based on the current state of the task. The supported actions for a task can be obtained from the value of the actionInfo parameter in the DescribeHistoryTasks operation.
+      *
+      * @param request ModifyTaskInfoRequest
+      * @return ModifyTaskInfoResponse
+     */
     modifyTaskInfo(request: ModifyTaskInfoRequest): Promise<ModifyTaskInfoResponse>;
     /**
       * *   This operation can be used to release the internal endpoint of a shard or Configserver node in a sharded cluster instance. For more information, see [Release the endpoint of a shard or Configserver node](~~134067~~).

package/dist/client.js

@@ -4268,6 +4268,7 @@ class DescribeSecurityIpsRequest extends $tea.Model {
             ownerId: 'OwnerId',
             resourceOwnerAccount: 'ResourceOwnerAccount',
             resourceOwnerId: 'ResourceOwnerId',
+            showHDMIps: 'ShowHDMIps',
         };
     }
     static types() {
@@ -4277,6 +4278,7 @@ class DescribeSecurityIpsRequest extends $tea.Model {
             ownerId: 'number',
             resourceOwnerAccount: 'string',
             resourceOwnerId: 'number',
+            showHDMIps: 'boolean',
         };
     }
 }
@@ -10685,7 +10687,8 @@ class Client extends openapi_client_1.default {
         return await this.checkCloudResourceAuthorizedWithOptions(request, runtime);
     }
     /**
-      * You can call this operation to check whether an ApsaraDB for MongoDB instance meets the data recovery conditions.
+      * This operation is applicable to replica set instances or sharded cluster instances.
+      * >  After you confirm that the data recovery conditions are met by calling this operation, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
       *
       * @param request CheckRecoveryConditionRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -10741,7 +10744,8 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new CheckRecoveryConditionResponse({}));
     }
     /**
-      * You can call this operation to check whether an ApsaraDB for MongoDB instance meets the data recovery conditions.
+      * This operation is applicable to replica set instances or sharded cluster instances.
+      * >  After you confirm that the data recovery conditions are met by calling this operation, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
       *
       * @param request CheckRecoveryConditionRequest
       * @return CheckRecoveryConditionResponse
@@ -10750,6 +10754,13 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.checkRecoveryConditionWithOptions(request, runtime);
     }
+    /**
+      * Database accounts can be created only for shards in sharded cluster instances that use cloud disks.
+      *
+      * @param request CreateAccountRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return CreateAccountResponse
+     */
     async createAccountWithOptions(request, runtime) {
         tea_util_1.default.validateModel(request);
         let query = {};
@@ -10790,6 +10801,12 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new CreateAccountResponse({}));
     }
+    /**
+      * Database accounts can be created only for shards in sharded cluster instances that use cloud disks.
+      *
+      * @param request CreateAccountRequest
+      * @return CreateAccountResponse
+     */
     async createAccount(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.createAccountWithOptions(request, runtime);
@@ -12657,6 +12674,15 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeDBInstanceSSLWithOptions(request, runtime);
     }
+    /**
+      * Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
+      * *   The instance is a replica set or sharded cluster instance.
+      * *   The instance uses local physical disks to store data.
+      *
+      * @param request DescribeDBInstanceSwitchLogRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeDBInstanceSwitchLogResponse
+     */
     async describeDBInstanceSwitchLogWithOptions(request, runtime) {
         tea_util_1.default.validateModel(request);
         let query = {};
@@ -12694,6 +12720,14 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new DescribeDBInstanceSwitchLogResponse({}));
     }
+    /**
+      * Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
+      * *   The instance is a replica set or sharded cluster instance.
+      * *   The instance uses local physical disks to store data.
+      *
+      * @param request DescribeDBInstanceSwitchLogRequest
+      * @return DescribeDBInstanceSwitchLogResponse
+     */
     async describeDBInstanceSwitchLog(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeDBInstanceSwitchLogWithOptions(request, runtime);
@@ -13302,6 +13336,13 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeKernelReleaseNotesWithOptions(request, runtime);
     }
+    /**
+      * Queried keys are available only for disk encryption.
+      *
+      * @param request DescribeKmsKeysRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return DescribeKmsKeysResponse
+     */
     async describeKmsKeysWithOptions(request, runtime) {
         tea_util_1.default.validateModel(request);
         let query = {};
@@ -13333,6 +13374,12 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new DescribeKmsKeysResponse({}));
     }
+    /**
+      * Queried keys are available only for disk encryption.
+      *
+      * @param request DescribeKmsKeysRequest
+      * @return DescribeKmsKeysResponse
+     */
     async describeKmsKeys(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.describeKmsKeysWithOptions(request, runtime);
@@ -13951,6 +13998,9 @@ class Client extends openapi_client_1.default {
         if (!tea_util_1.default.isUnset(request.resourceOwnerId)) {
             query["ResourceOwnerId"] = request.resourceOwnerId;
         }
+        if (!tea_util_1.default.isUnset(request.showHDMIps)) {
+            query["ShowHDMIps"] = request.showHDMIps;
+        }
         let req = new $OpenApi.OpenApiRequest({
             query: openapi_util_1.default.query(query),
         });
@@ -14573,7 +14623,7 @@ class Client extends openapi_client_1.default {
     }
     /**
       * *   The instance must be in the running state when you call this operation.
-      * *   This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
+      * *   This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
       * *   You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).
       *
       * @param request ModifyAuditLogFilterRequest
@@ -14622,7 +14672,7 @@ class Client extends openapi_client_1.default {
     }
     /**
       * *   The instance must be in the running state when you call this operation.
-      * *   This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
+      * *   This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
       * *   You can call this operation up to 30 times per minute. To call this operation at a higher frequency, use a Logstore. For more information, see [Manage a Logstore](~~48990~~).
       *
       * @param request ModifyAuditLogFilterRequest
@@ -15509,7 +15559,10 @@ class Client extends openapi_client_1.default {
         return await this.modifyInstanceAutoRenewalAttributeWithOptions(request, runtime);
     }
     /**
-      * You can call this operation to enable or disable password-free access from the same VPC as an ApsaraDB for MongoDB instance.
+      * Before you call this operation, make sure that the following requirements are met:
+      * *   A replica set or sharded cluster instance is used.
+      * *   The database version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
+      * *   The instance is in a VPC. If the network type is Classic Network, you can call the [ModifyDBInstanceNetworkType](~~62138~~) operation to switch the network type to VPC.
       *
       * @param request ModifyInstanceVpcAuthModeRequest
       * @param runtime runtime options for this request RuntimeOptions
@@ -15556,7 +15609,10 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new ModifyInstanceVpcAuthModeResponse({}));
     }
     /**
-      * You can call this operation to enable or disable password-free access from the same VPC as an ApsaraDB for MongoDB instance.
+      * Before you call this operation, make sure that the following requirements are met:
+      * *   A replica set or sharded cluster instance is used.
+      * *   The database version of the instance is 4.0 (with the minor version of mongodb\\_20190408\\_3.0.11 or later) or 4.2. You can call the [DescribeDBInstanceAttribute](~~62010~~) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
+      * *   The instance is in a VPC. If the network type is Classic Network, you can call the [ModifyDBInstanceNetworkType](~~62138~~) operation to switch the network type to VPC.
       *
       * @param request ModifyInstanceVpcAuthModeRequest
       * @return ModifyInstanceVpcAuthModeResponse
@@ -15732,7 +15788,7 @@ class Client extends openapi_client_1.default {
         return await this.modifyNodeSpecBatchWithOptions(request, runtime);
     }
     /**
-      * ## Precautions
+      * ### Precautions
       * *   The instance must be in the Running state when you call this operation.
       * *   If you call this operation to modify specific instance parameters and the modification for part of the parameters can take effect only after an instance restart, the instance is automatically restarted after this operation is called. You can call the [DescribeParameterTemplates](~~67618~~) operation to query the parameters that take effect only after the instance is restarted.
       *
@@ -15787,7 +15843,7 @@ class Client extends openapi_client_1.default {
         return $tea.cast(await this.callApi(params, req, runtime), new ModifyParametersResponse({}));
     }
     /**
-      * ## Precautions
+      * ### Precautions
       * *   The instance must be in the Running state when you call this operation.
       * *   If you call this operation to modify specific instance parameters and the modification for part of the parameters can take effect only after an instance restart, the instance is automatically restarted after this operation is called. You can call the [DescribeParameterTemplates](~~67618~~) operation to query the parameters that take effect only after the instance is restarted.
       *
@@ -15959,6 +16015,13 @@ class Client extends openapi_client_1.default {
         let runtime = new $Util.RuntimeOptions({});
         return await this.modifySecurityIpsWithOptions(request, runtime);
     }
+    /**
+      * The actions performed by this operation for a task vary based on the current state of the task. The supported actions for a task can be obtained from the value of the actionInfo parameter in the DescribeHistoryTasks operation.
+      *
+      * @param request ModifyTaskInfoRequest
+      * @param runtime runtime options for this request RuntimeOptions
+      * @return ModifyTaskInfoResponse
+     */
     async modifyTaskInfoWithOptions(request, runtime) {
         tea_util_1.default.validateModel(request);
         let query = {};
@@ -15999,6 +16062,12 @@ class Client extends openapi_client_1.default {
         });
         return $tea.cast(await this.callApi(params, req, runtime), new ModifyTaskInfoResponse({}));
     }
+    /**
+      * The actions performed by this operation for a task vary based on the current state of the task. The supported actions for a task can be obtained from the value of the actionInfo parameter in the DescribeHistoryTasks operation.
+      *
+      * @param request ModifyTaskInfoRequest
+      * @return ModifyTaskInfoResponse
+     */
     async modifyTaskInfo(request) {
         let runtime = new $Util.RuntimeOptions({});
         return await this.modifyTaskInfoWithOptions(request, runtime);