@alicloud/dds20151201 5.0.0 → 5.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +124 -36
- package/dist/client.js +138 -36
- package/dist/client.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +146 -36
package/dist/client.d.ts
CHANGED
|
@@ -1099,6 +1099,7 @@ export declare class DescribeAvailabilityZonesRequest extends $tea.Model {
|
|
|
1099
1099
|
ownerAccount?: string;
|
|
1100
1100
|
ownerId?: number;
|
|
1101
1101
|
regionId?: string;
|
|
1102
|
+
replicationFactor?: string;
|
|
1102
1103
|
resourceGroupId?: string;
|
|
1103
1104
|
resourceOwnerAccount?: string;
|
|
1104
1105
|
resourceOwnerId?: number;
|
|
@@ -1197,6 +1198,7 @@ export declare class DescribeAvailableResourceRequest extends $tea.Model {
|
|
|
1197
1198
|
ownerAccount?: string;
|
|
1198
1199
|
ownerId?: number;
|
|
1199
1200
|
regionId?: string;
|
|
1201
|
+
replicationFactor?: string;
|
|
1200
1202
|
resourceGroupId?: string;
|
|
1201
1203
|
resourceOwnerAccount?: string;
|
|
1202
1204
|
resourceOwnerId?: number;
|
|
@@ -2927,6 +2929,7 @@ export declare class DescribeSecurityIpsRequest extends $tea.Model {
|
|
|
2927
2929
|
ownerId?: number;
|
|
2928
2930
|
resourceOwnerAccount?: string;
|
|
2929
2931
|
resourceOwnerId?: number;
|
|
2932
|
+
showHDMIps?: boolean;
|
|
2930
2933
|
static names(): {
|
|
2931
2934
|
[key: string]: string;
|
|
2932
2935
|
};
|
|
@@ -5881,6 +5884,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
5881
5884
|
export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceShardListShardAttribute extends $tea.Model {
|
|
5882
5885
|
connectString?: string;
|
|
5883
5886
|
maxConnections?: number;
|
|
5887
|
+
maxDiskMbps?: string;
|
|
5884
5888
|
maxIOPS?: number;
|
|
5885
5889
|
nodeClass?: string;
|
|
5886
5890
|
nodeDescription?: string;
|
|
@@ -5965,6 +5969,7 @@ export declare class DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanc
|
|
|
5965
5969
|
maintainStartTime?: string;
|
|
5966
5970
|
maxConnections?: number;
|
|
5967
5971
|
maxIOPS?: number;
|
|
5972
|
+
maxMBPS?: number;
|
|
5968
5973
|
mongosList?: DescribeDBInstanceAttributeResponseBodyDBInstancesDBInstanceMongosList;
|
|
5969
5974
|
networkType?: string;
|
|
5970
5975
|
protocolType?: string;
|
|
@@ -7228,8 +7233,8 @@ export default class Client extends OpenApi {
|
|
|
7228
7233
|
[key: string]: string;
|
|
7229
7234
|
}, endpoint: string): string;
|
|
7230
7235
|
/**
|
|
7231
|
-
* This operation
|
|
7232
|
-
* > The
|
|
7236
|
+
* This operation is applicable only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](~~134037~~).
|
|
7237
|
+
* > The allocated endpoints can be used only for internal access. To gain Internet access, you must call the [AllocatePublicNetworkAddress](~~67602~~) operation to apply for public endpoints.
|
|
7233
7238
|
*
|
|
7234
7239
|
* @param request AllocateNodePrivateNetworkAddressRequest
|
|
7235
7240
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -7237,8 +7242,8 @@ export default class Client extends OpenApi {
|
|
|
7237
7242
|
*/
|
|
7238
7243
|
allocateNodePrivateNetworkAddressWithOptions(request: AllocateNodePrivateNetworkAddressRequest, runtime: $Util.RuntimeOptions): Promise<AllocateNodePrivateNetworkAddressResponse>;
|
|
7239
7244
|
/**
|
|
7240
|
-
* This operation
|
|
7241
|
-
* > The
|
|
7245
|
+
* This operation is applicable only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](~~134037~~).
|
|
7246
|
+
* > The allocated endpoints can be used only for internal access. To gain Internet access, you must call the [AllocatePublicNetworkAddress](~~67602~~) operation to apply for public endpoints.
|
|
7242
7247
|
*
|
|
7243
7248
|
* @param request AllocateNodePrivateNetworkAddressRequest
|
|
7244
7249
|
* @return AllocateNodePrivateNetworkAddressResponse
|
|
@@ -7262,7 +7267,8 @@ export default class Client extends OpenApi {
|
|
|
7262
7267
|
*/
|
|
7263
7268
|
checkCloudResourceAuthorized(request: CheckCloudResourceAuthorizedRequest): Promise<CheckCloudResourceAuthorizedResponse>;
|
|
7264
7269
|
/**
|
|
7265
|
-
*
|
|
7270
|
+
* This operation is applicable to replica set instances and sharded cluster instances.
|
|
7271
|
+
* > After you call this operation to confirm that the data of the instance can be restored, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
|
|
7266
7272
|
*
|
|
7267
7273
|
* @param request CheckRecoveryConditionRequest
|
|
7268
7274
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -7270,13 +7276,27 @@ export default class Client extends OpenApi {
|
|
|
7270
7276
|
*/
|
|
7271
7277
|
checkRecoveryConditionWithOptions(request: CheckRecoveryConditionRequest, runtime: $Util.RuntimeOptions): Promise<CheckRecoveryConditionResponse>;
|
|
7272
7278
|
/**
|
|
7273
|
-
*
|
|
7279
|
+
* This operation is applicable to replica set instances and sharded cluster instances.
|
|
7280
|
+
* > After you call this operation to confirm that the data of the instance can be restored, you can call the [CreateDBInstance](~~61763~~) operation to restore data to a new instance.
|
|
7274
7281
|
*
|
|
7275
7282
|
* @param request CheckRecoveryConditionRequest
|
|
7276
7283
|
* @return CheckRecoveryConditionResponse
|
|
7277
7284
|
*/
|
|
7278
7285
|
checkRecoveryCondition(request: CheckRecoveryConditionRequest): Promise<CheckRecoveryConditionResponse>;
|
|
7286
|
+
/**
|
|
7287
|
+
* Database accounts can be created only for shards in sharded cluster instances that use cloud disks.
|
|
7288
|
+
*
|
|
7289
|
+
* @param request CreateAccountRequest
|
|
7290
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
7291
|
+
* @return CreateAccountResponse
|
|
7292
|
+
*/
|
|
7279
7293
|
createAccountWithOptions(request: CreateAccountRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccountResponse>;
|
|
7294
|
+
/**
|
|
7295
|
+
* Database accounts can be created only for shards in sharded cluster instances that use cloud disks.
|
|
7296
|
+
*
|
|
7297
|
+
* @param request CreateAccountRequest
|
|
7298
|
+
* @return CreateAccountResponse
|
|
7299
|
+
*/
|
|
7280
7300
|
createAccount(request: CreateAccountRequest): Promise<CreateAccountResponse>;
|
|
7281
7301
|
/**
|
|
7282
7302
|
* ## Usage
|
|
@@ -7426,7 +7446,20 @@ export default class Client extends OpenApi {
|
|
|
7426
7446
|
describeAccounts(request: DescribeAccountsRequest): Promise<DescribeAccountsResponse>;
|
|
7427
7447
|
describeActiveOperationTaskCountWithOptions(request: DescribeActiveOperationTaskCountRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActiveOperationTaskCountResponse>;
|
|
7428
7448
|
describeActiveOperationTaskCount(request: DescribeActiveOperationTaskCountRequest): Promise<DescribeActiveOperationTaskCountResponse>;
|
|
7449
|
+
/**
|
|
7450
|
+
* This operation is no longer updated and will be unavailable.
|
|
7451
|
+
*
|
|
7452
|
+
* @param request DescribeActiveOperationTaskTypeRequest
|
|
7453
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
7454
|
+
* @return DescribeActiveOperationTaskTypeResponse
|
|
7455
|
+
*/
|
|
7429
7456
|
describeActiveOperationTaskTypeWithOptions(request: DescribeActiveOperationTaskTypeRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActiveOperationTaskTypeResponse>;
|
|
7457
|
+
/**
|
|
7458
|
+
* This operation is no longer updated and will be unavailable.
|
|
7459
|
+
*
|
|
7460
|
+
* @param request DescribeActiveOperationTaskTypeRequest
|
|
7461
|
+
* @return DescribeActiveOperationTaskTypeResponse
|
|
7462
|
+
*/
|
|
7430
7463
|
describeActiveOperationTaskType(request: DescribeActiveOperationTaskTypeRequest): Promise<DescribeActiveOperationTaskTypeResponse>;
|
|
7431
7464
|
describeActiveOperationTasksWithOptions(request: DescribeActiveOperationTasksRequest, runtime: $Util.RuntimeOptions): Promise<DescribeActiveOperationTasksResponse>;
|
|
7432
7465
|
describeActiveOperationTasks(request: DescribeActiveOperationTasksRequest): Promise<DescribeActiveOperationTasksResponse>;
|
|
@@ -7488,7 +7521,7 @@ export default class Client extends OpenApi {
|
|
|
7488
7521
|
*/
|
|
7489
7522
|
describeAuditRecords(request: DescribeAuditRecordsRequest): Promise<DescribeAuditRecordsResponse>;
|
|
7490
7523
|
/**
|
|
7491
|
-
*
|
|
7524
|
+
* Queries the zones in which an ApsaraDB for MongoDB instance can be deployed under specified purchase conditions. The region ID is required in the purchase condition.
|
|
7492
7525
|
*
|
|
7493
7526
|
* @param request DescribeAvailabilityZonesRequest
|
|
7494
7527
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -7496,7 +7529,7 @@ export default class Client extends OpenApi {
|
|
|
7496
7529
|
*/
|
|
7497
7530
|
describeAvailabilityZonesWithOptions(request: DescribeAvailabilityZonesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeAvailabilityZonesResponse>;
|
|
7498
7531
|
/**
|
|
7499
|
-
*
|
|
7532
|
+
* Queries the zones in which an ApsaraDB for MongoDB instance can be deployed under specified purchase conditions. The region ID is required in the purchase condition.
|
|
7500
7533
|
*
|
|
7501
7534
|
* @param request DescribeAvailabilityZonesRequest
|
|
7502
7535
|
* @return DescribeAvailabilityZonesResponse
|
|
@@ -7617,7 +7650,24 @@ export default class Client extends OpenApi {
|
|
|
7617
7650
|
* @return DescribeDBInstanceSSLResponse
|
|
7618
7651
|
*/
|
|
7619
7652
|
describeDBInstanceSSL(request: DescribeDBInstanceSSLRequest): Promise<DescribeDBInstanceSSLResponse>;
|
|
7653
|
+
/**
|
|
7654
|
+
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
7655
|
+
* * The instance is a replica set or sharded cluster instance.
|
|
7656
|
+
* * The instance uses local physical disks to store data.
|
|
7657
|
+
*
|
|
7658
|
+
* @param request DescribeDBInstanceSwitchLogRequest
|
|
7659
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
7660
|
+
* @return DescribeDBInstanceSwitchLogResponse
|
|
7661
|
+
*/
|
|
7620
7662
|
describeDBInstanceSwitchLogWithOptions(request: DescribeDBInstanceSwitchLogRequest, runtime: $Util.RuntimeOptions): Promise<DescribeDBInstanceSwitchLogResponse>;
|
|
7663
|
+
/**
|
|
7664
|
+
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
7665
|
+
* * The instance is a replica set or sharded cluster instance.
|
|
7666
|
+
* * The instance uses local physical disks to store data.
|
|
7667
|
+
*
|
|
7668
|
+
* @param request DescribeDBInstanceSwitchLogRequest
|
|
7669
|
+
* @return DescribeDBInstanceSwitchLogResponse
|
|
7670
|
+
*/
|
|
7621
7671
|
describeDBInstanceSwitchLog(request: DescribeDBInstanceSwitchLogRequest): Promise<DescribeDBInstanceSwitchLogResponse>;
|
|
7622
7672
|
/**
|
|
7623
7673
|
* > For more information about this function, see [Configure TDE](~~131048~~).
|
|
@@ -7716,13 +7766,26 @@ export default class Client extends OpenApi {
|
|
|
7716
7766
|
describeInstanceAutoRenewalAttribute(request: DescribeInstanceAutoRenewalAttributeRequest): Promise<DescribeInstanceAutoRenewalAttributeResponse>;
|
|
7717
7767
|
describeKernelReleaseNotesWithOptions(request: DescribeKernelReleaseNotesRequest, runtime: $Util.RuntimeOptions): Promise<DescribeKernelReleaseNotesResponse>;
|
|
7718
7768
|
describeKernelReleaseNotes(request: DescribeKernelReleaseNotesRequest): Promise<DescribeKernelReleaseNotesResponse>;
|
|
7769
|
+
/**
|
|
7770
|
+
* Queried keys are available only for disk encryption.
|
|
7771
|
+
*
|
|
7772
|
+
* @param request DescribeKmsKeysRequest
|
|
7773
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
7774
|
+
* @return DescribeKmsKeysResponse
|
|
7775
|
+
*/
|
|
7719
7776
|
describeKmsKeysWithOptions(request: DescribeKmsKeysRequest, runtime: $Util.RuntimeOptions): Promise<DescribeKmsKeysResponse>;
|
|
7777
|
+
/**
|
|
7778
|
+
* Queried keys are available only for disk encryption.
|
|
7779
|
+
*
|
|
7780
|
+
* @param request DescribeKmsKeysRequest
|
|
7781
|
+
* @return DescribeKmsKeysResponse
|
|
7782
|
+
*/
|
|
7720
7783
|
describeKmsKeys(request: DescribeKmsKeysRequest): Promise<DescribeKmsKeysResponse>;
|
|
7721
7784
|
/**
|
|
7722
7785
|
* This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
7723
|
-
* This operation depends on the audit log feature of ApsaraDB for MongoDB. You can enable the audit log feature based on your business
|
|
7786
|
+
* This operation depends on the audit log feature of ApsaraDB for MongoDB. You can enable the audit log feature based on your business requirements. For more information, see [Enable the audit log feature](~~59903~~).
|
|
7724
7787
|
* * Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and new applications for the free trial edition have ended. For more information, see [Notice on official launch of the pay-as-you-go audit log feature and no more application for the free trial edition](~~377480~~)
|
|
7725
|
-
* *
|
|
7788
|
+
* * You are charged for the official edition of the audit log feature based on the storage capacity that is consumed by audit logs and the retention period of the audit logs. For more information, see [Pricing of ApsaraDB for MongoDB instances](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).
|
|
7726
7789
|
*
|
|
7727
7790
|
* @param request DescribeMongoDBLogConfigRequest
|
|
7728
7791
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -7731,9 +7794,9 @@ export default class Client extends OpenApi {
|
|
|
7731
7794
|
describeMongoDBLogConfigWithOptions(request: DescribeMongoDBLogConfigRequest, runtime: $Util.RuntimeOptions): Promise<DescribeMongoDBLogConfigResponse>;
|
|
7732
7795
|
/**
|
|
7733
7796
|
* This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
7734
|
-
* This operation depends on the audit log feature of ApsaraDB for MongoDB. You can enable the audit log feature based on your business
|
|
7797
|
+
* This operation depends on the audit log feature of ApsaraDB for MongoDB. You can enable the audit log feature based on your business requirements. For more information, see [Enable the audit log feature](~~59903~~).
|
|
7735
7798
|
* * Starting from January 6, 2022, the official edition of the audit log feature has been launched in all regions, and new applications for the free trial edition have ended. For more information, see [Notice on official launch of the pay-as-you-go audit log feature and no more application for the free trial edition](~~377480~~)
|
|
7736
|
-
* *
|
|
7799
|
+
* * You are charged for the official edition of the audit log feature based on the storage capacity that is consumed by audit logs and the retention period of the audit logs. For more information, see [Pricing of ApsaraDB for MongoDB instances](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).
|
|
7737
7800
|
*
|
|
7738
7801
|
* @param request DescribeMongoDBLogConfigRequest
|
|
7739
7802
|
* @return DescribeMongoDBLogConfigResponse
|
|
@@ -7831,7 +7894,7 @@ export default class Client extends OpenApi {
|
|
|
7831
7894
|
describeSecurityIpsWithOptions(request: DescribeSecurityIpsRequest, runtime: $Util.RuntimeOptions): Promise<DescribeSecurityIpsResponse>;
|
|
7832
7895
|
describeSecurityIps(request: DescribeSecurityIpsRequest): Promise<DescribeSecurityIpsResponse>;
|
|
7833
7896
|
/**
|
|
7834
|
-
* This operation
|
|
7897
|
+
* This operation is applicable only to sharded cluster instances.
|
|
7835
7898
|
*
|
|
7836
7899
|
* @param request DescribeShardingNetworkAddressRequest
|
|
7837
7900
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -7839,7 +7902,7 @@ export default class Client extends OpenApi {
|
|
|
7839
7902
|
*/
|
|
7840
7903
|
describeShardingNetworkAddressWithOptions(request: DescribeShardingNetworkAddressRequest, runtime: $Util.RuntimeOptions): Promise<DescribeShardingNetworkAddressResponse>;
|
|
7841
7904
|
/**
|
|
7842
|
-
* This operation
|
|
7905
|
+
* This operation is applicable only to sharded cluster instances.
|
|
7843
7906
|
*
|
|
7844
7907
|
* @param request DescribeShardingNetworkAddressRequest
|
|
7845
7908
|
* @return DescribeShardingNetworkAddressResponse
|
|
@@ -7961,7 +8024,7 @@ export default class Client extends OpenApi {
|
|
|
7961
8024
|
modifyAccountDescription(request: ModifyAccountDescriptionRequest): Promise<ModifyAccountDescriptionResponse>;
|
|
7962
8025
|
/**
|
|
7963
8026
|
* * The instance must be in the running state when you call this operation.
|
|
7964
|
-
* * This operation is applicable only to **general-purpose local-disk**
|
|
8027
|
+
* * This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
|
|
7965
8028
|
* * 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~~).
|
|
7966
8029
|
*
|
|
7967
8030
|
* @param request ModifyAuditLogFilterRequest
|
|
@@ -7971,7 +8034,7 @@ export default class Client extends OpenApi {
|
|
|
7971
8034
|
modifyAuditLogFilterWithOptions(request: ModifyAuditLogFilterRequest, runtime: $Util.RuntimeOptions): Promise<ModifyAuditLogFilterResponse>;
|
|
7972
8035
|
/**
|
|
7973
8036
|
* * The instance must be in the running state when you call this operation.
|
|
7974
|
-
* * This operation is applicable only to **general-purpose local-disk**
|
|
8037
|
+
* * This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
|
|
7975
8038
|
* * 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~~).
|
|
7976
8039
|
*
|
|
7977
8040
|
* @param request ModifyAuditLogFilterRequest
|
|
@@ -8025,10 +8088,10 @@ export default class Client extends OpenApi {
|
|
|
8025
8088
|
*/
|
|
8026
8089
|
modifyDBInstanceMonitor(request: ModifyDBInstanceMonitorRequest): Promise<ModifyDBInstanceMonitorResponse>;
|
|
8027
8090
|
/**
|
|
8028
|
-
* Before you call this operation, make sure that the following requirements
|
|
8029
|
-
* * The instance is in the
|
|
8091
|
+
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
8092
|
+
* * The instance is in the Running state.
|
|
8030
8093
|
* * The network of the instance is in hybrid access mode.
|
|
8031
|
-
* > This operation is
|
|
8094
|
+
* > This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
|
|
8032
8095
|
*
|
|
8033
8096
|
* @param request ModifyDBInstanceNetExpireTimeRequest
|
|
8034
8097
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8036,10 +8099,10 @@ export default class Client extends OpenApi {
|
|
|
8036
8099
|
*/
|
|
8037
8100
|
modifyDBInstanceNetExpireTimeWithOptions(request: ModifyDBInstanceNetExpireTimeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceNetExpireTimeResponse>;
|
|
8038
8101
|
/**
|
|
8039
|
-
* Before you call this operation, make sure that the following requirements
|
|
8040
|
-
* * The instance is in the
|
|
8102
|
+
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
8103
|
+
* * The instance is in the Running state.
|
|
8041
8104
|
* * The network of the instance is in hybrid access mode.
|
|
8042
|
-
* > This operation is
|
|
8105
|
+
* > This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
|
|
8043
8106
|
*
|
|
8044
8107
|
* @param request ModifyDBInstanceNetExpireTimeRequest
|
|
8045
8108
|
* @return ModifyDBInstanceNetExpireTimeResponse
|
|
@@ -8104,10 +8167,11 @@ export default class Client extends OpenApi {
|
|
|
8104
8167
|
modifyDBInstanceSpec(request: ModifyDBInstanceSpecRequest): Promise<ModifyDBInstanceSpecResponse>;
|
|
8105
8168
|
/**
|
|
8106
8169
|
* TDE allows you to perform real-time I/O encryption and decryption on data files. Data is encrypted before it is written to a disk and is decrypted when it is read from the disk to the memory. For more information, see [Configure TDE](~~131048~~).
|
|
8107
|
-
* >
|
|
8108
|
-
* Before you call this
|
|
8109
|
-
* *
|
|
8170
|
+
* > TDE cannot be disabled after it is enabled.
|
|
8171
|
+
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8172
|
+
* * A replica set or sharded cluster instance is used.
|
|
8110
8173
|
* * The storage engine of the instance is WiredTiger.
|
|
8174
|
+
* * The instance uses local disks to store data.
|
|
8111
8175
|
* * The database engine version of the instance is 4.0 or 4.2. If the database engine version is earlier than 4.0, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
|
|
8112
8176
|
*
|
|
8113
8177
|
* @param request ModifyDBInstanceTDERequest
|
|
@@ -8117,10 +8181,11 @@ export default class Client extends OpenApi {
|
|
|
8117
8181
|
modifyDBInstanceTDEWithOptions(request: ModifyDBInstanceTDERequest, runtime: $Util.RuntimeOptions): Promise<ModifyDBInstanceTDEResponse>;
|
|
8118
8182
|
/**
|
|
8119
8183
|
* TDE allows you to perform real-time I/O encryption and decryption on data files. Data is encrypted before it is written to a disk and is decrypted when it is read from the disk to the memory. For more information, see [Configure TDE](~~131048~~).
|
|
8120
|
-
* >
|
|
8121
|
-
* Before you call this
|
|
8122
|
-
* *
|
|
8184
|
+
* > TDE cannot be disabled after it is enabled.
|
|
8185
|
+
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8186
|
+
* * A replica set or sharded cluster instance is used.
|
|
8123
8187
|
* * The storage engine of the instance is WiredTiger.
|
|
8188
|
+
* * The instance uses local disks to store data.
|
|
8124
8189
|
* * The database engine version of the instance is 4.0 or 4.2. If the database engine version is earlier than 4.0, you can call the [UpgradeDBInstanceEngineVersion](~~67608~~) operation to upgrade the database engine.
|
|
8125
8190
|
*
|
|
8126
8191
|
* @param request ModifyDBInstanceTDERequest
|
|
@@ -8153,7 +8218,11 @@ export default class Client extends OpenApi {
|
|
|
8153
8218
|
*/
|
|
8154
8219
|
modifyInstanceAutoRenewalAttribute(request: ModifyInstanceAutoRenewalAttributeRequest): Promise<ModifyInstanceAutoRenewalAttributeResponse>;
|
|
8155
8220
|
/**
|
|
8156
|
-
*
|
|
8221
|
+
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8222
|
+
* * The instance is a replica set or sharded cluster instance.
|
|
8223
|
+
* * The database engine 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 version of the instance.
|
|
8224
|
+
* * The network type of the instance must be VPC. If the network type of the instance is classic network, you must call the [ModifyDBInstanceNetworkType](~~62138~~) operation to change the network type to VPC.
|
|
8225
|
+
* * You can only disable but not enable password-free access over VPC.
|
|
8157
8226
|
*
|
|
8158
8227
|
* @param request ModifyInstanceVpcAuthModeRequest
|
|
8159
8228
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8161,7 +8230,11 @@ export default class Client extends OpenApi {
|
|
|
8161
8230
|
*/
|
|
8162
8231
|
modifyInstanceVpcAuthModeWithOptions(request: ModifyInstanceVpcAuthModeRequest, runtime: $Util.RuntimeOptions): Promise<ModifyInstanceVpcAuthModeResponse>;
|
|
8163
8232
|
/**
|
|
8164
|
-
*
|
|
8233
|
+
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8234
|
+
* * The instance is a replica set or sharded cluster instance.
|
|
8235
|
+
* * The database engine 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 version of the instance.
|
|
8236
|
+
* * The network type of the instance must be VPC. If the network type of the instance is classic network, you must call the [ModifyDBInstanceNetworkType](~~62138~~) operation to change the network type to VPC.
|
|
8237
|
+
* * You can only disable but not enable password-free access over VPC.
|
|
8165
8238
|
*
|
|
8166
8239
|
* @param request ModifyInstanceVpcAuthModeRequest
|
|
8167
8240
|
* @return ModifyInstanceVpcAuthModeResponse
|
|
@@ -8202,7 +8275,7 @@ export default class Client extends OpenApi {
|
|
|
8202
8275
|
*/
|
|
8203
8276
|
modifyNodeSpecBatch(request: ModifyNodeSpecBatchRequest): Promise<ModifyNodeSpecBatchResponse>;
|
|
8204
8277
|
/**
|
|
8205
|
-
*
|
|
8278
|
+
* ### Precautions
|
|
8206
8279
|
* * The instance must be in the Running state when you call this operation.
|
|
8207
8280
|
* * 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.
|
|
8208
8281
|
*
|
|
@@ -8212,7 +8285,7 @@ export default class Client extends OpenApi {
|
|
|
8212
8285
|
*/
|
|
8213
8286
|
modifyParametersWithOptions(request: ModifyParametersRequest, runtime: $Util.RuntimeOptions): Promise<ModifyParametersResponse>;
|
|
8214
8287
|
/**
|
|
8215
|
-
*
|
|
8288
|
+
* ### Precautions
|
|
8216
8289
|
* * The instance must be in the Running state when you call this operation.
|
|
8217
8290
|
* * 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.
|
|
8218
8291
|
*
|
|
@@ -8252,7 +8325,20 @@ export default class Client extends OpenApi {
|
|
|
8252
8325
|
modifySecurityGroupConfiguration(request: ModifySecurityGroupConfigurationRequest): Promise<ModifySecurityGroupConfigurationResponse>;
|
|
8253
8326
|
modifySecurityIpsWithOptions(request: ModifySecurityIpsRequest, runtime: $Util.RuntimeOptions): Promise<ModifySecurityIpsResponse>;
|
|
8254
8327
|
modifySecurityIps(request: ModifySecurityIpsRequest): Promise<ModifySecurityIpsResponse>;
|
|
8328
|
+
/**
|
|
8329
|
+
* 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.
|
|
8330
|
+
*
|
|
8331
|
+
* @param request ModifyTaskInfoRequest
|
|
8332
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
8333
|
+
* @return ModifyTaskInfoResponse
|
|
8334
|
+
*/
|
|
8255
8335
|
modifyTaskInfoWithOptions(request: ModifyTaskInfoRequest, runtime: $Util.RuntimeOptions): Promise<ModifyTaskInfoResponse>;
|
|
8336
|
+
/**
|
|
8337
|
+
* 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.
|
|
8338
|
+
*
|
|
8339
|
+
* @param request ModifyTaskInfoRequest
|
|
8340
|
+
* @return ModifyTaskInfoResponse
|
|
8341
|
+
*/
|
|
8256
8342
|
modifyTaskInfo(request: ModifyTaskInfoRequest): Promise<ModifyTaskInfoResponse>;
|
|
8257
8343
|
/**
|
|
8258
8344
|
* * 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~~).
|
|
@@ -8321,8 +8407,9 @@ export default class Client extends OpenApi {
|
|
|
8321
8407
|
*/
|
|
8322
8408
|
restartDBInstance(request: RestartDBInstanceRequest): Promise<RestartDBInstanceResponse>;
|
|
8323
8409
|
/**
|
|
8324
|
-
* This operation is
|
|
8325
|
-
*
|
|
8410
|
+
* This operation is no longer maintained and will be unavailable.
|
|
8411
|
+
* This operation is applicable only to replica set instances. You can clone a standalone instance by [creating an instance from a backup set](~~55013~~). You can clone a sharded cluster instance by calling the [CreateShardingDBInstance](~~61884~~) operation.
|
|
8412
|
+
* > This operation overwrites the data of the current instance, and the data cannot be recovered. Proceed with caution.
|
|
8326
8413
|
*
|
|
8327
8414
|
* @param request RestoreDBInstanceRequest
|
|
8328
8415
|
* @param runtime runtime options for this request RuntimeOptions
|
|
@@ -8330,8 +8417,9 @@ export default class Client extends OpenApi {
|
|
|
8330
8417
|
*/
|
|
8331
8418
|
restoreDBInstanceWithOptions(request: RestoreDBInstanceRequest, runtime: $Util.RuntimeOptions): Promise<RestoreDBInstanceResponse>;
|
|
8332
8419
|
/**
|
|
8333
|
-
* This operation is
|
|
8334
|
-
*
|
|
8420
|
+
* This operation is no longer maintained and will be unavailable.
|
|
8421
|
+
* This operation is applicable only to replica set instances. You can clone a standalone instance by [creating an instance from a backup set](~~55013~~). You can clone a sharded cluster instance by calling the [CreateShardingDBInstance](~~61884~~) operation.
|
|
8422
|
+
* > This operation overwrites the data of the current instance, and the data cannot be recovered. Proceed with caution.
|
|
8335
8423
|
*
|
|
8336
8424
|
* @param request RestoreDBInstanceRequest
|
|
8337
8425
|
* @return RestoreDBInstanceResponse
|