@alicloud/dds20151201 8.4.0 → 8.4.1
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 +530 -428
- package/dist/client.js +563 -428
- package/dist/client.js.map +1 -1
- package/dist/models/AllocateDbinstanceSrvNetworkAddressRequest.d.ts +16 -0
- package/dist/models/AllocateDbinstanceSrvNetworkAddressRequest.js.map +1 -1
- package/dist/models/AllocateDbinstanceSrvNetworkAddressResponseBody.d.ts +3 -0
- package/dist/models/AllocateDbinstanceSrvNetworkAddressResponseBody.js.map +1 -1
- package/dist/models/AllocateNodePrivateNetworkAddressRequest.d.ts +8 -7
- package/dist/models/AllocateNodePrivateNetworkAddressRequest.js.map +1 -1
- package/dist/models/CancelActiveOperationTasksRequest.d.ts +5 -0
- package/dist/models/CancelActiveOperationTasksRequest.js.map +1 -1
- package/dist/models/CancelActiveOperationTasksResponseBody.d.ts +6 -0
- package/dist/models/CancelActiveOperationTasksResponseBody.js.map +1 -1
- package/dist/models/CheckCloudResourceAuthorizedResponseBody.d.ts +6 -4
- package/dist/models/CheckCloudResourceAuthorizedResponseBody.js.map +1 -1
- package/dist/models/CreateAccountRequest.d.ts +6 -4
- package/dist/models/CreateAccountRequest.js.map +1 -1
- package/dist/models/CreateBackupRequest.d.ts +22 -4
- package/dist/models/CreateBackupRequest.js.map +1 -1
- package/dist/models/CreateBackupResponseBody.d.ts +6 -1
- package/dist/models/CreateBackupResponseBody.js.map +1 -1
- package/dist/models/CreateDbinstanceRequest.d.ts +212 -139
- package/dist/models/CreateDbinstanceRequest.js.map +1 -1
- package/dist/models/CreateDbinstanceResponseBody.d.ts +3 -3
- package/dist/models/CreateGlobalSecurityIpgroupRequest.d.ts +5 -3
- package/dist/models/CreateGlobalSecurityIpgroupRequest.js.map +1 -1
- package/dist/models/CreateGlobalSecurityIpgroupResponseBody.d.ts +5 -3
- package/dist/models/CreateGlobalSecurityIpgroupResponseBody.js.map +1 -1
- package/dist/models/CreateNodeBatchRequest.d.ts +24 -8
- package/dist/models/CreateNodeBatchRequest.js.map +1 -1
- package/dist/models/CreateNodeRequest.d.ts +59 -34
- package/dist/models/CreateNodeRequest.js +6 -0
- package/dist/models/CreateNodeRequest.js.map +1 -1
- package/dist/models/CreateNodeRoleTagRequest.d.ts +7 -0
- package/dist/models/CreateNodeRoleTagRequest.js.map +1 -1
- package/dist/models/CreateNodeRoleTagResponseBody.d.ts +3 -0
- package/dist/models/CreateNodeRoleTagResponseBody.js.map +1 -1
- package/dist/models/CreateShardingDbinstanceRequest.d.ts +205 -157
- package/dist/models/CreateShardingDbinstanceRequest.js.map +1 -1
- package/dist/models/DeleteBackupRequest.d.ts +4 -0
- package/dist/models/DeleteBackupRequest.js.map +1 -1
- package/dist/models/DeleteBackupResponseBody.d.ts +3 -0
- package/dist/models/DeleteBackupResponseBody.js.map +1 -1
- package/dist/models/DeleteDbinstanceRequest.d.ts +1 -1
- package/dist/models/DeleteGlobalSecurityIpgroupRequest.d.ts +8 -6
- package/dist/models/DeleteGlobalSecurityIpgroupRequest.js.map +1 -1
- package/dist/models/DeleteGlobalSecurityIpgroupResponseBody.d.ts +1 -1
- package/dist/models/DescribeActiveOperationMaintenanceConfigResponseBody.d.ts +30 -17
- package/dist/models/DescribeActiveOperationMaintenanceConfigResponseBody.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskCountResponseBody.d.ts +3 -2
- package/dist/models/DescribeActiveOperationTaskCountResponseBody.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskRegionRequest.d.ts +10 -8
- package/dist/models/DescribeActiveOperationTaskRegionRequest.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskRegionResponseBody.d.ts +3 -3
- package/dist/models/DescribeActiveOperationTaskRequest.d.ts +4 -1
- package/dist/models/DescribeActiveOperationTaskRequest.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskResponseBody.d.ts +8 -0
- package/dist/models/DescribeActiveOperationTaskResponseBody.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskTypeRequest.d.ts +3 -2
- package/dist/models/DescribeActiveOperationTaskTypeRequest.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskTypeResponseBody.d.ts +4 -3
- package/dist/models/DescribeActiveOperationTaskTypeResponseBody.js.map +1 -1
- package/dist/models/DescribeActiveOperationTasksRequest.d.ts +55 -30
- package/dist/models/DescribeActiveOperationTasksRequest.js.map +1 -1
- package/dist/models/DescribeActiveOperationTasksResponseBody.d.ts +92 -56
- package/dist/models/DescribeActiveOperationTasksResponseBody.js.map +1 -1
- package/dist/models/DescribeAuditLogFilterRequest.d.ts +5 -3
- package/dist/models/DescribeAuditLogFilterRequest.js.map +1 -1
- package/dist/models/DescribeAuditLogFilterResponseBody.d.ts +13 -7
- package/dist/models/DescribeAuditLogFilterResponseBody.js.map +1 -1
- package/dist/models/DescribeAuditPolicyResponseBody.d.ts +5 -4
- package/dist/models/DescribeAuditPolicyResponseBody.js.map +1 -1
- package/dist/models/DescribeAuditRecordsRequest.d.ts +21 -20
- package/dist/models/DescribeAuditRecordsRequest.js.map +1 -1
- package/dist/models/DescribeAuditRecordsResponseBody.d.ts +3 -3
- package/dist/models/DescribeAvailabilityZonesRequest.d.ts +36 -23
- package/dist/models/DescribeAvailabilityZonesRequest.js.map +1 -1
- package/dist/models/DescribeAvailabilityZonesResponseBody.d.ts +3 -2
- package/dist/models/DescribeAvailabilityZonesResponseBody.js.map +1 -1
- package/dist/models/DescribeAvailableResourceRequest.d.ts +15 -9
- package/dist/models/DescribeAvailableResourceRequest.js.map +1 -1
- package/dist/models/DescribeBackupDbsRequest.d.ts +4 -4
- package/dist/models/DescribeBackupPolicyRequest.d.ts +5 -4
- package/dist/models/DescribeBackupPolicyRequest.js.map +1 -1
- package/dist/models/DescribeBackupPolicyResponseBody.d.ts +99 -56
- package/dist/models/DescribeBackupPolicyResponseBody.js.map +1 -1
- package/dist/models/DescribeBackupStorageRequest.d.ts +2 -2
- package/dist/models/DescribeBackupStorageResponseBody.d.ts +4 -4
- package/dist/models/DescribeBackupTasksRequest.d.ts +2 -2
- package/dist/models/DescribeBackupTasksResponseBody.d.ts +15 -11
- package/dist/models/DescribeBackupTasksResponseBody.js.map +1 -1
- package/dist/models/DescribeBackupsRequest.d.ts +30 -17
- package/dist/models/DescribeBackupsRequest.js.map +1 -1
- package/dist/models/DescribeBackupsResponseBody.d.ts +8 -6
- package/dist/models/DescribeBackupsResponseBody.js.map +1 -1
- package/dist/models/DescribeBinlogFilesRequest.d.ts +48 -0
- package/dist/models/DescribeBinlogFilesRequest.js.map +1 -1
- package/dist/models/DescribeBinlogFilesResponseBody.d.ts +12 -0
- package/dist/models/DescribeBinlogFilesResponseBody.js.map +1 -1
- package/dist/models/DescribeClusterBackupsRequest.d.ts +29 -18
- package/dist/models/DescribeClusterBackupsRequest.js.map +1 -1
- package/dist/models/DescribeClusterBackupsResponseBody.d.ts +76 -50
- package/dist/models/DescribeClusterBackupsResponseBody.js.map +1 -1
- package/dist/models/DescribeClusterRecoverTimeRequest.d.ts +23 -1
- package/dist/models/DescribeClusterRecoverTimeRequest.js +2 -0
- package/dist/models/DescribeClusterRecoverTimeRequest.js.map +1 -1
- package/dist/models/DescribeClusterRecoverTimeResponseBody.d.ts +5 -6
- package/dist/models/DescribeClusterRecoverTimeResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceAttributeRequest.d.ts +8 -7
- package/dist/models/DescribeDbinstanceAttributeRequest.js.map +1 -1
- package/dist/models/DescribeDbinstanceAttributeResponseBody.d.ts +33 -1
- package/dist/models/DescribeDbinstanceAttributeResponseBody.js +57 -1
- package/dist/models/DescribeDbinstanceAttributeResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceEncryptionKeyResponseBody.d.ts +3 -2
- package/dist/models/DescribeDbinstanceEncryptionKeyResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstancePerformanceRequest.d.ts +26 -15
- package/dist/models/DescribeDbinstancePerformanceRequest.js.map +1 -1
- package/dist/models/DescribeDbinstancePerformanceResponseBody.d.ts +2 -2
- package/dist/models/DescribeDbinstanceSpecInfoRequest.d.ts +10 -0
- package/dist/models/DescribeDbinstanceSpecInfoRequest.js.map +1 -1
- package/dist/models/DescribeDbinstanceSpecInfoResponseBody.d.ts +16 -0
- package/dist/models/DescribeDbinstanceSpecInfoResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceSslresponseBody.d.ts +16 -4
- package/dist/models/DescribeDbinstanceSslresponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceSwitchLogResponseBody.d.ts +12 -7
- package/dist/models/DescribeDbinstanceSwitchLogResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceTdeinfoResponseBody.d.ts +16 -15
- package/dist/models/DescribeDbinstanceTdeinfoResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstancesOverviewRequest.d.ts +38 -26
- package/dist/models/DescribeDbinstancesOverviewRequest.js.map +1 -1
- package/dist/models/DescribeDbinstancesOverviewResponseBody.d.ts +82 -58
- package/dist/models/DescribeDbinstancesOverviewResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstancesRequest.d.ts +78 -51
- package/dist/models/DescribeDbinstancesRequest.js.map +1 -1
- package/dist/models/DescribeDbinstancesResponseBody.d.ts +3 -3
- package/dist/models/DescribeErrorLogRecordsRequest.d.ts +9 -7
- package/dist/models/DescribeErrorLogRecordsRequest.js.map +1 -1
- package/dist/models/DescribeGlobalSecurityIpgroupRelationRequest.d.ts +1 -1
- package/dist/models/DescribeGlobalSecurityIpgroupRelationResponseBody.d.ts +6 -6
- package/dist/models/DescribeHistoryTasksRequest.d.ts +58 -30
- package/dist/models/DescribeHistoryTasksRequest.js.map +1 -1
- package/dist/models/DescribeHistoryTasksResponseBody.d.ts +85 -53
- package/dist/models/DescribeHistoryTasksResponseBody.js.map +1 -1
- package/dist/models/DescribeInstanceAutoRenewalAttributeRequest.d.ts +4 -3
- package/dist/models/DescribeInstanceAutoRenewalAttributeRequest.js.map +1 -1
- package/dist/models/DescribeInstanceRecoverTimeRequest.d.ts +22 -0
- package/dist/models/DescribeInstanceRecoverTimeRequest.js +2 -0
- package/dist/models/DescribeInstanceRecoverTimeRequest.js.map +1 -1
- package/dist/models/DescribeInstanceRecoverTimeResponseBody.d.ts +5 -6
- package/dist/models/DescribeInstanceRecoverTimeResponseBody.js.map +1 -1
- package/dist/models/DescribeKernelReleaseNotesRequest.d.ts +1 -1
- package/dist/models/DescribeMongoDblogConfigRequest.d.ts +1 -1
- package/dist/models/DescribeMongoDblogConfigResponseBody.d.ts +39 -19
- package/dist/models/DescribeMongoDblogConfigResponseBody.js.map +1 -1
- package/dist/models/DescribeParameterModificationHistoryRequest.d.ts +11 -8
- package/dist/models/DescribeParameterModificationHistoryRequest.js.map +1 -1
- package/dist/models/DescribeParameterTemplatesRequest.d.ts +22 -14
- package/dist/models/DescribeParameterTemplatesRequest.js.map +1 -1
- package/dist/models/DescribeParameterTemplatesResponseBody.d.ts +4 -4
- package/dist/models/DescribeParametersRequest.d.ts +7 -5
- package/dist/models/DescribeParametersRequest.js.map +1 -1
- package/dist/models/DescribePriceRequest.d.ts +37 -25
- package/dist/models/DescribePriceRequest.js.map +1 -1
- package/dist/models/DescribePriceResponseBody.d.ts +32 -25
- package/dist/models/DescribePriceResponseBody.js.map +1 -1
- package/dist/models/DescribeRdsVpcsRequest.d.ts +6 -0
- package/dist/models/DescribeRdsVpcsRequest.js.map +1 -1
- package/dist/models/DescribeRdsVpcsResponseBody.d.ts +73 -2
- package/dist/models/DescribeRdsVpcsResponseBody.js.map +1 -1
- package/dist/models/DescribeRdsVswitchsRequest.d.ts +9 -0
- package/dist/models/DescribeRdsVswitchsRequest.js.map +1 -1
- package/dist/models/DescribeRdsVswitchsResponseBody.d.ts +46 -1
- package/dist/models/DescribeRdsVswitchsResponseBody.js.map +1 -1
- package/dist/models/DescribeRegionsRequest.d.ts +4 -3
- package/dist/models/DescribeRegionsRequest.js.map +1 -1
- package/dist/models/DescribeRenewalPriceRequest.d.ts +8 -4
- package/dist/models/DescribeRenewalPriceRequest.js.map +1 -1
- package/dist/models/DescribeRenewalPriceResponseBody.d.ts +22 -9
- package/dist/models/DescribeRenewalPriceResponseBody.js.map +1 -1
- package/dist/models/DescribeReplicaSetRoleResponseBody.d.ts +11 -0
- package/dist/models/DescribeReplicaSetRoleResponseBody.js.map +1 -1
- package/dist/models/DescribeRestoreDbinstanceListRequest.d.ts +2 -2
- package/dist/models/DescribeRoleTagStatusRequest.d.ts +2 -0
- package/dist/models/DescribeRoleTagStatusRequest.js.map +1 -1
- package/dist/models/DescribeRoleTagStatusResponseBody.d.ts +19 -0
- package/dist/models/DescribeRoleTagStatusResponseBody.js.map +1 -1
- package/dist/models/DescribeRunningLogRecordsRequest.d.ts +19 -20
- package/dist/models/DescribeRunningLogRecordsRequest.js.map +1 -1
- package/dist/models/DescribeRunningLogRecordsResponseBody.d.ts +4 -4
- package/dist/models/DescribeShardingNetworkAddressRequest.d.ts +15 -2
- package/dist/models/DescribeShardingNetworkAddressRequest.js.map +1 -1
- package/dist/models/DescribeShardingNetworkAddressResponseBody.d.ts +7 -0
- package/dist/models/DescribeShardingNetworkAddressResponseBody.js.map +1 -1
- package/dist/models/DescribeSlowLogRecordsRequest.d.ts +8 -6
- package/dist/models/DescribeSlowLogRecordsRequest.js.map +1 -1
- package/dist/models/DescribeTagsRequest.d.ts +1 -1
- package/dist/models/DescribeTagsResponseBody.d.ts +5 -2
- package/dist/models/DescribeTagsResponseBody.js.map +1 -1
- package/dist/models/DescribeUserEncryptionKeyListRequest.d.ts +13 -2
- package/dist/models/DescribeUserEncryptionKeyListRequest.js.map +1 -1
- package/dist/models/DescribeUserEncryptionKeyListResponseBody.d.ts +1 -1
- package/dist/models/DescribeVpcsForMongoDbrequest.d.ts +15 -0
- package/dist/models/DescribeVpcsForMongoDbrequest.js.map +1 -1
- package/dist/models/DescribeVpcsForMongoDbresponseBody.d.ts +80 -2
- package/dist/models/DescribeVpcsForMongoDbresponseBody.js.map +1 -1
- package/dist/models/EvaluateResourceRequest.d.ts +51 -37
- package/dist/models/EvaluateResourceRequest.js.map +1 -1
- package/dist/models/EvaluateResourceResponseBody.d.ts +7 -6
- package/dist/models/EvaluateResourceResponseBody.js.map +1 -1
- package/dist/models/ListTagResourcesRequest.d.ts +4 -4
- package/dist/models/ListTagResourcesResponseBody.d.ts +1 -1
- package/dist/models/MigrateAvailableZoneRequest.d.ts +5 -4
- package/dist/models/MigrateAvailableZoneRequest.js.map +1 -1
- package/dist/models/MigrateToOtherZoneRequest.d.ts +8 -6
- package/dist/models/MigrateToOtherZoneRequest.js.map +1 -1
- package/dist/models/ModifyAccountDescriptionRequest.d.ts +9 -6
- package/dist/models/ModifyAccountDescriptionRequest.js.map +1 -1
- package/dist/models/ModifyActiveOperationMaintenanceConfigRequest.d.ts +27 -0
- package/dist/models/ModifyActiveOperationMaintenanceConfigRequest.js.map +1 -1
- package/dist/models/ModifyActiveOperationMaintenanceConfigResponseBody.d.ts +3 -0
- package/dist/models/ModifyActiveOperationMaintenanceConfigResponseBody.js.map +1 -1
- package/dist/models/ModifyAuditLogFilterRequest.d.ts +16 -9
- package/dist/models/ModifyAuditLogFilterRequest.js.map +1 -1
- package/dist/models/ModifyAuditPolicyRequest.d.ts +24 -9
- package/dist/models/ModifyAuditPolicyRequest.js.map +1 -1
- package/dist/models/ModifyBackupExpireTimeRequest.d.ts +13 -0
- package/dist/models/ModifyBackupExpireTimeRequest.js.map +1 -1
- package/dist/models/ModifyBackupExpireTimeResponseBody.d.ts +15 -0
- package/dist/models/ModifyBackupExpireTimeResponseBody.js.map +1 -1
- package/dist/models/ModifyBackupPolicyRequest.d.ts +128 -93
- package/dist/models/ModifyBackupPolicyRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceAttributeRequest.d.ts +9 -0
- package/dist/models/ModifyDbinstanceAttributeRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceAttributeResponseBody.d.ts +3 -0
- package/dist/models/ModifyDbinstanceAttributeResponseBody.js.map +1 -1
- package/dist/models/ModifyDbinstanceConfigRequest.d.ts +6 -0
- package/dist/models/ModifyDbinstanceConfigRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceConfigResponseBody.d.ts +3 -0
- package/dist/models/ModifyDbinstanceConfigResponseBody.js.map +1 -1
- package/dist/models/ModifyDbinstanceConnectionStringRequest.d.ts +17 -9
- package/dist/models/ModifyDbinstanceConnectionStringRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceConnectionStringResponseBody.d.ts +1 -1
- package/dist/models/ModifyDbinstanceDescriptionRequest.d.ts +5 -5
- package/dist/models/ModifyDbinstanceDiskTypeRequest.d.ts +28 -16
- package/dist/models/ModifyDbinstanceDiskTypeRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceMaintainTimeRequest.d.ts +1 -1
- package/dist/models/ModifyDbinstanceNetworkTypeRequest.d.ts +14 -20
- package/dist/models/ModifyDbinstanceNetworkTypeRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceSpecRequest.d.ts +125 -42
- package/dist/models/ModifyDbinstanceSpecRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceSpecResponseBody.d.ts +2 -2
- package/dist/models/ModifyDbinstanceSslrequest.d.ts +39 -5
- package/dist/models/ModifyDbinstanceSslrequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceSslresponseBody.d.ts +1 -1
- package/dist/models/ModifyDbinstanceTderequest.d.ts +33 -7
- package/dist/models/ModifyDbinstanceTderequest.js.map +1 -1
- package/dist/models/ModifyGlobalSecurityIpgroupNameRequest.d.ts +5 -3
- package/dist/models/ModifyGlobalSecurityIpgroupNameRequest.js.map +1 -1
- package/dist/models/ModifyInstanceVpcAuthModeRequest.d.ts +2 -2
- package/dist/models/ModifyNodeSpecBatchRequest.d.ts +114 -19
- package/dist/models/ModifyNodeSpecBatchRequest.js.map +1 -1
- package/dist/models/ModifyNodeSpecRequest.d.ts +75 -22
- package/dist/models/ModifyNodeSpecRequest.js.map +1 -1
- package/dist/models/ModifyNodeSpecResponseBody.d.ts +2 -2
- package/dist/models/ModifyParametersRequest.d.ts +23 -10
- package/dist/models/ModifyParametersRequest.js.map +1 -1
- package/dist/models/ModifySecurityGroupConfigurationRequest.d.ts +3 -2
- package/dist/models/ModifySecurityGroupConfigurationRequest.js.map +1 -1
- package/dist/models/ModifySecurityIpsRequest.d.ts +8 -5
- package/dist/models/ModifySecurityIpsRequest.js.map +1 -1
- package/dist/models/ModifySrvNetworkAddressRequest.d.ts +20 -0
- package/dist/models/ModifySrvNetworkAddressRequest.js.map +1 -1
- package/dist/models/ModifySrvNetworkAddressResponseBody.d.ts +3 -0
- package/dist/models/ModifySrvNetworkAddressResponseBody.js.map +1 -1
- package/dist/models/ReleaseNodePrivateNetworkAddressRequest.d.ts +17 -9
- package/dist/models/ReleaseNodePrivateNetworkAddressRequest.js.map +1 -1
- package/dist/models/ReleasePublicNetworkAddressRequest.d.ts +8 -6
- package/dist/models/ReleasePublicNetworkAddressRequest.js.map +1 -1
- package/dist/models/RenewDbinstanceRequest.d.ts +10 -7
- package/dist/models/RenewDbinstanceRequest.js.map +1 -1
- package/dist/models/ResetAccountPasswordRequest.d.ts +6 -4
- package/dist/models/ResetAccountPasswordRequest.js.map +1 -1
- package/dist/models/RestartDbinstanceRequest.d.ts +14 -2
- package/dist/models/RestartDbinstanceRequest.js +2 -0
- package/dist/models/RestartDbinstanceRequest.js.map +1 -1
- package/dist/models/RestartNodeRequest.d.ts +19 -5
- package/dist/models/RestartNodeRequest.js.map +1 -1
- package/dist/models/SwitchDbinstanceHarequest.d.ts +5 -4
- package/dist/models/SwitchDbinstanceHarequest.js.map +1 -1
- package/dist/models/TagResourcesRequest.d.ts +4 -2
- package/dist/models/TagResourcesRequest.js.map +1 -1
- package/dist/models/TransformInstanceChargeTypeRequest.d.ts +17 -13
- package/dist/models/TransformInstanceChargeTypeRequest.js.map +1 -1
- package/dist/models/TransformToPrePaidRequest.d.ts +9 -7
- package/dist/models/TransformToPrePaidRequest.js.map +1 -1
- package/dist/models/UntagResourcesRequest.d.ts +8 -4
- package/dist/models/UntagResourcesRequest.js.map +1 -1
- package/dist/models/UpgradeDbinstanceEngineVersionRequest.d.ts +4 -3
- package/dist/models/UpgradeDbinstanceEngineVersionRequest.js.map +1 -1
- package/dist/models/model.d.ts +2 -0
- package/dist/models/model.js +21 -17
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +575 -434
- package/src/models/AllocateDbinstanceSrvNetworkAddressRequest.ts +16 -0
- package/src/models/AllocateDbinstanceSrvNetworkAddressResponseBody.ts +3 -0
- package/src/models/AllocateNodePrivateNetworkAddressRequest.ts +9 -8
- package/src/models/CancelActiveOperationTasksRequest.ts +5 -0
- package/src/models/CancelActiveOperationTasksResponseBody.ts +6 -0
- package/src/models/CheckCloudResourceAuthorizedResponseBody.ts +6 -4
- package/src/models/CreateAccountRequest.ts +6 -4
- package/src/models/CreateBackupRequest.ts +22 -4
- package/src/models/CreateBackupResponseBody.ts +6 -1
- package/src/models/CreateDbinstanceRequest.ts +212 -139
- package/src/models/CreateDbinstanceResponseBody.ts +3 -3
- package/src/models/CreateGlobalSecurityIpgroupRequest.ts +5 -3
- package/src/models/CreateGlobalSecurityIpgroupResponseBody.ts +5 -3
- package/src/models/CreateNodeBatchRequest.ts +33 -17
- package/src/models/CreateNodeRequest.ts +65 -34
- package/src/models/CreateNodeRoleTagRequest.ts +7 -0
- package/src/models/CreateNodeRoleTagResponseBody.ts +3 -0
- package/src/models/CreateShardingDbinstanceRequest.ts +208 -160
- package/src/models/DeleteBackupRequest.ts +4 -0
- package/src/models/DeleteBackupResponseBody.ts +3 -0
- package/src/models/DeleteDbinstanceRequest.ts +1 -1
- package/src/models/DeleteGlobalSecurityIpgroupRequest.ts +8 -6
- package/src/models/DeleteGlobalSecurityIpgroupResponseBody.ts +1 -1
- package/src/models/DescribeActiveOperationMaintenanceConfigResponseBody.ts +30 -17
- package/src/models/DescribeActiveOperationTaskCountResponseBody.ts +3 -2
- package/src/models/DescribeActiveOperationTaskRegionRequest.ts +10 -8
- package/src/models/DescribeActiveOperationTaskRegionResponseBody.ts +3 -3
- package/src/models/DescribeActiveOperationTaskRequest.ts +5 -2
- package/src/models/DescribeActiveOperationTaskResponseBody.ts +8 -0
- package/src/models/DescribeActiveOperationTaskTypeRequest.ts +3 -2
- package/src/models/DescribeActiveOperationTaskTypeResponseBody.ts +4 -3
- package/src/models/DescribeActiveOperationTasksRequest.ts +55 -30
- package/src/models/DescribeActiveOperationTasksResponseBody.ts +92 -56
- package/src/models/DescribeAuditLogFilterRequest.ts +5 -3
- package/src/models/DescribeAuditLogFilterResponseBody.ts +13 -7
- package/src/models/DescribeAuditPolicyResponseBody.ts +5 -4
- package/src/models/DescribeAuditRecordsRequest.ts +21 -20
- package/src/models/DescribeAuditRecordsResponseBody.ts +3 -3
- package/src/models/DescribeAvailabilityZonesRequest.ts +36 -23
- package/src/models/DescribeAvailabilityZonesResponseBody.ts +3 -2
- package/src/models/DescribeAvailableResourceRequest.ts +15 -9
- package/src/models/DescribeBackupDbsRequest.ts +6 -6
- package/src/models/DescribeBackupPolicyRequest.ts +5 -4
- package/src/models/DescribeBackupPolicyResponseBody.ts +100 -57
- package/src/models/DescribeBackupStorageRequest.ts +2 -2
- package/src/models/DescribeBackupStorageResponseBody.ts +4 -4
- package/src/models/DescribeBackupTasksRequest.ts +2 -2
- package/src/models/DescribeBackupTasksResponseBody.ts +15 -11
- package/src/models/DescribeBackupsRequest.ts +30 -17
- package/src/models/DescribeBackupsResponseBody.ts +8 -6
- package/src/models/DescribeBinlogFilesRequest.ts +48 -0
- package/src/models/DescribeBinlogFilesResponseBody.ts +12 -0
- package/src/models/DescribeClusterBackupsRequest.ts +30 -19
- package/src/models/DescribeClusterBackupsResponseBody.ts +76 -50
- package/src/models/DescribeClusterRecoverTimeRequest.ts +25 -1
- package/src/models/DescribeClusterRecoverTimeResponseBody.ts +5 -6
- package/src/models/DescribeDbinstanceAttributeRequest.ts +8 -7
- package/src/models/DescribeDbinstanceAttributeResponseBody.ts +71 -1
- package/src/models/DescribeDbinstanceEncryptionKeyResponseBody.ts +3 -2
- package/src/models/DescribeDbinstancePerformanceRequest.ts +26 -15
- package/src/models/DescribeDbinstancePerformanceResponseBody.ts +2 -2
- package/src/models/DescribeDbinstanceSpecInfoRequest.ts +10 -0
- package/src/models/DescribeDbinstanceSpecInfoResponseBody.ts +16 -0
- package/src/models/DescribeDbinstanceSslresponseBody.ts +16 -4
- package/src/models/DescribeDbinstanceSwitchLogResponseBody.ts +12 -7
- package/src/models/DescribeDbinstanceTdeinfoResponseBody.ts +16 -15
- package/src/models/DescribeDbinstancesOverviewRequest.ts +39 -27
- package/src/models/DescribeDbinstancesOverviewResponseBody.ts +83 -59
- package/src/models/DescribeDbinstancesRequest.ts +78 -51
- package/src/models/DescribeDbinstancesResponseBody.ts +3 -3
- package/src/models/DescribeErrorLogRecordsRequest.ts +9 -7
- package/src/models/DescribeGlobalSecurityIpgroupRelationRequest.ts +1 -1
- package/src/models/DescribeGlobalSecurityIpgroupRelationResponseBody.ts +6 -6
- package/src/models/DescribeHistoryTasksRequest.ts +58 -30
- package/src/models/DescribeHistoryTasksResponseBody.ts +85 -53
- package/src/models/DescribeInstanceAutoRenewalAttributeRequest.ts +4 -3
- package/src/models/DescribeInstanceRecoverTimeRequest.ts +24 -0
- package/src/models/DescribeInstanceRecoverTimeResponseBody.ts +5 -6
- package/src/models/DescribeKernelReleaseNotesRequest.ts +1 -1
- package/src/models/DescribeMongoDblogConfigRequest.ts +1 -1
- package/src/models/DescribeMongoDblogConfigResponseBody.ts +39 -19
- package/src/models/DescribeParameterModificationHistoryRequest.ts +11 -8
- package/src/models/DescribeParameterTemplatesRequest.ts +22 -14
- package/src/models/DescribeParameterTemplatesResponseBody.ts +4 -4
- package/src/models/DescribeParametersRequest.ts +7 -5
- package/src/models/DescribePriceRequest.ts +37 -25
- package/src/models/DescribePriceResponseBody.ts +32 -25
- package/src/models/DescribeRdsVpcsRequest.ts +6 -0
- package/src/models/DescribeRdsVpcsResponseBody.ts +73 -2
- package/src/models/DescribeRdsVswitchsRequest.ts +9 -0
- package/src/models/DescribeRdsVswitchsResponseBody.ts +46 -1
- package/src/models/DescribeRegionsRequest.ts +4 -3
- package/src/models/DescribeRenewalPriceRequest.ts +8 -4
- package/src/models/DescribeRenewalPriceResponseBody.ts +22 -9
- package/src/models/DescribeReplicaSetRoleResponseBody.ts +11 -0
- package/src/models/DescribeRestoreDbinstanceListRequest.ts +2 -2
- package/src/models/DescribeRoleTagStatusRequest.ts +2 -0
- package/src/models/DescribeRoleTagStatusResponseBody.ts +19 -0
- package/src/models/DescribeRunningLogRecordsRequest.ts +19 -20
- package/src/models/DescribeRunningLogRecordsResponseBody.ts +4 -4
- package/src/models/DescribeShardingNetworkAddressRequest.ts +15 -2
- package/src/models/DescribeShardingNetworkAddressResponseBody.ts +7 -0
- package/src/models/DescribeSlowLogRecordsRequest.ts +9 -7
- package/src/models/DescribeTagsRequest.ts +1 -1
- package/src/models/DescribeTagsResponseBody.ts +5 -2
- package/src/models/DescribeUserEncryptionKeyListRequest.ts +13 -2
- package/src/models/DescribeUserEncryptionKeyListResponseBody.ts +1 -1
- package/src/models/DescribeVpcsForMongoDbrequest.ts +15 -0
- package/src/models/DescribeVpcsForMongoDbresponseBody.ts +80 -2
- package/src/models/EvaluateResourceRequest.ts +51 -37
- package/src/models/EvaluateResourceResponseBody.ts +7 -6
- package/src/models/ListTagResourcesRequest.ts +4 -4
- package/src/models/ListTagResourcesResponseBody.ts +1 -1
- package/src/models/MigrateAvailableZoneRequest.ts +6 -5
- package/src/models/MigrateToOtherZoneRequest.ts +8 -6
- package/src/models/ModifyAccountDescriptionRequest.ts +9 -6
- package/src/models/ModifyActiveOperationMaintenanceConfigRequest.ts +27 -0
- package/src/models/ModifyActiveOperationMaintenanceConfigResponseBody.ts +3 -0
- package/src/models/ModifyAuditLogFilterRequest.ts +16 -9
- package/src/models/ModifyAuditPolicyRequest.ts +24 -9
- package/src/models/ModifyBackupExpireTimeRequest.ts +13 -0
- package/src/models/ModifyBackupExpireTimeResponseBody.ts +15 -0
- package/src/models/ModifyBackupPolicyRequest.ts +130 -95
- package/src/models/ModifyDbinstanceAttributeRequest.ts +9 -0
- package/src/models/ModifyDbinstanceAttributeResponseBody.ts +3 -0
- package/src/models/ModifyDbinstanceConfigRequest.ts +6 -0
- package/src/models/ModifyDbinstanceConfigResponseBody.ts +3 -0
- package/src/models/ModifyDbinstanceConnectionStringRequest.ts +17 -9
- package/src/models/ModifyDbinstanceConnectionStringResponseBody.ts +1 -1
- package/src/models/ModifyDbinstanceDescriptionRequest.ts +6 -6
- package/src/models/ModifyDbinstanceDiskTypeRequest.ts +28 -16
- package/src/models/ModifyDbinstanceMaintainTimeRequest.ts +1 -1
- package/src/models/ModifyDbinstanceNetworkTypeRequest.ts +14 -20
- package/src/models/ModifyDbinstanceSpecRequest.ts +125 -42
- package/src/models/ModifyDbinstanceSpecResponseBody.ts +2 -2
- package/src/models/ModifyDbinstanceSslrequest.ts +39 -5
- package/src/models/ModifyDbinstanceSslresponseBody.ts +1 -1
- package/src/models/ModifyDbinstanceTderequest.ts +33 -7
- package/src/models/ModifyGlobalSecurityIpgroupNameRequest.ts +5 -3
- package/src/models/ModifyInstanceVpcAuthModeRequest.ts +2 -2
- package/src/models/ModifyNodeSpecBatchRequest.ts +114 -19
- package/src/models/ModifyNodeSpecRequest.ts +75 -22
- package/src/models/ModifyNodeSpecResponseBody.ts +2 -2
- package/src/models/ModifyParametersRequest.ts +23 -10
- package/src/models/ModifySecurityGroupConfigurationRequest.ts +3 -2
- package/src/models/ModifySecurityIpsRequest.ts +8 -5
- package/src/models/ModifySrvNetworkAddressRequest.ts +20 -0
- package/src/models/ModifySrvNetworkAddressResponseBody.ts +3 -0
- package/src/models/ReleaseNodePrivateNetworkAddressRequest.ts +17 -9
- package/src/models/ReleasePublicNetworkAddressRequest.ts +8 -6
- package/src/models/RenewDbinstanceRequest.ts +10 -7
- package/src/models/ResetAccountPasswordRequest.ts +6 -4
- package/src/models/RestartDbinstanceRequest.ts +16 -2
- package/src/models/RestartNodeRequest.ts +19 -5
- package/src/models/SwitchDbinstanceHarequest.ts +6 -5
- package/src/models/TagResourcesRequest.ts +4 -2
- package/src/models/TransformInstanceChargeTypeRequest.ts +17 -13
- package/src/models/TransformToPrePaidRequest.ts +9 -7
- package/src/models/UntagResourcesRequest.ts +9 -5
- package/src/models/UpgradeDbinstanceEngineVersionRequest.ts +4 -3
- package/src/models/model.ts +2 -0
package/dist/client.d.ts
CHANGED
|
@@ -9,7 +9,10 @@ export default class Client extends OpenApi {
|
|
|
9
9
|
[key: string]: string;
|
|
10
10
|
}, endpoint: string): string;
|
|
11
11
|
/**
|
|
12
|
-
* Applies for an SRV
|
|
12
|
+
* Applies for an SRV connection string for an ApsaraDB for MongoDB instance.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* Applicable only to cloud disk-based replica set and sharded cluster instances.
|
|
13
16
|
*
|
|
14
17
|
* @param request - AllocateDBInstanceSrvNetworkAddressRequest
|
|
15
18
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -17,7 +20,10 @@ export default class Client extends OpenApi {
|
|
|
17
20
|
*/
|
|
18
21
|
allocateDBInstanceSrvNetworkAddressWithOptions(request: $_model.AllocateDBInstanceSrvNetworkAddressRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AllocateDBInstanceSrvNetworkAddressResponse>;
|
|
19
22
|
/**
|
|
20
|
-
* Applies for an SRV
|
|
23
|
+
* Applies for an SRV connection string for an ApsaraDB for MongoDB instance.
|
|
24
|
+
*
|
|
25
|
+
* @remarks
|
|
26
|
+
* Applicable only to cloud disk-based replica set and sharded cluster instances.
|
|
21
27
|
*
|
|
22
28
|
* @param request - AllocateDBInstanceSrvNetworkAddressRequest
|
|
23
29
|
* @returns AllocateDBInstanceSrvNetworkAddressResponse
|
|
@@ -28,7 +34,7 @@ export default class Client extends OpenApi {
|
|
|
28
34
|
*
|
|
29
35
|
* @remarks
|
|
30
36
|
* This operation is applicable only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](https://help.aliyun.com/document_detail/134037.html).
|
|
31
|
-
* >
|
|
37
|
+
* > The allocated endpoints can be used only for internal access. To gain Internet access, you must call the [AllocatePublicNetworkAddress](https://help.aliyun.com/document_detail/67602.html) operation to apply for public endpoints.
|
|
32
38
|
*
|
|
33
39
|
* @param request - AllocateNodePrivateNetworkAddressRequest
|
|
34
40
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -40,7 +46,7 @@ export default class Client extends OpenApi {
|
|
|
40
46
|
*
|
|
41
47
|
* @remarks
|
|
42
48
|
* This operation is applicable only to sharded cluster instances. For more information, see [Apply for an endpoint for a shard or Configserver node](https://help.aliyun.com/document_detail/134037.html).
|
|
43
|
-
* >
|
|
49
|
+
* > The allocated endpoints can be used only for internal access. To gain Internet access, you must call the [AllocatePublicNetworkAddress](https://help.aliyun.com/document_detail/67602.html) operation to apply for public endpoints.
|
|
44
50
|
*
|
|
45
51
|
* @param request - AllocateNodePrivateNetworkAddressRequest
|
|
46
52
|
* @returns AllocateNodePrivateNetworkAddressResponse
|
|
@@ -62,12 +68,28 @@ export default class Client extends OpenApi {
|
|
|
62
68
|
*/
|
|
63
69
|
allocatePublicNetworkAddress(request: $_model.AllocatePublicNetworkAddressRequest): Promise<$_model.AllocatePublicNetworkAddressResponse>;
|
|
64
70
|
/**
|
|
71
|
+
* Cancels Operations and Maintenance (O&M) events in a batch.
|
|
72
|
+
*
|
|
73
|
+
* @remarks
|
|
74
|
+
* An O\\&M event cannot be canceled in the following scenarios:
|
|
75
|
+
* - The event is not cancelable if the value of the AllowCancel parameter is 0.
|
|
76
|
+
* - The scheduled start time of the O\\&M event has passed.
|
|
77
|
+
* - The status of the O\\&M event is not Pending if the value of the Status parameter is not 3.
|
|
78
|
+
*
|
|
65
79
|
* @param request - CancelActiveOperationTasksRequest
|
|
66
80
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
67
81
|
* @returns CancelActiveOperationTasksResponse
|
|
68
82
|
*/
|
|
69
83
|
cancelActiveOperationTasksWithOptions(request: $_model.CancelActiveOperationTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelActiveOperationTasksResponse>;
|
|
70
84
|
/**
|
|
85
|
+
* Cancels Operations and Maintenance (O&M) events in a batch.
|
|
86
|
+
*
|
|
87
|
+
* @remarks
|
|
88
|
+
* An O\\&M event cannot be canceled in the following scenarios:
|
|
89
|
+
* - The event is not cancelable if the value of the AllowCancel parameter is 0.
|
|
90
|
+
* - The scheduled start time of the O\\&M event has passed.
|
|
91
|
+
* - The status of the O\\&M event is not Pending if the value of the Status parameter is not 3.
|
|
92
|
+
*
|
|
71
93
|
* @param request - CancelActiveOperationTasksRequest
|
|
72
94
|
* @returns CancelActiveOperationTasksResponse
|
|
73
95
|
*/
|
|
@@ -135,8 +157,8 @@ export default class Client extends OpenApi {
|
|
|
135
157
|
* Creates an account that is granted read-only permissions for shard nodes in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
136
158
|
*
|
|
137
159
|
* @remarks
|
|
138
|
-
*
|
|
139
|
-
*
|
|
160
|
+
* - You can create an account for shard nodes only in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
161
|
+
* - The account is granted read-only permissions.
|
|
140
162
|
*
|
|
141
163
|
* @param request - CreateAccountRequest
|
|
142
164
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -147,18 +169,18 @@ export default class Client extends OpenApi {
|
|
|
147
169
|
* Creates an account that is granted read-only permissions for shard nodes in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
148
170
|
*
|
|
149
171
|
* @remarks
|
|
150
|
-
*
|
|
151
|
-
*
|
|
172
|
+
* - You can create an account for shard nodes only in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
173
|
+
* - The account is granted read-only permissions.
|
|
152
174
|
*
|
|
153
175
|
* @param request - CreateAccountRequest
|
|
154
176
|
* @returns CreateAccountResponse
|
|
155
177
|
*/
|
|
156
178
|
createAccount(request: $_model.CreateAccountRequest): Promise<$_model.CreateAccountResponse>;
|
|
157
179
|
/**
|
|
158
|
-
* Creates a backup
|
|
180
|
+
* Creates a backup for a MongoDB instance.
|
|
159
181
|
*
|
|
160
182
|
* @remarks
|
|
161
|
-
*
|
|
183
|
+
* The instance must be in the Running state.
|
|
162
184
|
*
|
|
163
185
|
* @param request - CreateBackupRequest
|
|
164
186
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -166,10 +188,10 @@ export default class Client extends OpenApi {
|
|
|
166
188
|
*/
|
|
167
189
|
createBackupWithOptions(request: $_model.CreateBackupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateBackupResponse>;
|
|
168
190
|
/**
|
|
169
|
-
* Creates a backup
|
|
191
|
+
* Creates a backup for a MongoDB instance.
|
|
170
192
|
*
|
|
171
193
|
* @remarks
|
|
172
|
-
*
|
|
194
|
+
* The instance must be in the Running state.
|
|
173
195
|
*
|
|
174
196
|
* @param request - CreateBackupRequest
|
|
175
197
|
* @returns CreateBackupResponse
|
|
@@ -179,9 +201,9 @@ export default class Client extends OpenApi {
|
|
|
179
201
|
* Creates or clones an ApsaraDB for MongoDB replica set instance.
|
|
180
202
|
*
|
|
181
203
|
* @remarks
|
|
182
|
-
*
|
|
183
|
-
* For more information about the instance types of ApsaraDB for MongoDB
|
|
184
|
-
* To create sharded cluster
|
|
204
|
+
* Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
205
|
+
* For more information about the instance types of ApsaraDB for MongoDB, see [Instance types]().
|
|
206
|
+
* To create a sharded cluster instance, call the [CreateShardingDBInstance]() operation.
|
|
185
207
|
*
|
|
186
208
|
* @param request - CreateDBInstanceRequest
|
|
187
209
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -192,9 +214,9 @@ export default class Client extends OpenApi {
|
|
|
192
214
|
* Creates or clones an ApsaraDB for MongoDB replica set instance.
|
|
193
215
|
*
|
|
194
216
|
* @remarks
|
|
195
|
-
*
|
|
196
|
-
* For more information about the instance types of ApsaraDB for MongoDB
|
|
197
|
-
* To create sharded cluster
|
|
217
|
+
* Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
218
|
+
* For more information about the instance types of ApsaraDB for MongoDB, see [Instance types]().
|
|
219
|
+
* To create a sharded cluster instance, call the [CreateShardingDBInstance]() operation.
|
|
198
220
|
*
|
|
199
221
|
* @param request - CreateDBInstanceRequest
|
|
200
222
|
* @returns CreateDBInstanceResponse
|
|
@@ -216,10 +238,10 @@ export default class Client extends OpenApi {
|
|
|
216
238
|
*/
|
|
217
239
|
createGlobalSecurityIPGroup(request: $_model.CreateGlobalSecurityIPGroupRequest): Promise<$_model.CreateGlobalSecurityIPGroupResponse>;
|
|
218
240
|
/**
|
|
219
|
-
* Adds a shard or mongos node to an ApsaraDB for MongoDB instance.
|
|
241
|
+
* Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster instance.
|
|
220
242
|
*
|
|
221
243
|
* @remarks
|
|
222
|
-
* Before
|
|
244
|
+
* Before calling this operation, ensure you are familiar with the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
223
245
|
* This operation applies only to sharded cluster instances.
|
|
224
246
|
*
|
|
225
247
|
* @param request - CreateNodeRequest
|
|
@@ -228,10 +250,10 @@ export default class Client extends OpenApi {
|
|
|
228
250
|
*/
|
|
229
251
|
createNodeWithOptions(request: $_model.CreateNodeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateNodeResponse>;
|
|
230
252
|
/**
|
|
231
|
-
* Adds a shard or mongos node to an ApsaraDB for MongoDB instance.
|
|
253
|
+
* Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster instance.
|
|
232
254
|
*
|
|
233
255
|
* @remarks
|
|
234
|
-
* Before
|
|
256
|
+
* Before calling this operation, ensure you are familiar with the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
235
257
|
* This operation applies only to sharded cluster instances.
|
|
236
258
|
*
|
|
237
259
|
* @param request - CreateNodeRequest
|
|
@@ -262,23 +284,27 @@ export default class Client extends OpenApi {
|
|
|
262
284
|
*/
|
|
263
285
|
createNodeBatch(request: $_model.CreateNodeBatchRequest): Promise<$_model.CreateNodeBatchResponse>;
|
|
264
286
|
/**
|
|
287
|
+
* Creates a role tag for an instance node.
|
|
288
|
+
*
|
|
265
289
|
* @param request - CreateNodeRoleTagRequest
|
|
266
290
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
267
291
|
* @returns CreateNodeRoleTagResponse
|
|
268
292
|
*/
|
|
269
293
|
createNodeRoleTagWithOptions(request: $_model.CreateNodeRoleTagRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateNodeRoleTagResponse>;
|
|
270
294
|
/**
|
|
295
|
+
* Creates a role tag for an instance node.
|
|
296
|
+
*
|
|
271
297
|
* @param request - CreateNodeRoleTagRequest
|
|
272
298
|
* @returns CreateNodeRoleTagResponse
|
|
273
299
|
*/
|
|
274
300
|
createNodeRoleTag(request: $_model.CreateNodeRoleTagRequest): Promise<$_model.CreateNodeRoleTagResponse>;
|
|
275
301
|
/**
|
|
276
|
-
* Creates or clones
|
|
302
|
+
* Creates or clones a MongoDB sharded cluster instance.
|
|
277
303
|
*
|
|
278
304
|
* @remarks
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
305
|
+
* - Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
306
|
+
* - For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
307
|
+
* - To create a standalone or replica set instance, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
|
|
282
308
|
*
|
|
283
309
|
* @param request - CreateShardingDBInstanceRequest
|
|
284
310
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -286,19 +312,23 @@ export default class Client extends OpenApi {
|
|
|
286
312
|
*/
|
|
287
313
|
createShardingDBInstanceWithOptions(request: $_model.CreateShardingDBInstanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateShardingDBInstanceResponse>;
|
|
288
314
|
/**
|
|
289
|
-
* Creates or clones
|
|
315
|
+
* Creates or clones a MongoDB sharded cluster instance.
|
|
290
316
|
*
|
|
291
317
|
* @remarks
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
*
|
|
318
|
+
* - Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
319
|
+
* - For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
320
|
+
* - To create a standalone or replica set instance, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
|
|
295
321
|
*
|
|
296
322
|
* @param request - CreateShardingDBInstanceRequest
|
|
297
323
|
* @returns CreateShardingDBInstanceResponse
|
|
298
324
|
*/
|
|
299
325
|
createShardingDBInstance(request: $_model.CreateShardingDBInstanceRequest): Promise<$_model.CreateShardingDBInstanceResponse>;
|
|
300
326
|
/**
|
|
301
|
-
* Deletes
|
|
327
|
+
* Deletes a MongoDB backup set.
|
|
328
|
+
*
|
|
329
|
+
* @remarks
|
|
330
|
+
* You can delete only manual backups.
|
|
331
|
+
* This operation supports only MongoDB instances that use cloud disks.
|
|
302
332
|
*
|
|
303
333
|
* @param request - DeleteBackupRequest
|
|
304
334
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -306,20 +336,24 @@ export default class Client extends OpenApi {
|
|
|
306
336
|
*/
|
|
307
337
|
deleteBackupWithOptions(request: $_model.DeleteBackupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteBackupResponse>;
|
|
308
338
|
/**
|
|
309
|
-
* Deletes
|
|
339
|
+
* Deletes a MongoDB backup set.
|
|
340
|
+
*
|
|
341
|
+
* @remarks
|
|
342
|
+
* You can delete only manual backups.
|
|
343
|
+
* This operation supports only MongoDB instances that use cloud disks.
|
|
310
344
|
*
|
|
311
345
|
* @param request - DeleteBackupRequest
|
|
312
346
|
* @returns DeleteBackupResponse
|
|
313
347
|
*/
|
|
314
348
|
deleteBackup(request: $_model.DeleteBackupRequest): Promise<$_model.DeleteBackupResponse>;
|
|
315
349
|
/**
|
|
316
|
-
* Releases
|
|
350
|
+
* Releases a pay-as-you-go MongoDB instance.
|
|
317
351
|
*
|
|
318
352
|
* @remarks
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
* > After an instance is released,
|
|
353
|
+
* The instance must meet the following conditions:
|
|
354
|
+
* - The instance status is running.
|
|
355
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
356
|
+
* > After an instance is released, its data cannot be recovered. Proceed with caution.
|
|
323
357
|
*
|
|
324
358
|
* @param request - DeleteDBInstanceRequest
|
|
325
359
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -327,20 +361,20 @@ export default class Client extends OpenApi {
|
|
|
327
361
|
*/
|
|
328
362
|
deleteDBInstanceWithOptions(request: $_model.DeleteDBInstanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteDBInstanceResponse>;
|
|
329
363
|
/**
|
|
330
|
-
* Releases
|
|
364
|
+
* Releases a pay-as-you-go MongoDB instance.
|
|
331
365
|
*
|
|
332
366
|
* @remarks
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
*
|
|
336
|
-
* > After an instance is released,
|
|
367
|
+
* The instance must meet the following conditions:
|
|
368
|
+
* - The instance status is running.
|
|
369
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
370
|
+
* > After an instance is released, its data cannot be recovered. Proceed with caution.
|
|
337
371
|
*
|
|
338
372
|
* @param request - DeleteDBInstanceRequest
|
|
339
373
|
* @returns DeleteDBInstanceResponse
|
|
340
374
|
*/
|
|
341
375
|
deleteDBInstance(request: $_model.DeleteDBInstanceRequest): Promise<$_model.DeleteDBInstanceResponse>;
|
|
342
376
|
/**
|
|
343
|
-
* Deletes a global IP whitelist template.
|
|
377
|
+
* Deletes a global IP address whitelist template.
|
|
344
378
|
*
|
|
345
379
|
* @param request - DeleteGlobalSecurityIPGroupRequest
|
|
346
380
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -348,7 +382,7 @@ export default class Client extends OpenApi {
|
|
|
348
382
|
*/
|
|
349
383
|
deleteGlobalSecurityIPGroupWithOptions(request: $_model.DeleteGlobalSecurityIPGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteGlobalSecurityIPGroupResponse>;
|
|
350
384
|
/**
|
|
351
|
-
* Deletes a global IP whitelist template.
|
|
385
|
+
* Deletes a global IP address whitelist template.
|
|
352
386
|
*
|
|
353
387
|
* @param request - DeleteGlobalSecurityIPGroupRequest
|
|
354
388
|
* @returns DeleteGlobalSecurityIPGroupResponse
|
|
@@ -359,10 +393,10 @@ export default class Client extends OpenApi {
|
|
|
359
393
|
*
|
|
360
394
|
* @remarks
|
|
361
395
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
396
|
+
* - The instance is in the Running state.
|
|
397
|
+
* - The instance is a sharded cluster instance.
|
|
398
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
399
|
+
* - The number of the shard or mongos nodes in the instance is greater than two.
|
|
366
400
|
*
|
|
367
401
|
* @param request - DeleteNodeRequest
|
|
368
402
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -374,10 +408,10 @@ export default class Client extends OpenApi {
|
|
|
374
408
|
*
|
|
375
409
|
* @remarks
|
|
376
410
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
377
|
-
*
|
|
378
|
-
*
|
|
379
|
-
*
|
|
380
|
-
*
|
|
411
|
+
* - The instance is in the Running state.
|
|
412
|
+
* - The instance is a sharded cluster instance.
|
|
413
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
414
|
+
* - The number of the shard or mongos nodes in the instance is greater than two.
|
|
381
415
|
*
|
|
382
416
|
* @param request - DeleteNodeRequest
|
|
383
417
|
* @returns DeleteNodeResponse
|
|
@@ -386,9 +420,6 @@ export default class Client extends OpenApi {
|
|
|
386
420
|
/**
|
|
387
421
|
* Queries the database accounts of an ApsaraDB for MongoDB instance.
|
|
388
422
|
*
|
|
389
|
-
* @remarks
|
|
390
|
-
* > This operation can be used to query only the information of the root account.
|
|
391
|
-
*
|
|
392
423
|
* @param request - DescribeAccountsRequest
|
|
393
424
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
394
425
|
* @returns DescribeAccountsResponse
|
|
@@ -397,26 +428,27 @@ export default class Client extends OpenApi {
|
|
|
397
428
|
/**
|
|
398
429
|
* Queries the database accounts of an ApsaraDB for MongoDB instance.
|
|
399
430
|
*
|
|
400
|
-
* @remarks
|
|
401
|
-
* > This operation can be used to query only the information of the root account.
|
|
402
|
-
*
|
|
403
431
|
* @param request - DescribeAccountsRequest
|
|
404
432
|
* @returns DescribeAccountsResponse
|
|
405
433
|
*/
|
|
406
434
|
describeAccounts(request: $_model.DescribeAccountsRequest): Promise<$_model.DescribeAccountsResponse>;
|
|
407
435
|
/**
|
|
436
|
+
* Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
437
|
+
*
|
|
408
438
|
* @param request - DescribeActiveOperationMaintenanceConfigRequest
|
|
409
439
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
410
440
|
* @returns DescribeActiveOperationMaintenanceConfigResponse
|
|
411
441
|
*/
|
|
412
442
|
describeActiveOperationMaintenanceConfigWithOptions(request: $_model.DescribeActiveOperationMaintenanceConfigRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeActiveOperationMaintenanceConfigResponse>;
|
|
413
443
|
/**
|
|
444
|
+
* Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
445
|
+
*
|
|
414
446
|
* @param request - DescribeActiveOperationMaintenanceConfigRequest
|
|
415
447
|
* @returns DescribeActiveOperationMaintenanceConfigResponse
|
|
416
448
|
*/
|
|
417
449
|
describeActiveOperationMaintenanceConfig(request: $_model.DescribeActiveOperationMaintenanceConfigRequest): Promise<$_model.DescribeActiveOperationMaintenanceConfigResponse>;
|
|
418
450
|
/**
|
|
419
|
-
* Queries the detailed information about
|
|
451
|
+
* Queries the detailed information about tasks of an ApsaraDB for MongoDB instance.
|
|
420
452
|
*
|
|
421
453
|
* @param request - DescribeActiveOperationTaskRequest
|
|
422
454
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -424,7 +456,7 @@ export default class Client extends OpenApi {
|
|
|
424
456
|
*/
|
|
425
457
|
describeActiveOperationTaskWithOptions(request: $_model.DescribeActiveOperationTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeActiveOperationTaskResponse>;
|
|
426
458
|
/**
|
|
427
|
-
* Queries the detailed information about
|
|
459
|
+
* Queries the detailed information about tasks of an ApsaraDB for MongoDB instance.
|
|
428
460
|
*
|
|
429
461
|
* @param request - DescribeActiveOperationTaskRequest
|
|
430
462
|
* @returns DescribeActiveOperationTaskResponse
|
|
@@ -446,7 +478,7 @@ export default class Client extends OpenApi {
|
|
|
446
478
|
*/
|
|
447
479
|
describeActiveOperationTaskCount(request: $_model.DescribeActiveOperationTaskCountRequest): Promise<$_model.DescribeActiveOperationTaskCountResponse>;
|
|
448
480
|
/**
|
|
449
|
-
*
|
|
481
|
+
* Queries the types and number of O&M tasks for a MongoDB instance.
|
|
450
482
|
*
|
|
451
483
|
* @param request - DescribeActiveOperationTaskRegionRequest
|
|
452
484
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -454,7 +486,7 @@ export default class Client extends OpenApi {
|
|
|
454
486
|
*/
|
|
455
487
|
describeActiveOperationTaskRegionWithOptions(request: $_model.DescribeActiveOperationTaskRegionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeActiveOperationTaskRegionResponse>;
|
|
456
488
|
/**
|
|
457
|
-
*
|
|
489
|
+
* Queries the types and number of O&M tasks for a MongoDB instance.
|
|
458
490
|
*
|
|
459
491
|
* @param request - DescribeActiveOperationTaskRegionRequest
|
|
460
492
|
* @returns DescribeActiveOperationTaskRegionResponse
|
|
@@ -482,7 +514,7 @@ export default class Client extends OpenApi {
|
|
|
482
514
|
*/
|
|
483
515
|
describeActiveOperationTaskType(request: $_model.DescribeActiveOperationTaskTypeRequest): Promise<$_model.DescribeActiveOperationTaskTypeResponse>;
|
|
484
516
|
/**
|
|
485
|
-
* Queries
|
|
517
|
+
* Queries O&M task details for MongoDB instances.
|
|
486
518
|
*
|
|
487
519
|
* @param request - DescribeActiveOperationTasksRequest
|
|
488
520
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -490,19 +522,19 @@ export default class Client extends OpenApi {
|
|
|
490
522
|
*/
|
|
491
523
|
describeActiveOperationTasksWithOptions(request: $_model.DescribeActiveOperationTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeActiveOperationTasksResponse>;
|
|
492
524
|
/**
|
|
493
|
-
* Queries
|
|
525
|
+
* Queries O&M task details for MongoDB instances.
|
|
494
526
|
*
|
|
495
527
|
* @param request - DescribeActiveOperationTasksRequest
|
|
496
528
|
* @returns DescribeActiveOperationTasksResponse
|
|
497
529
|
*/
|
|
498
530
|
describeActiveOperationTasks(request: $_model.DescribeActiveOperationTasksRequest): Promise<$_model.DescribeActiveOperationTasksResponse>;
|
|
499
531
|
/**
|
|
500
|
-
* Queries the
|
|
532
|
+
* Queries the audit log types collected for a MongoDB instance.
|
|
501
533
|
*
|
|
502
534
|
* @remarks
|
|
503
|
-
*
|
|
504
|
-
*
|
|
505
|
-
*
|
|
535
|
+
* - The instance must be in the running state when you call this operation.
|
|
536
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
537
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
506
538
|
*
|
|
507
539
|
* @param request - DescribeAuditLogFilterRequest
|
|
508
540
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -510,24 +542,24 @@ export default class Client extends OpenApi {
|
|
|
510
542
|
*/
|
|
511
543
|
describeAuditLogFilterWithOptions(request: $_model.DescribeAuditLogFilterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAuditLogFilterResponse>;
|
|
512
544
|
/**
|
|
513
|
-
* Queries the
|
|
545
|
+
* Queries the audit log types collected for a MongoDB instance.
|
|
514
546
|
*
|
|
515
547
|
* @remarks
|
|
516
|
-
*
|
|
517
|
-
*
|
|
518
|
-
*
|
|
548
|
+
* - The instance must be in the running state when you call this operation.
|
|
549
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
550
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
519
551
|
*
|
|
520
552
|
* @param request - DescribeAuditLogFilterRequest
|
|
521
553
|
* @returns DescribeAuditLogFilterResponse
|
|
522
554
|
*/
|
|
523
555
|
describeAuditLogFilter(request: $_model.DescribeAuditLogFilterRequest): Promise<$_model.DescribeAuditLogFilterResponse>;
|
|
524
556
|
/**
|
|
525
|
-
*
|
|
557
|
+
* Checks whether audit logging is enabled for a MongoDB instance.
|
|
526
558
|
*
|
|
527
559
|
* @remarks
|
|
528
|
-
*
|
|
529
|
-
*
|
|
530
|
-
*
|
|
560
|
+
* - The instance must be in the running state.
|
|
561
|
+
* - This operation is available only for **General-purpose Local Disk Edition** and **Dedicated Local Disk Edition** instances.
|
|
562
|
+
* - You can call this operation up to 30 times per minute. Calls that exceed this limit are throttled. To make frequent calls, use Log Service. For more information, see [Manage a Logstore](https://help.aliyun.com/document_detail/48990.html).
|
|
531
563
|
*
|
|
532
564
|
* @param request - DescribeAuditPolicyRequest
|
|
533
565
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -535,24 +567,24 @@ export default class Client extends OpenApi {
|
|
|
535
567
|
*/
|
|
536
568
|
describeAuditPolicyWithOptions(request: $_model.DescribeAuditPolicyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAuditPolicyResponse>;
|
|
537
569
|
/**
|
|
538
|
-
*
|
|
570
|
+
* Checks whether audit logging is enabled for a MongoDB instance.
|
|
539
571
|
*
|
|
540
572
|
* @remarks
|
|
541
|
-
*
|
|
542
|
-
*
|
|
543
|
-
*
|
|
573
|
+
* - The instance must be in the running state.
|
|
574
|
+
* - This operation is available only for **General-purpose Local Disk Edition** and **Dedicated Local Disk Edition** instances.
|
|
575
|
+
* - You can call this operation up to 30 times per minute. Calls that exceed this limit are throttled. To make frequent calls, use Log Service. For more information, see [Manage a Logstore](https://help.aliyun.com/document_detail/48990.html).
|
|
544
576
|
*
|
|
545
577
|
* @param request - DescribeAuditPolicyRequest
|
|
546
578
|
* @returns DescribeAuditPolicyResponse
|
|
547
579
|
*/
|
|
548
580
|
describeAuditPolicy(request: $_model.DescribeAuditPolicyRequest): Promise<$_model.DescribeAuditPolicyResponse>;
|
|
549
581
|
/**
|
|
550
|
-
* Queries
|
|
582
|
+
* Queries audit log entries for a MongoDB instance.
|
|
551
583
|
*
|
|
552
584
|
* @remarks
|
|
553
|
-
*
|
|
554
|
-
*
|
|
555
|
-
*
|
|
585
|
+
* - When you call this operation, ensure that the audit log feature of the instance is enabled. Otherwise, the operation returns an empty audit log.
|
|
586
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
587
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
556
588
|
*
|
|
557
589
|
* @param request - DescribeAuditRecordsRequest
|
|
558
590
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -560,12 +592,12 @@ export default class Client extends OpenApi {
|
|
|
560
592
|
*/
|
|
561
593
|
describeAuditRecordsWithOptions(request: $_model.DescribeAuditRecordsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeAuditRecordsResponse>;
|
|
562
594
|
/**
|
|
563
|
-
* Queries
|
|
595
|
+
* Queries audit log entries for a MongoDB instance.
|
|
564
596
|
*
|
|
565
597
|
* @remarks
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
*
|
|
598
|
+
* - When you call this operation, ensure that the audit log feature of the instance is enabled. Otherwise, the operation returns an empty audit log.
|
|
599
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
600
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
569
601
|
*
|
|
570
602
|
* @param request - DescribeAuditRecordsRequest
|
|
571
603
|
* @returns DescribeAuditRecordsResponse
|
|
@@ -628,11 +660,11 @@ export default class Client extends OpenApi {
|
|
|
628
660
|
* @remarks
|
|
629
661
|
* You can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation to restore a database for an ApsaraDB for MongoDB instance. For more information, see [Restore one database of an ApsaraDB for MongoDB instance](https://help.aliyun.com/document_detail/112274.html).
|
|
630
662
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
631
|
-
*
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
*
|
|
635
|
-
*
|
|
663
|
+
* - The instance was created after March 26, 2019.
|
|
664
|
+
* - The instance is located in the China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Hangzhou), China (Shanghai), China (Shenzhen), or Singapore region. Other regions are not supported.
|
|
665
|
+
* - The instance is a replica set instance.
|
|
666
|
+
* - The instance runs MongoDB 3.4, MongoDB 4.0, or MongoDB 4.2. In addition, the instance uses local disks to store data.
|
|
667
|
+
* - The storage engine of the instance is WiredTiger.
|
|
636
668
|
*
|
|
637
669
|
* @param request - DescribeBackupDBsRequest
|
|
638
670
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -645,18 +677,18 @@ export default class Client extends OpenApi {
|
|
|
645
677
|
* @remarks
|
|
646
678
|
* You can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation to restore a database for an ApsaraDB for MongoDB instance. For more information, see [Restore one database of an ApsaraDB for MongoDB instance](https://help.aliyun.com/document_detail/112274.html).
|
|
647
679
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
648
|
-
*
|
|
649
|
-
*
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
*
|
|
680
|
+
* - The instance was created after March 26, 2019.
|
|
681
|
+
* - The instance is located in the China (Qingdao), China (Beijing), China (Zhangjiakou), China (Hohhot), China (Hangzhou), China (Shanghai), China (Shenzhen), or Singapore region. Other regions are not supported.
|
|
682
|
+
* - The instance is a replica set instance.
|
|
683
|
+
* - The instance runs MongoDB 3.4, MongoDB 4.0, or MongoDB 4.2. In addition, the instance uses local disks to store data.
|
|
684
|
+
* - The storage engine of the instance is WiredTiger.
|
|
653
685
|
*
|
|
654
686
|
* @param request - DescribeBackupDBsRequest
|
|
655
687
|
* @returns DescribeBackupDBsResponse
|
|
656
688
|
*/
|
|
657
689
|
describeBackupDBs(request: $_model.DescribeBackupDBsRequest): Promise<$_model.DescribeBackupDBsResponse>;
|
|
658
690
|
/**
|
|
659
|
-
* Queries the backup policy of
|
|
691
|
+
* Queries the backup policy of a MongoDB instance.
|
|
660
692
|
*
|
|
661
693
|
* @param request - DescribeBackupPolicyRequest
|
|
662
694
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -664,14 +696,17 @@ export default class Client extends OpenApi {
|
|
|
664
696
|
*/
|
|
665
697
|
describeBackupPolicyWithOptions(request: $_model.DescribeBackupPolicyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeBackupPolicyResponse>;
|
|
666
698
|
/**
|
|
667
|
-
* Queries the backup policy of
|
|
699
|
+
* Queries the backup policy of a MongoDB instance.
|
|
668
700
|
*
|
|
669
701
|
* @param request - DescribeBackupPolicyRequest
|
|
670
702
|
* @returns DescribeBackupPolicyResponse
|
|
671
703
|
*/
|
|
672
704
|
describeBackupPolicy(request: $_model.DescribeBackupPolicyRequest): Promise<$_model.DescribeBackupPolicyResponse>;
|
|
673
705
|
/**
|
|
674
|
-
* Queries the backup
|
|
706
|
+
* Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks.
|
|
707
|
+
*
|
|
708
|
+
* @remarks
|
|
709
|
+
* Backup usage for a sharded cluster is billed on a per-shard basis. You can use this operation to query the backup usage for a single shard.
|
|
675
710
|
*
|
|
676
711
|
* @param request - DescribeBackupStorageRequest
|
|
677
712
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -679,14 +714,17 @@ export default class Client extends OpenApi {
|
|
|
679
714
|
*/
|
|
680
715
|
describeBackupStorageWithOptions(request: $_model.DescribeBackupStorageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeBackupStorageResponse>;
|
|
681
716
|
/**
|
|
682
|
-
* Queries the backup
|
|
717
|
+
* Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks.
|
|
718
|
+
*
|
|
719
|
+
* @remarks
|
|
720
|
+
* Backup usage for a sharded cluster is billed on a per-shard basis. You can use this operation to query the backup usage for a single shard.
|
|
683
721
|
*
|
|
684
722
|
* @param request - DescribeBackupStorageRequest
|
|
685
723
|
* @returns DescribeBackupStorageResponse
|
|
686
724
|
*/
|
|
687
725
|
describeBackupStorage(request: $_model.DescribeBackupStorageRequest): Promise<$_model.DescribeBackupStorageResponse>;
|
|
688
726
|
/**
|
|
689
|
-
* Queries backup
|
|
727
|
+
* Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks.
|
|
690
728
|
*
|
|
691
729
|
* @param request - DescribeBackupTasksRequest
|
|
692
730
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -694,14 +732,14 @@ export default class Client extends OpenApi {
|
|
|
694
732
|
*/
|
|
695
733
|
describeBackupTasksWithOptions(request: $_model.DescribeBackupTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeBackupTasksResponse>;
|
|
696
734
|
/**
|
|
697
|
-
* Queries backup
|
|
735
|
+
* Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks.
|
|
698
736
|
*
|
|
699
737
|
* @param request - DescribeBackupTasksRequest
|
|
700
738
|
* @returns DescribeBackupTasksResponse
|
|
701
739
|
*/
|
|
702
740
|
describeBackupTasks(request: $_model.DescribeBackupTasksRequest): Promise<$_model.DescribeBackupTasksResponse>;
|
|
703
741
|
/**
|
|
704
|
-
* Queries the
|
|
742
|
+
* Queries the backups of a MongoDB instance.
|
|
705
743
|
*
|
|
706
744
|
* @param request - DescribeBackupsRequest
|
|
707
745
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -709,14 +747,14 @@ export default class Client extends OpenApi {
|
|
|
709
747
|
*/
|
|
710
748
|
describeBackupsWithOptions(request: $_model.DescribeBackupsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeBackupsResponse>;
|
|
711
749
|
/**
|
|
712
|
-
* Queries the
|
|
750
|
+
* Queries the backups of a MongoDB instance.
|
|
713
751
|
*
|
|
714
752
|
* @param request - DescribeBackupsRequest
|
|
715
753
|
* @returns DescribeBackupsResponse
|
|
716
754
|
*/
|
|
717
755
|
describeBackups(request: $_model.DescribeBackupsRequest): Promise<$_model.DescribeBackupsResponse>;
|
|
718
756
|
/**
|
|
719
|
-
*
|
|
757
|
+
* Query log backup files for an ApsaraDB for MongoDB instance.
|
|
720
758
|
*
|
|
721
759
|
* @param request - DescribeBinlogFilesRequest
|
|
722
760
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -724,18 +762,18 @@ export default class Client extends OpenApi {
|
|
|
724
762
|
*/
|
|
725
763
|
describeBinlogFilesWithOptions(request: $_model.DescribeBinlogFilesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeBinlogFilesResponse>;
|
|
726
764
|
/**
|
|
727
|
-
*
|
|
765
|
+
* Query log backup files for an ApsaraDB for MongoDB instance.
|
|
728
766
|
*
|
|
729
767
|
* @param request - DescribeBinlogFilesRequest
|
|
730
768
|
* @returns DescribeBinlogFilesResponse
|
|
731
769
|
*/
|
|
732
770
|
describeBinlogFiles(request: $_model.DescribeBinlogFilesRequest): Promise<$_model.DescribeBinlogFilesResponse>;
|
|
733
771
|
/**
|
|
734
|
-
* Queries the backup sets
|
|
772
|
+
* Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
735
773
|
*
|
|
736
774
|
* @remarks
|
|
737
|
-
* For
|
|
738
|
-
*
|
|
775
|
+
* For sharded cluster instances that use cloud disks and were created before October 19, 2023, you must first call the [TransferClusterBackup](https://help.aliyun.com/document_detail/2587931.html) operation to convert shard backups to cluster backups.
|
|
776
|
+
* Sharded cluster instances that use cloud disks and were created after October 19, 2023 use cluster backups by default.
|
|
739
777
|
*
|
|
740
778
|
* @param request - DescribeClusterBackupsRequest
|
|
741
779
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -743,22 +781,22 @@ export default class Client extends OpenApi {
|
|
|
743
781
|
*/
|
|
744
782
|
describeClusterBackupsWithOptions(request: $_model.DescribeClusterBackupsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeClusterBackupsResponse>;
|
|
745
783
|
/**
|
|
746
|
-
* Queries the backup sets
|
|
784
|
+
* Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
747
785
|
*
|
|
748
786
|
* @remarks
|
|
749
|
-
* For
|
|
750
|
-
*
|
|
787
|
+
* For sharded cluster instances that use cloud disks and were created before October 19, 2023, you must first call the [TransferClusterBackup](https://help.aliyun.com/document_detail/2587931.html) operation to convert shard backups to cluster backups.
|
|
788
|
+
* Sharded cluster instances that use cloud disks and were created after October 19, 2023 use cluster backups by default.
|
|
751
789
|
*
|
|
752
790
|
* @param request - DescribeClusterBackupsRequest
|
|
753
791
|
* @returns DescribeClusterBackupsResponse
|
|
754
792
|
*/
|
|
755
793
|
describeClusterBackups(request: $_model.DescribeClusterBackupsRequest): Promise<$_model.DescribeClusterBackupsResponse>;
|
|
756
794
|
/**
|
|
757
|
-
* Queries the time range
|
|
795
|
+
* Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB.
|
|
758
796
|
*
|
|
759
797
|
* @remarks
|
|
760
|
-
*
|
|
761
|
-
*
|
|
798
|
+
* - The MongoDB instance must be a sharded cluster instance that runs major engine version 4.4 or later and uses standard SSDs as the storage pattern.
|
|
799
|
+
* - Only instances created before October 19, 2023 need to invoke the TransferClusterBackup operation to switch to the cluster backup mode. Instances that have been switched to the cluster backup mode or sharded cluster instances with cloud disks created on or after October 19, 2023 can directly invoke this operation.
|
|
762
800
|
*
|
|
763
801
|
* @param request - DescribeClusterRecoverTimeRequest
|
|
764
802
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -766,18 +804,18 @@ export default class Client extends OpenApi {
|
|
|
766
804
|
*/
|
|
767
805
|
describeClusterRecoverTimeWithOptions(request: $_model.DescribeClusterRecoverTimeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeClusterRecoverTimeResponse>;
|
|
768
806
|
/**
|
|
769
|
-
* Queries the time range
|
|
807
|
+
* Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB.
|
|
770
808
|
*
|
|
771
809
|
* @remarks
|
|
772
|
-
*
|
|
773
|
-
*
|
|
810
|
+
* - The MongoDB instance must be a sharded cluster instance that runs major engine version 4.4 or later and uses standard SSDs as the storage pattern.
|
|
811
|
+
* - Only instances created before October 19, 2023 need to invoke the TransferClusterBackup operation to switch to the cluster backup mode. Instances that have been switched to the cluster backup mode or sharded cluster instances with cloud disks created on or after October 19, 2023 can directly invoke this operation.
|
|
774
812
|
*
|
|
775
813
|
* @param request - DescribeClusterRecoverTimeRequest
|
|
776
814
|
* @returns DescribeClusterRecoverTimeResponse
|
|
777
815
|
*/
|
|
778
816
|
describeClusterRecoverTime(request: $_model.DescribeClusterRecoverTimeRequest): Promise<$_model.DescribeClusterRecoverTimeResponse>;
|
|
779
817
|
/**
|
|
780
|
-
* Queries
|
|
818
|
+
* Queries information about an ApsaraDB for MongoDB instance.
|
|
781
819
|
*
|
|
782
820
|
* @param request - DescribeDBInstanceAttributeRequest
|
|
783
821
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -785,14 +823,14 @@ export default class Client extends OpenApi {
|
|
|
785
823
|
*/
|
|
786
824
|
describeDBInstanceAttributeWithOptions(request: $_model.DescribeDBInstanceAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDBInstanceAttributeResponse>;
|
|
787
825
|
/**
|
|
788
|
-
* Queries
|
|
826
|
+
* Queries information about an ApsaraDB for MongoDB instance.
|
|
789
827
|
*
|
|
790
828
|
* @param request - DescribeDBInstanceAttributeRequest
|
|
791
829
|
* @returns DescribeDBInstanceAttributeResponse
|
|
792
830
|
*/
|
|
793
831
|
describeDBInstanceAttribute(request: $_model.DescribeDBInstanceAttributeRequest): Promise<$_model.DescribeDBInstanceAttributeResponse>;
|
|
794
832
|
/**
|
|
795
|
-
* Queries the
|
|
833
|
+
* Queries the encryption key of a MongoDB instance.
|
|
796
834
|
*
|
|
797
835
|
* @remarks
|
|
798
836
|
* When you call the DescribeDBInstanceEncryptionKey operation, the instance must have transparent data encryption (TDE) enabled in BYOK mode. You can call the [ModifyDBInstanceTDE](https://help.aliyun.com/document_detail/131267.html) operation to enable TDE.
|
|
@@ -803,7 +841,7 @@ export default class Client extends OpenApi {
|
|
|
803
841
|
*/
|
|
804
842
|
describeDBInstanceEncryptionKeyWithOptions(request: $_model.DescribeDBInstanceEncryptionKeyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDBInstanceEncryptionKeyResponse>;
|
|
805
843
|
/**
|
|
806
|
-
* Queries the
|
|
844
|
+
* Queries the encryption key of a MongoDB instance.
|
|
807
845
|
*
|
|
808
846
|
* @remarks
|
|
809
847
|
* When you call the DescribeDBInstanceEncryptionKey operation, the instance must have transparent data encryption (TDE) enabled in BYOK mode. You can call the [ModifyDBInstanceTDE](https://help.aliyun.com/document_detail/131267.html) operation to enable TDE.
|
|
@@ -828,7 +866,7 @@ export default class Client extends OpenApi {
|
|
|
828
866
|
*/
|
|
829
867
|
describeDBInstanceMonitor(request: $_model.DescribeDBInstanceMonitorRequest): Promise<$_model.DescribeDBInstanceMonitorResponse>;
|
|
830
868
|
/**
|
|
831
|
-
* Queries the performance data of
|
|
869
|
+
* Queries the performance data of a MongoDB instance.
|
|
832
870
|
*
|
|
833
871
|
* @param request - DescribeDBInstancePerformanceRequest
|
|
834
872
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -836,20 +874,21 @@ export default class Client extends OpenApi {
|
|
|
836
874
|
*/
|
|
837
875
|
describeDBInstancePerformanceWithOptions(request: $_model.DescribeDBInstancePerformanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDBInstancePerformanceResponse>;
|
|
838
876
|
/**
|
|
839
|
-
* Queries the performance data of
|
|
877
|
+
* Queries the performance data of a MongoDB instance.
|
|
840
878
|
*
|
|
841
879
|
* @param request - DescribeDBInstancePerformanceRequest
|
|
842
880
|
* @returns DescribeDBInstancePerformanceResponse
|
|
843
881
|
*/
|
|
844
882
|
describeDBInstancePerformance(request: $_model.DescribeDBInstancePerformanceRequest): Promise<$_model.DescribeDBInstancePerformanceResponse>;
|
|
845
883
|
/**
|
|
846
|
-
*
|
|
884
|
+
* Query SSL configuration details for a MongoDB instance.
|
|
847
885
|
*
|
|
848
886
|
* @remarks
|
|
849
|
-
*
|
|
850
|
-
*
|
|
851
|
-
*
|
|
852
|
-
*
|
|
887
|
+
* To use this operation, the instance must meet the following requirements:
|
|
888
|
+
* - The instance status is Running.
|
|
889
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
890
|
+
* - The replica set instance must be version 3.4 or later.
|
|
891
|
+
* - The sharded cluster instance must use Enhanced SSDs (ESSDs).
|
|
853
892
|
*
|
|
854
893
|
* @param request - DescribeDBInstanceSSLRequest
|
|
855
894
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -857,20 +896,21 @@ export default class Client extends OpenApi {
|
|
|
857
896
|
*/
|
|
858
897
|
describeDBInstanceSSLWithOptions(request: $_model.DescribeDBInstanceSSLRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDBInstanceSSLResponse>;
|
|
859
898
|
/**
|
|
860
|
-
*
|
|
899
|
+
* Query SSL configuration details for a MongoDB instance.
|
|
861
900
|
*
|
|
862
901
|
* @remarks
|
|
863
|
-
*
|
|
864
|
-
*
|
|
865
|
-
*
|
|
866
|
-
*
|
|
902
|
+
* To use this operation, the instance must meet the following requirements:
|
|
903
|
+
* - The instance status is Running.
|
|
904
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
905
|
+
* - The replica set instance must be version 3.4 or later.
|
|
906
|
+
* - The sharded cluster instance must use Enhanced SSDs (ESSDs).
|
|
867
907
|
*
|
|
868
908
|
* @param request - DescribeDBInstanceSSLRequest
|
|
869
909
|
* @returns DescribeDBInstanceSSLResponse
|
|
870
910
|
*/
|
|
871
911
|
describeDBInstanceSSL(request: $_model.DescribeDBInstanceSSLRequest): Promise<$_model.DescribeDBInstanceSSLResponse>;
|
|
872
912
|
/**
|
|
873
|
-
*
|
|
913
|
+
* Gets instance type details.
|
|
874
914
|
*
|
|
875
915
|
* @param request - DescribeDBInstanceSpecInfoRequest
|
|
876
916
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -878,7 +918,7 @@ export default class Client extends OpenApi {
|
|
|
878
918
|
*/
|
|
879
919
|
describeDBInstanceSpecInfoWithOptions(request: $_model.DescribeDBInstanceSpecInfoRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDBInstanceSpecInfoResponse>;
|
|
880
920
|
/**
|
|
881
|
-
*
|
|
921
|
+
* Gets instance type details.
|
|
882
922
|
*
|
|
883
923
|
* @param request - DescribeDBInstanceSpecInfoRequest
|
|
884
924
|
* @returns DescribeDBInstanceSpecInfoResponse
|
|
@@ -889,8 +929,8 @@ export default class Client extends OpenApi {
|
|
|
889
929
|
*
|
|
890
930
|
* @remarks
|
|
891
931
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
892
|
-
*
|
|
893
|
-
*
|
|
932
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
933
|
+
* - The instance uses local physical disks to store data.
|
|
894
934
|
*
|
|
895
935
|
* @param request - DescribeDBInstanceSwitchLogRequest
|
|
896
936
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -902,8 +942,8 @@ export default class Client extends OpenApi {
|
|
|
902
942
|
*
|
|
903
943
|
* @remarks
|
|
904
944
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
905
|
-
*
|
|
906
|
-
*
|
|
945
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
946
|
+
* - The instance uses local physical disks to store data.
|
|
907
947
|
*
|
|
908
948
|
* @param request - DescribeDBInstanceSwitchLogRequest
|
|
909
949
|
* @returns DescribeDBInstanceSwitchLogResponse
|
|
@@ -913,11 +953,11 @@ export default class Client extends OpenApi {
|
|
|
913
953
|
* Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.
|
|
914
954
|
*
|
|
915
955
|
* @remarks
|
|
916
|
-
* >
|
|
917
|
-
*
|
|
918
|
-
*
|
|
919
|
-
*
|
|
920
|
-
*
|
|
956
|
+
* > For more information about this feature, see [Settings for transparent data encryption TDE](https://help.aliyun.com/document_detail/131048.html).
|
|
957
|
+
* When you invoke this operation, the instance must meet the following conditions:
|
|
958
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
959
|
+
* - The storage DPI engine of the instance is WiredTiger.
|
|
960
|
+
* - The database DPI engine version of the instance is 4.0 or 4.2. If the database DPI engine version is earlier than the required version, you can invoke the [UpgradeDBInstanceEngineVersion](https://help.aliyun.com/document_detail/67608.html) operation to upgrade the database DPI engine version.
|
|
921
961
|
*
|
|
922
962
|
* @param request - DescribeDBInstanceTDEInfoRequest
|
|
923
963
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -928,21 +968,22 @@ export default class Client extends OpenApi {
|
|
|
928
968
|
* Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.
|
|
929
969
|
*
|
|
930
970
|
* @remarks
|
|
931
|
-
* >
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
*
|
|
935
|
-
*
|
|
971
|
+
* > For more information about this feature, see [Settings for transparent data encryption TDE](https://help.aliyun.com/document_detail/131048.html).
|
|
972
|
+
* When you invoke this operation, the instance must meet the following conditions:
|
|
973
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
974
|
+
* - The storage DPI engine of the instance is WiredTiger.
|
|
975
|
+
* - The database DPI engine version of the instance is 4.0 or 4.2. If the database DPI engine version is earlier than the required version, you can invoke the [UpgradeDBInstanceEngineVersion](https://help.aliyun.com/document_detail/67608.html) operation to upgrade the database DPI engine version.
|
|
936
976
|
*
|
|
937
977
|
* @param request - DescribeDBInstanceTDEInfoRequest
|
|
938
978
|
* @returns DescribeDBInstanceTDEInfoResponse
|
|
939
979
|
*/
|
|
940
980
|
describeDBInstanceTDEInfo(request: $_model.DescribeDBInstanceTDEInfoRequest): Promise<$_model.DescribeDBInstanceTDEInfoResponse>;
|
|
941
981
|
/**
|
|
942
|
-
* Queries a list of
|
|
982
|
+
* Queries a list of MongoDB instances.
|
|
943
983
|
*
|
|
944
984
|
* @remarks
|
|
945
|
-
*
|
|
985
|
+
* <props="china">By default, this operation queries a list of replica set instances, which includes standalone instances. If you do not specify the **DBInstanceType** request parameter, the default value is **replicate**. To query a list of sharded cluster instances, set **DBInstanceType** to **sharding**. To query a list of serverless instances, set **DBInstanceType** to **serverless**.
|
|
986
|
+
* <props="intl">By default, this operation queries a list of replica set instances, which includes standalone instances. If you do not specify the **DBInstanceType** request parameter, the default value is **replicate**. To query a list of sharded cluster instances, set **DBInstanceType** to **sharding**.
|
|
946
987
|
*
|
|
947
988
|
* @param request - DescribeDBInstancesRequest
|
|
948
989
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -950,21 +991,22 @@ export default class Client extends OpenApi {
|
|
|
950
991
|
*/
|
|
951
992
|
describeDBInstancesWithOptions(request: $_model.DescribeDBInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDBInstancesResponse>;
|
|
952
993
|
/**
|
|
953
|
-
* Queries a list of
|
|
994
|
+
* Queries a list of MongoDB instances.
|
|
954
995
|
*
|
|
955
996
|
* @remarks
|
|
956
|
-
*
|
|
997
|
+
* <props="china">By default, this operation queries a list of replica set instances, which includes standalone instances. If you do not specify the **DBInstanceType** request parameter, the default value is **replicate**. To query a list of sharded cluster instances, set **DBInstanceType** to **sharding**. To query a list of serverless instances, set **DBInstanceType** to **serverless**.
|
|
998
|
+
* <props="intl">By default, this operation queries a list of replica set instances, which includes standalone instances. If you do not specify the **DBInstanceType** request parameter, the default value is **replicate**. To query a list of sharded cluster instances, set **DBInstanceType** to **sharding**.
|
|
957
999
|
*
|
|
958
1000
|
* @param request - DescribeDBInstancesRequest
|
|
959
1001
|
* @returns DescribeDBInstancesResponse
|
|
960
1002
|
*/
|
|
961
1003
|
describeDBInstances(request: $_model.DescribeDBInstancesRequest): Promise<$_model.DescribeDBInstancesResponse>;
|
|
962
1004
|
/**
|
|
963
|
-
* Queries the overview
|
|
1005
|
+
* Queries the overview of one or more ApsaraDB for MongoDB instances.
|
|
964
1006
|
*
|
|
965
1007
|
* @remarks
|
|
966
|
-
*
|
|
967
|
-
*
|
|
1008
|
+
* - If you do not specify any instances, the operation returns overview information for all instances in the destination region associated with your Alibaba Cloud account.
|
|
1009
|
+
* - The results of this operation are not paginated.
|
|
968
1010
|
*
|
|
969
1011
|
* @param request - DescribeDBInstancesOverviewRequest
|
|
970
1012
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -972,22 +1014,22 @@ export default class Client extends OpenApi {
|
|
|
972
1014
|
*/
|
|
973
1015
|
describeDBInstancesOverviewWithOptions(request: $_model.DescribeDBInstancesOverviewRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeDBInstancesOverviewResponse>;
|
|
974
1016
|
/**
|
|
975
|
-
* Queries the overview
|
|
1017
|
+
* Queries the overview of one or more ApsaraDB for MongoDB instances.
|
|
976
1018
|
*
|
|
977
1019
|
* @remarks
|
|
978
|
-
*
|
|
979
|
-
*
|
|
1020
|
+
* - If you do not specify any instances, the operation returns overview information for all instances in the destination region associated with your Alibaba Cloud account.
|
|
1021
|
+
* - The results of this operation are not paginated.
|
|
980
1022
|
*
|
|
981
1023
|
* @param request - DescribeDBInstancesOverviewRequest
|
|
982
1024
|
* @returns DescribeDBInstancesOverviewResponse
|
|
983
1025
|
*/
|
|
984
1026
|
describeDBInstancesOverview(request: $_model.DescribeDBInstancesOverviewRequest): Promise<$_model.DescribeDBInstancesOverviewResponse>;
|
|
985
1027
|
/**
|
|
986
|
-
* Queries
|
|
1028
|
+
* Queries error log entries for a MongoDB instance.
|
|
987
1029
|
*
|
|
988
1030
|
* @remarks
|
|
989
|
-
*
|
|
990
|
-
*
|
|
1031
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
1032
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
991
1033
|
*
|
|
992
1034
|
* @param request - DescribeErrorLogRecordsRequest
|
|
993
1035
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -995,11 +1037,11 @@ export default class Client extends OpenApi {
|
|
|
995
1037
|
*/
|
|
996
1038
|
describeErrorLogRecordsWithOptions(request: $_model.DescribeErrorLogRecordsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeErrorLogRecordsResponse>;
|
|
997
1039
|
/**
|
|
998
|
-
* Queries
|
|
1040
|
+
* Queries error log entries for a MongoDB instance.
|
|
999
1041
|
*
|
|
1000
1042
|
* @remarks
|
|
1001
|
-
*
|
|
1002
|
-
*
|
|
1043
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
1044
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
1003
1045
|
*
|
|
1004
1046
|
* @param request - DescribeErrorLogRecordsRequest
|
|
1005
1047
|
* @returns DescribeErrorLogRecordsResponse
|
|
@@ -1021,7 +1063,7 @@ export default class Client extends OpenApi {
|
|
|
1021
1063
|
*/
|
|
1022
1064
|
describeGlobalSecurityIPGroup(request: $_model.DescribeGlobalSecurityIPGroupRequest): Promise<$_model.DescribeGlobalSecurityIPGroupResponse>;
|
|
1023
1065
|
/**
|
|
1024
|
-
* Queries the
|
|
1066
|
+
* Queries the mapping between an instance and a global IP address whitelist template.
|
|
1025
1067
|
*
|
|
1026
1068
|
* @param request - DescribeGlobalSecurityIPGroupRelationRequest
|
|
1027
1069
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1029,7 +1071,7 @@ export default class Client extends OpenApi {
|
|
|
1029
1071
|
*/
|
|
1030
1072
|
describeGlobalSecurityIPGroupRelationWithOptions(request: $_model.DescribeGlobalSecurityIPGroupRelationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeGlobalSecurityIPGroupRelationResponse>;
|
|
1031
1073
|
/**
|
|
1032
|
-
* Queries the
|
|
1074
|
+
* Queries the mapping between an instance and a global IP address whitelist template.
|
|
1033
1075
|
*
|
|
1034
1076
|
* @param request - DescribeGlobalSecurityIPGroupRelationRequest
|
|
1035
1077
|
* @returns DescribeGlobalSecurityIPGroupRelationResponse
|
|
@@ -1066,7 +1108,7 @@ export default class Client extends OpenApi {
|
|
|
1066
1108
|
*/
|
|
1067
1109
|
describeHistoryTasksStat(request: $_model.DescribeHistoryTasksStatRequest): Promise<$_model.DescribeHistoryTasksStatResponse>;
|
|
1068
1110
|
/**
|
|
1069
|
-
*
|
|
1111
|
+
* Queries the auto-renewal status of MongoDB instances.
|
|
1070
1112
|
*
|
|
1071
1113
|
* @remarks
|
|
1072
1114
|
* This operation is applicable to subscription instances.
|
|
@@ -1077,7 +1119,7 @@ export default class Client extends OpenApi {
|
|
|
1077
1119
|
*/
|
|
1078
1120
|
describeInstanceAutoRenewalAttributeWithOptions(request: $_model.DescribeInstanceAutoRenewalAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeInstanceAutoRenewalAttributeResponse>;
|
|
1079
1121
|
/**
|
|
1080
|
-
*
|
|
1122
|
+
* Queries the auto-renewal status of MongoDB instances.
|
|
1081
1123
|
*
|
|
1082
1124
|
* @remarks
|
|
1083
1125
|
* This operation is applicable to subscription instances.
|
|
@@ -1087,7 +1129,7 @@ export default class Client extends OpenApi {
|
|
|
1087
1129
|
*/
|
|
1088
1130
|
describeInstanceAutoRenewalAttribute(request: $_model.DescribeInstanceAutoRenewalAttributeRequest): Promise<$_model.DescribeInstanceAutoRenewalAttributeResponse>;
|
|
1089
1131
|
/**
|
|
1090
|
-
* Queries the time
|
|
1132
|
+
* Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks.
|
|
1091
1133
|
*
|
|
1092
1134
|
* @param request - DescribeInstanceRecoverTimeRequest
|
|
1093
1135
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1095,7 +1137,7 @@ export default class Client extends OpenApi {
|
|
|
1095
1137
|
*/
|
|
1096
1138
|
describeInstanceRecoverTimeWithOptions(request: $_model.DescribeInstanceRecoverTimeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeInstanceRecoverTimeResponse>;
|
|
1097
1139
|
/**
|
|
1098
|
-
* Queries the time
|
|
1140
|
+
* Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks.
|
|
1099
1141
|
*
|
|
1100
1142
|
* @param request - DescribeInstanceRecoverTimeRequest
|
|
1101
1143
|
* @returns DescribeInstanceRecoverTimeResponse
|
|
@@ -1138,13 +1180,13 @@ export default class Client extends OpenApi {
|
|
|
1138
1180
|
*/
|
|
1139
1181
|
describeKmsKeys(request: $_model.DescribeKmsKeysRequest): Promise<$_model.DescribeKmsKeysResponse>;
|
|
1140
1182
|
/**
|
|
1141
|
-
*
|
|
1183
|
+
* You can view the configuration of MongoDB Log Service.
|
|
1142
1184
|
*
|
|
1143
1185
|
* @remarks
|
|
1144
|
-
* This
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1147
|
-
*
|
|
1186
|
+
* This API applies to General-purpose and Dedicated instances that use local disks.
|
|
1187
|
+
* You can enable the audit log feature for ApsaraDB for MongoDB as needed. For more information, see [Enable audit logs](https://help.aliyun.com/document_detail/59903.html).
|
|
1188
|
+
* - As of January 6, 2022, the official version of the audit log feature is being rolled out to all regions. New requests for the free trial version are no longer accepted. For more information, see [[Notice\\] ApsaraDB for MongoDB launches pay-as-you-go audit logs and discontinues the free trial](~~377480~~).
|
|
1189
|
+
* - The official version of the audit log feature is pay-as-you-go. Charges are based on storage usage and retention period. For pricing details, see <props="china">[ApsaraDB for MongoDB pricing](https://www.aliyun.com/price/product?#/mongodb/detail/badds)<props="intl">[ApsaraDB for MongoDB pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).
|
|
1148
1190
|
*
|
|
1149
1191
|
* @param request - DescribeMongoDBLogConfigRequest
|
|
1150
1192
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1152,13 +1194,13 @@ export default class Client extends OpenApi {
|
|
|
1152
1194
|
*/
|
|
1153
1195
|
describeMongoDBLogConfigWithOptions(request: $_model.DescribeMongoDBLogConfigRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeMongoDBLogConfigResponse>;
|
|
1154
1196
|
/**
|
|
1155
|
-
*
|
|
1197
|
+
* You can view the configuration of MongoDB Log Service.
|
|
1156
1198
|
*
|
|
1157
1199
|
* @remarks
|
|
1158
|
-
* This
|
|
1159
|
-
*
|
|
1160
|
-
*
|
|
1161
|
-
*
|
|
1200
|
+
* This API applies to General-purpose and Dedicated instances that use local disks.
|
|
1201
|
+
* You can enable the audit log feature for ApsaraDB for MongoDB as needed. For more information, see [Enable audit logs](https://help.aliyun.com/document_detail/59903.html).
|
|
1202
|
+
* - As of January 6, 2022, the official version of the audit log feature is being rolled out to all regions. New requests for the free trial version are no longer accepted. For more information, see [[Notice\\] ApsaraDB for MongoDB launches pay-as-you-go audit logs and discontinues the free trial](~~377480~~).
|
|
1203
|
+
* - The official version of the audit log feature is pay-as-you-go. Charges are based on storage usage and retention period. For pricing details, see <props="china">[ApsaraDB for MongoDB pricing](https://www.aliyun.com/price/product?#/mongodb/detail/badds)<props="intl">[ApsaraDB for MongoDB pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).
|
|
1162
1204
|
*
|
|
1163
1205
|
* @param request - DescribeMongoDBLogConfigRequest
|
|
1164
1206
|
* @returns DescribeMongoDBLogConfigResponse
|
|
@@ -1180,7 +1222,7 @@ export default class Client extends OpenApi {
|
|
|
1180
1222
|
*/
|
|
1181
1223
|
describeParameterModificationHistory(request: $_model.DescribeParameterModificationHistoryRequest): Promise<$_model.DescribeParameterModificationHistoryResponse>;
|
|
1182
1224
|
/**
|
|
1183
|
-
* Queries the
|
|
1225
|
+
* Queries the default parameter templates for MongoDB instances.
|
|
1184
1226
|
*
|
|
1185
1227
|
* @param request - DescribeParameterTemplatesRequest
|
|
1186
1228
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1188,7 +1230,7 @@ export default class Client extends OpenApi {
|
|
|
1188
1230
|
*/
|
|
1189
1231
|
describeParameterTemplatesWithOptions(request: $_model.DescribeParameterTemplatesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeParameterTemplatesResponse>;
|
|
1190
1232
|
/**
|
|
1191
|
-
* Queries the
|
|
1233
|
+
* Queries the default parameter templates for MongoDB instances.
|
|
1192
1234
|
*
|
|
1193
1235
|
* @param request - DescribeParameterTemplatesRequest
|
|
1194
1236
|
* @returns DescribeParameterTemplatesResponse
|
|
@@ -1210,7 +1252,7 @@ export default class Client extends OpenApi {
|
|
|
1210
1252
|
*/
|
|
1211
1253
|
describeParameters(request: $_model.DescribeParametersRequest): Promise<$_model.DescribeParametersResponse>;
|
|
1212
1254
|
/**
|
|
1213
|
-
*
|
|
1255
|
+
* Query prices.
|
|
1214
1256
|
*
|
|
1215
1257
|
* @param request - DescribePriceRequest
|
|
1216
1258
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1218,30 +1260,50 @@ export default class Client extends OpenApi {
|
|
|
1218
1260
|
*/
|
|
1219
1261
|
describePriceWithOptions(request: $_model.DescribePriceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePriceResponse>;
|
|
1220
1262
|
/**
|
|
1221
|
-
*
|
|
1263
|
+
* Query prices.
|
|
1222
1264
|
*
|
|
1223
1265
|
* @param request - DescribePriceRequest
|
|
1224
1266
|
* @returns DescribePriceResponse
|
|
1225
1267
|
*/
|
|
1226
1268
|
describePrice(request: $_model.DescribePriceRequest): Promise<$_model.DescribePriceResponse>;
|
|
1227
1269
|
/**
|
|
1270
|
+
* Retrieves a list of vSwitches.
|
|
1271
|
+
*
|
|
1272
|
+
* @remarks
|
|
1273
|
+
* Queries the vSwitches that are available in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a vSwitch.
|
|
1274
|
+
*
|
|
1228
1275
|
* @param request - DescribeRdsVSwitchsRequest
|
|
1229
1276
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1230
1277
|
* @returns DescribeRdsVSwitchsResponse
|
|
1231
1278
|
*/
|
|
1232
1279
|
describeRdsVSwitchsWithOptions(request: $_model.DescribeRdsVSwitchsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRdsVSwitchsResponse>;
|
|
1233
1280
|
/**
|
|
1281
|
+
* Retrieves a list of vSwitches.
|
|
1282
|
+
*
|
|
1283
|
+
* @remarks
|
|
1284
|
+
* Queries the vSwitches that are available in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a vSwitch.
|
|
1285
|
+
*
|
|
1234
1286
|
* @param request - DescribeRdsVSwitchsRequest
|
|
1235
1287
|
* @returns DescribeRdsVSwitchsResponse
|
|
1236
1288
|
*/
|
|
1237
1289
|
describeRdsVSwitchs(request: $_model.DescribeRdsVSwitchsRequest): Promise<$_model.DescribeRdsVSwitchsResponse>;
|
|
1238
1290
|
/**
|
|
1291
|
+
* Retrieves a list of VPCs.
|
|
1292
|
+
*
|
|
1293
|
+
* @remarks
|
|
1294
|
+
* Queries available VPCs in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a VPC.
|
|
1295
|
+
*
|
|
1239
1296
|
* @param request - DescribeRdsVpcsRequest
|
|
1240
1297
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1241
1298
|
* @returns DescribeRdsVpcsResponse
|
|
1242
1299
|
*/
|
|
1243
1300
|
describeRdsVpcsWithOptions(request: $_model.DescribeRdsVpcsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRdsVpcsResponse>;
|
|
1244
1301
|
/**
|
|
1302
|
+
* Retrieves a list of VPCs.
|
|
1303
|
+
*
|
|
1304
|
+
* @remarks
|
|
1305
|
+
* Queries available VPCs in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a VPC.
|
|
1306
|
+
*
|
|
1245
1307
|
* @param request - DescribeRdsVpcsRequest
|
|
1246
1308
|
* @returns DescribeRdsVpcsResponse
|
|
1247
1309
|
*/
|
|
@@ -1250,7 +1312,7 @@ export default class Client extends OpenApi {
|
|
|
1250
1312
|
* Queries all regions and zones supported for an ApsaraDB for MongoDB instance.
|
|
1251
1313
|
*
|
|
1252
1314
|
* @remarks
|
|
1253
|
-
* >
|
|
1315
|
+
* > To query available regions and zones in which an ApsaraDB for MongoDB instance can be created, call the [DescribeAvailableResource](https://help.aliyun.com/document_detail/149719.html) operation.
|
|
1254
1316
|
*
|
|
1255
1317
|
* @param request - DescribeRegionsRequest
|
|
1256
1318
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1261,17 +1323,17 @@ export default class Client extends OpenApi {
|
|
|
1261
1323
|
* Queries all regions and zones supported for an ApsaraDB for MongoDB instance.
|
|
1262
1324
|
*
|
|
1263
1325
|
* @remarks
|
|
1264
|
-
* >
|
|
1326
|
+
* > To query available regions and zones in which an ApsaraDB for MongoDB instance can be created, call the [DescribeAvailableResource](https://help.aliyun.com/document_detail/149719.html) operation.
|
|
1265
1327
|
*
|
|
1266
1328
|
* @param request - DescribeRegionsRequest
|
|
1267
1329
|
* @returns DescribeRegionsResponse
|
|
1268
1330
|
*/
|
|
1269
1331
|
describeRegions(request: $_model.DescribeRegionsRequest): Promise<$_model.DescribeRegionsResponse>;
|
|
1270
1332
|
/**
|
|
1271
|
-
*
|
|
1333
|
+
* Get the price to renew a specific MongoDB instance for one month.
|
|
1272
1334
|
*
|
|
1273
1335
|
* @remarks
|
|
1274
|
-
* This operation
|
|
1336
|
+
* This operation applies to subscription MongoDB instances.
|
|
1275
1337
|
*
|
|
1276
1338
|
* @param request - DescribeRenewalPriceRequest
|
|
1277
1339
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1279,20 +1341,20 @@ export default class Client extends OpenApi {
|
|
|
1279
1341
|
*/
|
|
1280
1342
|
describeRenewalPriceWithOptions(request: $_model.DescribeRenewalPriceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRenewalPriceResponse>;
|
|
1281
1343
|
/**
|
|
1282
|
-
*
|
|
1344
|
+
* Get the price to renew a specific MongoDB instance for one month.
|
|
1283
1345
|
*
|
|
1284
1346
|
* @remarks
|
|
1285
|
-
* This operation
|
|
1347
|
+
* This operation applies to subscription MongoDB instances.
|
|
1286
1348
|
*
|
|
1287
1349
|
* @param request - DescribeRenewalPriceRequest
|
|
1288
1350
|
* @returns DescribeRenewalPriceResponse
|
|
1289
1351
|
*/
|
|
1290
1352
|
describeRenewalPrice(request: $_model.DescribeRenewalPriceRequest): Promise<$_model.DescribeRenewalPriceResponse>;
|
|
1291
1353
|
/**
|
|
1292
|
-
*
|
|
1354
|
+
* Retrieves the role information and connection details for a MongoDB instance.
|
|
1293
1355
|
*
|
|
1294
1356
|
* @remarks
|
|
1295
|
-
* This operation
|
|
1357
|
+
* This operation applies to replica set instances and single-node instances. It does not apply to sharded cluster instances.
|
|
1296
1358
|
*
|
|
1297
1359
|
* @param request - DescribeReplicaSetRoleRequest
|
|
1298
1360
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1300,10 +1362,10 @@ export default class Client extends OpenApi {
|
|
|
1300
1362
|
*/
|
|
1301
1363
|
describeReplicaSetRoleWithOptions(request: $_model.DescribeReplicaSetRoleRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeReplicaSetRoleResponse>;
|
|
1302
1364
|
/**
|
|
1303
|
-
*
|
|
1365
|
+
* Retrieves the role information and connection details for a MongoDB instance.
|
|
1304
1366
|
*
|
|
1305
1367
|
* @remarks
|
|
1306
|
-
* This operation
|
|
1368
|
+
* This operation applies to replica set instances and single-node instances. It does not apply to sharded cluster instances.
|
|
1307
1369
|
*
|
|
1308
1370
|
* @param request - DescribeReplicaSetRoleRequest
|
|
1309
1371
|
* @returns DescribeReplicaSetRoleResponse
|
|
@@ -1325,12 +1387,16 @@ export default class Client extends OpenApi {
|
|
|
1325
1387
|
*/
|
|
1326
1388
|
describeRestoreDBInstanceList(request: $_model.DescribeRestoreDBInstanceListRequest): Promise<$_model.DescribeRestoreDBInstanceListResponse>;
|
|
1327
1389
|
/**
|
|
1390
|
+
* Describes the status of a tag for a node.
|
|
1391
|
+
*
|
|
1328
1392
|
* @param request - DescribeRoleTagStatusRequest
|
|
1329
1393
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1330
1394
|
* @returns DescribeRoleTagStatusResponse
|
|
1331
1395
|
*/
|
|
1332
1396
|
describeRoleTagStatusWithOptions(request: $_model.DescribeRoleTagStatusRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRoleTagStatusResponse>;
|
|
1333
1397
|
/**
|
|
1398
|
+
* Describes the status of a tag for a node.
|
|
1399
|
+
*
|
|
1334
1400
|
* @param request - DescribeRoleTagStatusRequest
|
|
1335
1401
|
* @returns DescribeRoleTagStatusResponse
|
|
1336
1402
|
*/
|
|
@@ -1359,11 +1425,11 @@ export default class Client extends OpenApi {
|
|
|
1359
1425
|
*/
|
|
1360
1426
|
describeRoleZoneInfo(request: $_model.DescribeRoleZoneInfoRequest): Promise<$_model.DescribeRoleZoneInfoResponse>;
|
|
1361
1427
|
/**
|
|
1362
|
-
*
|
|
1428
|
+
* View the running logs for a MongoDB instance.
|
|
1363
1429
|
*
|
|
1364
1430
|
* @remarks
|
|
1365
|
-
*
|
|
1366
|
-
*
|
|
1431
|
+
* - This API is for instances with the following specification types: **general-purpose local disk**, **dedicated local disk**, and **cloud disk**.
|
|
1432
|
+
* - This API is limited to 30 calls per minute. Exceeding this limit triggers rate limiting, so avoid high-frequency calls. For high-frequency operations, use Logstore. For more information, see [Manage Logstore](https://help.aliyun.com/document_detail/48990.html).
|
|
1367
1433
|
*
|
|
1368
1434
|
* @param request - DescribeRunningLogRecordsRequest
|
|
1369
1435
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1371,11 +1437,11 @@ export default class Client extends OpenApi {
|
|
|
1371
1437
|
*/
|
|
1372
1438
|
describeRunningLogRecordsWithOptions(request: $_model.DescribeRunningLogRecordsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeRunningLogRecordsResponse>;
|
|
1373
1439
|
/**
|
|
1374
|
-
*
|
|
1440
|
+
* View the running logs for a MongoDB instance.
|
|
1375
1441
|
*
|
|
1376
1442
|
* @remarks
|
|
1377
|
-
*
|
|
1378
|
-
*
|
|
1443
|
+
* - This API is for instances with the following specification types: **general-purpose local disk**, **dedicated local disk**, and **cloud disk**.
|
|
1444
|
+
* - This API is limited to 30 calls per minute. Exceeding this limit triggers rate limiting, so avoid high-frequency calls. For high-frequency operations, use Logstore. For more information, see [Manage Logstore](https://help.aliyun.com/document_detail/48990.html).
|
|
1379
1445
|
*
|
|
1380
1446
|
* @param request - DescribeRunningLogRecordsRequest
|
|
1381
1447
|
* @returns DescribeRunningLogRecordsResponse
|
|
@@ -1397,7 +1463,7 @@ export default class Client extends OpenApi {
|
|
|
1397
1463
|
*/
|
|
1398
1464
|
describeSecurityGroupConfiguration(request: $_model.DescribeSecurityGroupConfigurationRequest): Promise<$_model.DescribeSecurityGroupConfigurationResponse>;
|
|
1399
1465
|
/**
|
|
1400
|
-
*
|
|
1466
|
+
* Retrieves the IP whitelists of an ApsaraDB for MongoDB instance.
|
|
1401
1467
|
*
|
|
1402
1468
|
* @param request - DescribeSecurityIpsRequest
|
|
1403
1469
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1405,17 +1471,17 @@ export default class Client extends OpenApi {
|
|
|
1405
1471
|
*/
|
|
1406
1472
|
describeSecurityIpsWithOptions(request: $_model.DescribeSecurityIpsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSecurityIpsResponse>;
|
|
1407
1473
|
/**
|
|
1408
|
-
*
|
|
1474
|
+
* Retrieves the IP whitelists of an ApsaraDB for MongoDB instance.
|
|
1409
1475
|
*
|
|
1410
1476
|
* @param request - DescribeSecurityIpsRequest
|
|
1411
1477
|
* @returns DescribeSecurityIpsResponse
|
|
1412
1478
|
*/
|
|
1413
1479
|
describeSecurityIps(request: $_model.DescribeSecurityIpsRequest): Promise<$_model.DescribeSecurityIpsResponse>;
|
|
1414
1480
|
/**
|
|
1415
|
-
*
|
|
1481
|
+
* Retrieves the connection information for a MongoDB sharded cluster instance.
|
|
1416
1482
|
*
|
|
1417
1483
|
* @remarks
|
|
1418
|
-
* This
|
|
1484
|
+
* This API is for sharded cluster instances only.
|
|
1419
1485
|
*
|
|
1420
1486
|
* @param request - DescribeShardingNetworkAddressRequest
|
|
1421
1487
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1423,21 +1489,21 @@ export default class Client extends OpenApi {
|
|
|
1423
1489
|
*/
|
|
1424
1490
|
describeShardingNetworkAddressWithOptions(request: $_model.DescribeShardingNetworkAddressRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeShardingNetworkAddressResponse>;
|
|
1425
1491
|
/**
|
|
1426
|
-
*
|
|
1492
|
+
* Retrieves the connection information for a MongoDB sharded cluster instance.
|
|
1427
1493
|
*
|
|
1428
1494
|
* @remarks
|
|
1429
|
-
* This
|
|
1495
|
+
* This API is for sharded cluster instances only.
|
|
1430
1496
|
*
|
|
1431
1497
|
* @param request - DescribeShardingNetworkAddressRequest
|
|
1432
1498
|
* @returns DescribeShardingNetworkAddressResponse
|
|
1433
1499
|
*/
|
|
1434
1500
|
describeShardingNetworkAddress(request: $_model.DescribeShardingNetworkAddressRequest): Promise<$_model.DescribeShardingNetworkAddressResponse>;
|
|
1435
1501
|
/**
|
|
1436
|
-
* Queries
|
|
1502
|
+
* Queries slow query log entries for a MongoDB instance.
|
|
1437
1503
|
*
|
|
1438
1504
|
* @remarks
|
|
1439
|
-
*
|
|
1440
|
-
*
|
|
1505
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
1506
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
1441
1507
|
*
|
|
1442
1508
|
* @param request - DescribeSlowLogRecordsRequest
|
|
1443
1509
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1445,11 +1511,11 @@ export default class Client extends OpenApi {
|
|
|
1445
1511
|
*/
|
|
1446
1512
|
describeSlowLogRecordsWithOptions(request: $_model.DescribeSlowLogRecordsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeSlowLogRecordsResponse>;
|
|
1447
1513
|
/**
|
|
1448
|
-
* Queries
|
|
1514
|
+
* Queries slow query log entries for a MongoDB instance.
|
|
1449
1515
|
*
|
|
1450
1516
|
* @remarks
|
|
1451
|
-
*
|
|
1452
|
-
*
|
|
1517
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
1518
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
1453
1519
|
*
|
|
1454
1520
|
* @param request - DescribeSlowLogRecordsRequest
|
|
1455
1521
|
* @returns DescribeSlowLogRecordsResponse
|
|
@@ -1471,10 +1537,10 @@ export default class Client extends OpenApi {
|
|
|
1471
1537
|
*/
|
|
1472
1538
|
describeTags(request: $_model.DescribeTagsRequest): Promise<$_model.DescribeTagsResponse>;
|
|
1473
1539
|
/**
|
|
1474
|
-
* Queries the
|
|
1540
|
+
* Queries the custom keys for an instance.
|
|
1475
1541
|
*
|
|
1476
1542
|
* @remarks
|
|
1477
|
-
* You can use the custom
|
|
1543
|
+
* You can use the custom keys returned by this operation to enable transparent data encryption (TDE). For more information, see [ModifyDBInstanceTDE](https://help.aliyun.com/document_detail/131267.html).
|
|
1478
1544
|
*
|
|
1479
1545
|
* @param request - DescribeUserEncryptionKeyListRequest
|
|
1480
1546
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1482,22 +1548,26 @@ export default class Client extends OpenApi {
|
|
|
1482
1548
|
*/
|
|
1483
1549
|
describeUserEncryptionKeyListWithOptions(request: $_model.DescribeUserEncryptionKeyListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeUserEncryptionKeyListResponse>;
|
|
1484
1550
|
/**
|
|
1485
|
-
* Queries the
|
|
1551
|
+
* Queries the custom keys for an instance.
|
|
1486
1552
|
*
|
|
1487
1553
|
* @remarks
|
|
1488
|
-
* You can use the custom
|
|
1554
|
+
* You can use the custom keys returned by this operation to enable transparent data encryption (TDE). For more information, see [ModifyDBInstanceTDE](https://help.aliyun.com/document_detail/131267.html).
|
|
1489
1555
|
*
|
|
1490
1556
|
* @param request - DescribeUserEncryptionKeyListRequest
|
|
1491
1557
|
* @returns DescribeUserEncryptionKeyListResponse
|
|
1492
1558
|
*/
|
|
1493
1559
|
describeUserEncryptionKeyList(request: $_model.DescribeUserEncryptionKeyListRequest): Promise<$_model.DescribeUserEncryptionKeyListResponse>;
|
|
1494
1560
|
/**
|
|
1561
|
+
* Queries a paginated list of VPCs.
|
|
1562
|
+
*
|
|
1495
1563
|
* @param request - DescribeVpcsForMongoDBRequest
|
|
1496
1564
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1497
1565
|
* @returns DescribeVpcsForMongoDBResponse
|
|
1498
1566
|
*/
|
|
1499
1567
|
describeVpcsForMongoDBWithOptions(request: $_model.DescribeVpcsForMongoDBRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeVpcsForMongoDBResponse>;
|
|
1500
1568
|
/**
|
|
1569
|
+
* Queries a paginated list of VPCs.
|
|
1570
|
+
*
|
|
1501
1571
|
* @param request - DescribeVpcsForMongoDBRequest
|
|
1502
1572
|
* @returns DescribeVpcsForMongoDBResponse
|
|
1503
1573
|
*/
|
|
@@ -1534,11 +1604,11 @@ export default class Client extends OpenApi {
|
|
|
1534
1604
|
*/
|
|
1535
1605
|
destroyInstance(request: $_model.DestroyInstanceRequest): Promise<$_model.DestroyInstanceResponse>;
|
|
1536
1606
|
/**
|
|
1537
|
-
*
|
|
1607
|
+
* Evaluate resource availability before purchasing a new instance or changing the configuration of an existing instance.
|
|
1538
1608
|
*
|
|
1539
1609
|
* @remarks
|
|
1540
|
-
*
|
|
1541
|
-
* > You can call this operation
|
|
1610
|
+
* Evaluate resource availability for MongoDB replica set instances and sharded cluster instances. Supported scenarios include purchasing a new instance, changing an instance configuration, and adding nodes to a sharded cluster.
|
|
1611
|
+
* > You can call this operation up to 200 times per minute. Calls that exceed this limit are subject to traffic throttling.
|
|
1542
1612
|
*
|
|
1543
1613
|
* @param request - EvaluateResourceRequest
|
|
1544
1614
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1546,11 +1616,11 @@ export default class Client extends OpenApi {
|
|
|
1546
1616
|
*/
|
|
1547
1617
|
evaluateResourceWithOptions(request: $_model.EvaluateResourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.EvaluateResourceResponse>;
|
|
1548
1618
|
/**
|
|
1549
|
-
*
|
|
1619
|
+
* Evaluate resource availability before purchasing a new instance or changing the configuration of an existing instance.
|
|
1550
1620
|
*
|
|
1551
1621
|
* @remarks
|
|
1552
|
-
*
|
|
1553
|
-
* > You can call this operation
|
|
1622
|
+
* Evaluate resource availability for MongoDB replica set instances and sharded cluster instances. Supported scenarios include purchasing a new instance, changing an instance configuration, and adding nodes to a sharded cluster.
|
|
1623
|
+
* > You can call this operation up to 200 times per minute. Calls that exceed this limit are subject to traffic throttling.
|
|
1554
1624
|
*
|
|
1555
1625
|
* @param request - EvaluateResourceRequest
|
|
1556
1626
|
* @returns EvaluateResourceResponse
|
|
@@ -1575,11 +1645,11 @@ export default class Client extends OpenApi {
|
|
|
1575
1645
|
* Migrates an ApsaraDB for MongoDB instance to a specific zone.
|
|
1576
1646
|
*
|
|
1577
1647
|
* @remarks
|
|
1578
|
-
*
|
|
1579
|
-
*
|
|
1580
|
-
*
|
|
1581
|
-
*
|
|
1582
|
-
*
|
|
1648
|
+
* - This operation is available only for replica set instances that run MongoDB 4.2 or earlier and sharded cluster instances.
|
|
1649
|
+
* - If you have applied for a public endpoint for the ApsaraDB for MongoDB instance, you must call the [ReleasePublicNetworkAddress](https://help.aliyun.com/document_detail/67604.html) operation to release the public endpoint before you call the MigrateAvailableZone operation.
|
|
1650
|
+
* - Transparent data encryption (TDE) is disabled for the ApsaraDB for MongoDB instance.
|
|
1651
|
+
* - The source zone and the destination zone belong to the same region.
|
|
1652
|
+
* - A vSwitch is created in the destination zone. This prerequisite must be met if the instance resides in a virtual private cloud (VPC). For more information about how to create a vSwitch, see [Work with vSwitches](https://help.aliyun.com/document_detail/65387.html).
|
|
1583
1653
|
*
|
|
1584
1654
|
* @param request - MigrateAvailableZoneRequest
|
|
1585
1655
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1590,22 +1660,22 @@ export default class Client extends OpenApi {
|
|
|
1590
1660
|
* Migrates an ApsaraDB for MongoDB instance to a specific zone.
|
|
1591
1661
|
*
|
|
1592
1662
|
* @remarks
|
|
1593
|
-
*
|
|
1594
|
-
*
|
|
1595
|
-
*
|
|
1596
|
-
*
|
|
1597
|
-
*
|
|
1663
|
+
* - This operation is available only for replica set instances that run MongoDB 4.2 or earlier and sharded cluster instances.
|
|
1664
|
+
* - If you have applied for a public endpoint for the ApsaraDB for MongoDB instance, you must call the [ReleasePublicNetworkAddress](https://help.aliyun.com/document_detail/67604.html) operation to release the public endpoint before you call the MigrateAvailableZone operation.
|
|
1665
|
+
* - Transparent data encryption (TDE) is disabled for the ApsaraDB for MongoDB instance.
|
|
1666
|
+
* - The source zone and the destination zone belong to the same region.
|
|
1667
|
+
* - A vSwitch is created in the destination zone. This prerequisite must be met if the instance resides in a virtual private cloud (VPC). For more information about how to create a vSwitch, see [Work with vSwitches](https://help.aliyun.com/document_detail/65387.html).
|
|
1598
1668
|
*
|
|
1599
1669
|
* @param request - MigrateAvailableZoneRequest
|
|
1600
1670
|
* @returns MigrateAvailableZoneResponse
|
|
1601
1671
|
*/
|
|
1602
1672
|
migrateAvailableZone(request: $_model.MigrateAvailableZoneRequest): Promise<$_model.MigrateAvailableZoneResponse>;
|
|
1603
1673
|
/**
|
|
1604
|
-
*
|
|
1674
|
+
* Migrates an ApsaraDB for MongoDB instance to another zone.
|
|
1605
1675
|
*
|
|
1606
1676
|
* @remarks
|
|
1607
1677
|
* This operation is applicable only to replica set instances, but not to standalone instances or sharded cluster instances.
|
|
1608
|
-
* >
|
|
1678
|
+
* > If you have applied for a public endpoint of the instance, you must first call the [ReleasePublicNetworkAddress](https://help.aliyun.com/document_detail/67604.html) operation to release the public endpoint.
|
|
1609
1679
|
*
|
|
1610
1680
|
* @param request - MigrateToOtherZoneRequest
|
|
1611
1681
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1613,11 +1683,11 @@ export default class Client extends OpenApi {
|
|
|
1613
1683
|
*/
|
|
1614
1684
|
migrateToOtherZoneWithOptions(request: $_model.MigrateToOtherZoneRequest, runtime: $dara.RuntimeOptions): Promise<$_model.MigrateToOtherZoneResponse>;
|
|
1615
1685
|
/**
|
|
1616
|
-
*
|
|
1686
|
+
* Migrates an ApsaraDB for MongoDB instance to another zone.
|
|
1617
1687
|
*
|
|
1618
1688
|
* @remarks
|
|
1619
1689
|
* This operation is applicable only to replica set instances, but not to standalone instances or sharded cluster instances.
|
|
1620
|
-
* >
|
|
1690
|
+
* > If you have applied for a public endpoint of the instance, you must first call the [ReleasePublicNetworkAddress](https://help.aliyun.com/document_detail/67604.html) operation to release the public endpoint.
|
|
1621
1691
|
*
|
|
1622
1692
|
* @param request - MigrateToOtherZoneRequest
|
|
1623
1693
|
* @returns MigrateToOtherZoneResponse
|
|
@@ -1626,6 +1696,9 @@ export default class Client extends OpenApi {
|
|
|
1626
1696
|
/**
|
|
1627
1697
|
* Modifies the description of the root account in an ApsaraDB for MongoDB instance.
|
|
1628
1698
|
*
|
|
1699
|
+
* @remarks
|
|
1700
|
+
* This operation is not supported for sharded cluster instances.
|
|
1701
|
+
*
|
|
1629
1702
|
* @param request - ModifyAccountDescriptionRequest
|
|
1630
1703
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1631
1704
|
* @returns ModifyAccountDescriptionResponse
|
|
@@ -1634,12 +1707,15 @@ export default class Client extends OpenApi {
|
|
|
1634
1707
|
/**
|
|
1635
1708
|
* Modifies the description of the root account in an ApsaraDB for MongoDB instance.
|
|
1636
1709
|
*
|
|
1710
|
+
* @remarks
|
|
1711
|
+
* This operation is not supported for sharded cluster instances.
|
|
1712
|
+
*
|
|
1637
1713
|
* @param request - ModifyAccountDescriptionRequest
|
|
1638
1714
|
* @returns ModifyAccountDescriptionResponse
|
|
1639
1715
|
*/
|
|
1640
1716
|
modifyAccountDescription(request: $_model.ModifyAccountDescriptionRequest): Promise<$_model.ModifyAccountDescriptionResponse>;
|
|
1641
1717
|
/**
|
|
1642
|
-
* Modifies the O
|
|
1718
|
+
* Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
1643
1719
|
*
|
|
1644
1720
|
* @param request - ModifyActiveOperationMaintenanceConfigRequest
|
|
1645
1721
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1647,7 +1723,7 @@ export default class Client extends OpenApi {
|
|
|
1647
1723
|
*/
|
|
1648
1724
|
modifyActiveOperationMaintenanceConfigWithOptions(request: $_model.ModifyActiveOperationMaintenanceConfigRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyActiveOperationMaintenanceConfigResponse>;
|
|
1649
1725
|
/**
|
|
1650
|
-
* Modifies the O
|
|
1726
|
+
* Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
1651
1727
|
*
|
|
1652
1728
|
* @param request - ModifyActiveOperationMaintenanceConfigRequest
|
|
1653
1729
|
* @returns ModifyActiveOperationMaintenanceConfigResponse
|
|
@@ -1669,12 +1745,12 @@ export default class Client extends OpenApi {
|
|
|
1669
1745
|
*/
|
|
1670
1746
|
modifyActiveOperationTasks(request: $_model.ModifyActiveOperationTasksRequest): Promise<$_model.ModifyActiveOperationTasksResponse>;
|
|
1671
1747
|
/**
|
|
1672
|
-
*
|
|
1748
|
+
* Modifies the audit log types collected for a MongoDB instance.
|
|
1673
1749
|
*
|
|
1674
1750
|
* @remarks
|
|
1675
|
-
*
|
|
1676
|
-
*
|
|
1677
|
-
*
|
|
1751
|
+
* - The instance must be in the running state when you call this operation.
|
|
1752
|
+
* - This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
|
|
1753
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
1678
1754
|
*
|
|
1679
1755
|
* @param request - ModifyAuditLogFilterRequest
|
|
1680
1756
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1682,23 +1758,22 @@ export default class Client extends OpenApi {
|
|
|
1682
1758
|
*/
|
|
1683
1759
|
modifyAuditLogFilterWithOptions(request: $_model.ModifyAuditLogFilterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyAuditLogFilterResponse>;
|
|
1684
1760
|
/**
|
|
1685
|
-
*
|
|
1761
|
+
* Modifies the audit log types collected for a MongoDB instance.
|
|
1686
1762
|
*
|
|
1687
1763
|
* @remarks
|
|
1688
|
-
*
|
|
1689
|
-
*
|
|
1690
|
-
*
|
|
1764
|
+
* - The instance must be in the running state when you call this operation.
|
|
1765
|
+
* - This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
|
|
1766
|
+
* - 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](https://help.aliyun.com/document_detail/48990.html).
|
|
1691
1767
|
*
|
|
1692
1768
|
* @param request - ModifyAuditLogFilterRequest
|
|
1693
1769
|
* @returns ModifyAuditLogFilterResponse
|
|
1694
1770
|
*/
|
|
1695
1771
|
modifyAuditLogFilter(request: $_model.ModifyAuditLogFilterRequest): Promise<$_model.ModifyAuditLogFilterResponse>;
|
|
1696
1772
|
/**
|
|
1697
|
-
* Enables or disables the audit log
|
|
1773
|
+
* Enables or disables the audit log for a MongoDB instance, or modifies the log retention period.
|
|
1698
1774
|
*
|
|
1699
1775
|
* @remarks
|
|
1700
|
-
*
|
|
1701
|
-
* * 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](https://help.aliyun.com/document_detail/48990.html).
|
|
1776
|
+
* - You can call this operation up to 30 times per minute. The system throttles calls that exceed this limit. Avoid calling this operation frequently. If you need to make frequent calls, use Logstore. For more information, see [Manage Logstore](https://help.aliyun.com/document_detail/48990.html).
|
|
1702
1777
|
*
|
|
1703
1778
|
* @param request - ModifyAuditPolicyRequest
|
|
1704
1779
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1706,18 +1781,21 @@ export default class Client extends OpenApi {
|
|
|
1706
1781
|
*/
|
|
1707
1782
|
modifyAuditPolicyWithOptions(request: $_model.ModifyAuditPolicyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyAuditPolicyResponse>;
|
|
1708
1783
|
/**
|
|
1709
|
-
* Enables or disables the audit log
|
|
1784
|
+
* Enables or disables the audit log for a MongoDB instance, or modifies the log retention period.
|
|
1710
1785
|
*
|
|
1711
1786
|
* @remarks
|
|
1712
|
-
*
|
|
1713
|
-
* * 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](https://help.aliyun.com/document_detail/48990.html).
|
|
1787
|
+
* - You can call this operation up to 30 times per minute. The system throttles calls that exceed this limit. Avoid calling this operation frequently. If you need to make frequent calls, use Logstore. For more information, see [Manage Logstore](https://help.aliyun.com/document_detail/48990.html).
|
|
1714
1788
|
*
|
|
1715
1789
|
* @param request - ModifyAuditPolicyRequest
|
|
1716
1790
|
* @returns ModifyAuditPolicyResponse
|
|
1717
1791
|
*/
|
|
1718
1792
|
modifyAuditPolicy(request: $_model.ModifyAuditPolicyRequest): Promise<$_model.ModifyAuditPolicyResponse>;
|
|
1719
1793
|
/**
|
|
1720
|
-
* Modifies the
|
|
1794
|
+
* Modifies the time-to-live (TTL) of a MongoDB backup set.
|
|
1795
|
+
*
|
|
1796
|
+
* @remarks
|
|
1797
|
+
* You can modify the TTL only for manual backups.
|
|
1798
|
+
* This operation is applicable only to MongoDB instances that use cloud disks.
|
|
1721
1799
|
*
|
|
1722
1800
|
* @param request - ModifyBackupExpireTimeRequest
|
|
1723
1801
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1725,17 +1803,21 @@ export default class Client extends OpenApi {
|
|
|
1725
1803
|
*/
|
|
1726
1804
|
modifyBackupExpireTimeWithOptions(request: $_model.ModifyBackupExpireTimeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyBackupExpireTimeResponse>;
|
|
1727
1805
|
/**
|
|
1728
|
-
* Modifies the
|
|
1806
|
+
* Modifies the time-to-live (TTL) of a MongoDB backup set.
|
|
1807
|
+
*
|
|
1808
|
+
* @remarks
|
|
1809
|
+
* You can modify the TTL only for manual backups.
|
|
1810
|
+
* This operation is applicable only to MongoDB instances that use cloud disks.
|
|
1729
1811
|
*
|
|
1730
1812
|
* @param request - ModifyBackupExpireTimeRequest
|
|
1731
1813
|
* @returns ModifyBackupExpireTimeResponse
|
|
1732
1814
|
*/
|
|
1733
1815
|
modifyBackupExpireTime(request: $_model.ModifyBackupExpireTimeRequest): Promise<$_model.ModifyBackupExpireTimeResponse>;
|
|
1734
1816
|
/**
|
|
1735
|
-
* Modifies
|
|
1817
|
+
* Modifies the backup policy of a MongoDB instance.
|
|
1736
1818
|
*
|
|
1737
1819
|
* @remarks
|
|
1738
|
-
*
|
|
1820
|
+
* Geo-redundancy is available only for replica set instances and sharded cluster instances that use cloud disks.
|
|
1739
1821
|
*
|
|
1740
1822
|
* @param request - ModifyBackupPolicyRequest
|
|
1741
1823
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1743,17 +1825,20 @@ export default class Client extends OpenApi {
|
|
|
1743
1825
|
*/
|
|
1744
1826
|
modifyBackupPolicyWithOptions(request: $_model.ModifyBackupPolicyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyBackupPolicyResponse>;
|
|
1745
1827
|
/**
|
|
1746
|
-
* Modifies
|
|
1828
|
+
* Modifies the backup policy of a MongoDB instance.
|
|
1747
1829
|
*
|
|
1748
1830
|
* @remarks
|
|
1749
|
-
*
|
|
1831
|
+
* Geo-redundancy is available only for replica set instances and sharded cluster instances that use cloud disks.
|
|
1750
1832
|
*
|
|
1751
1833
|
* @param request - ModifyBackupPolicyRequest
|
|
1752
1834
|
* @returns ModifyBackupPolicyResponse
|
|
1753
1835
|
*/
|
|
1754
1836
|
modifyBackupPolicy(request: $_model.ModifyBackupPolicyRequest): Promise<$_model.ModifyBackupPolicyResponse>;
|
|
1755
1837
|
/**
|
|
1756
|
-
* Modifies
|
|
1838
|
+
* Modifies instance release protection configuration.
|
|
1839
|
+
*
|
|
1840
|
+
* @remarks
|
|
1841
|
+
* This operation is applicable only to pay-as-you-go instances.
|
|
1757
1842
|
*
|
|
1758
1843
|
* @param request - ModifyDBInstanceAttributeRequest
|
|
1759
1844
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1761,14 +1846,17 @@ export default class Client extends OpenApi {
|
|
|
1761
1846
|
*/
|
|
1762
1847
|
modifyDBInstanceAttributeWithOptions(request: $_model.ModifyDBInstanceAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceAttributeResponse>;
|
|
1763
1848
|
/**
|
|
1764
|
-
* Modifies
|
|
1849
|
+
* Modifies instance release protection configuration.
|
|
1850
|
+
*
|
|
1851
|
+
* @remarks
|
|
1852
|
+
* This operation is applicable only to pay-as-you-go instances.
|
|
1765
1853
|
*
|
|
1766
1854
|
* @param request - ModifyDBInstanceAttributeRequest
|
|
1767
1855
|
* @returns ModifyDBInstanceAttributeResponse
|
|
1768
1856
|
*/
|
|
1769
1857
|
modifyDBInstanceAttribute(request: $_model.ModifyDBInstanceAttributeRequest): Promise<$_model.ModifyDBInstanceAttributeResponse>;
|
|
1770
1858
|
/**
|
|
1771
|
-
* Modifies
|
|
1859
|
+
* Modifies instance configuration
|
|
1772
1860
|
*
|
|
1773
1861
|
* @param request - ModifyDBInstanceConfigRequest
|
|
1774
1862
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1776,19 +1864,19 @@ export default class Client extends OpenApi {
|
|
|
1776
1864
|
*/
|
|
1777
1865
|
modifyDBInstanceConfigWithOptions(request: $_model.ModifyDBInstanceConfigRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceConfigResponse>;
|
|
1778
1866
|
/**
|
|
1779
|
-
* Modifies
|
|
1867
|
+
* Modifies instance configuration
|
|
1780
1868
|
*
|
|
1781
1869
|
* @param request - ModifyDBInstanceConfigRequest
|
|
1782
1870
|
* @returns ModifyDBInstanceConfigResponse
|
|
1783
1871
|
*/
|
|
1784
1872
|
modifyDBInstanceConfig(request: $_model.ModifyDBInstanceConfigRequest): Promise<$_model.ModifyDBInstanceConfigResponse>;
|
|
1785
1873
|
/**
|
|
1786
|
-
* Modifies the
|
|
1874
|
+
* Modifies the connection address and port of a MongoDB instance.
|
|
1787
1875
|
*
|
|
1788
1876
|
* @remarks
|
|
1789
|
-
* You can modify the connection
|
|
1790
|
-
*
|
|
1791
|
-
*
|
|
1877
|
+
* You can modify the connection address and port for the following instance types:
|
|
1878
|
+
* - You can modify the connection address and port for instances that use local disks or cloud disks.
|
|
1879
|
+
* - For sharded cluster instances, you can modify only the connection address of Mongos nodes.
|
|
1792
1880
|
*
|
|
1793
1881
|
* @param request - ModifyDBInstanceConnectionStringRequest
|
|
1794
1882
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1796,12 +1884,12 @@ export default class Client extends OpenApi {
|
|
|
1796
1884
|
*/
|
|
1797
1885
|
modifyDBInstanceConnectionStringWithOptions(request: $_model.ModifyDBInstanceConnectionStringRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceConnectionStringResponse>;
|
|
1798
1886
|
/**
|
|
1799
|
-
* Modifies the
|
|
1887
|
+
* Modifies the connection address and port of a MongoDB instance.
|
|
1800
1888
|
*
|
|
1801
1889
|
* @remarks
|
|
1802
|
-
* You can modify the connection
|
|
1803
|
-
*
|
|
1804
|
-
*
|
|
1890
|
+
* You can modify the connection address and port for the following instance types:
|
|
1891
|
+
* - You can modify the connection address and port for instances that use local disks or cloud disks.
|
|
1892
|
+
* - For sharded cluster instances, you can modify only the connection address of Mongos nodes.
|
|
1805
1893
|
*
|
|
1806
1894
|
* @param request - ModifyDBInstanceConnectionStringRequest
|
|
1807
1895
|
* @returns ModifyDBInstanceConnectionStringResponse
|
|
@@ -1825,6 +1913,11 @@ export default class Client extends OpenApi {
|
|
|
1825
1913
|
/**
|
|
1826
1914
|
* Modifies the disk type of an ApsaraDB for MongoDB instance.
|
|
1827
1915
|
*
|
|
1916
|
+
* @remarks
|
|
1917
|
+
* - This feature is not supported for instances with less than 40 GB of disk space.
|
|
1918
|
+
* - You can change the disk type only to an ESSD AutoPL disk (cloud_auto).
|
|
1919
|
+
* - The interval between two consecutive modifications to the provisioned input/output operations per second (IOPS) of an instance must be longer than one hour. For more information, see [Modify the performance of an ESSD AutoPL disk](https://help.aliyun.com/document_detail/413275.html).
|
|
1920
|
+
*
|
|
1828
1921
|
* @param request - ModifyDBInstanceDiskTypeRequest
|
|
1829
1922
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1830
1923
|
* @returns ModifyDBInstanceDiskTypeResponse
|
|
@@ -1833,6 +1926,11 @@ export default class Client extends OpenApi {
|
|
|
1833
1926
|
/**
|
|
1834
1927
|
* Modifies the disk type of an ApsaraDB for MongoDB instance.
|
|
1835
1928
|
*
|
|
1929
|
+
* @remarks
|
|
1930
|
+
* - This feature is not supported for instances with less than 40 GB of disk space.
|
|
1931
|
+
* - You can change the disk type only to an ESSD AutoPL disk (cloud_auto).
|
|
1932
|
+
* - The interval between two consecutive modifications to the provisioned input/output operations per second (IOPS) of an instance must be longer than one hour. For more information, see [Modify the performance of an ESSD AutoPL disk](https://help.aliyun.com/document_detail/413275.html).
|
|
1933
|
+
*
|
|
1836
1934
|
* @param request - ModifyDBInstanceDiskTypeRequest
|
|
1837
1935
|
* @returns ModifyDBInstanceDiskTypeResponse
|
|
1838
1936
|
*/
|
|
@@ -1853,13 +1951,13 @@ export default class Client extends OpenApi {
|
|
|
1853
1951
|
*/
|
|
1854
1952
|
modifyDBInstanceMaintainTime(request: $_model.ModifyDBInstanceMaintainTimeRequest): Promise<$_model.ModifyDBInstanceMaintainTimeResponse>;
|
|
1855
1953
|
/**
|
|
1856
|
-
*
|
|
1954
|
+
* Set the monitoring collection granularity for a MongoDB instance.
|
|
1857
1955
|
*
|
|
1858
1956
|
* @remarks
|
|
1859
|
-
* >
|
|
1860
|
-
*
|
|
1861
|
-
*
|
|
1862
|
-
*
|
|
1957
|
+
* > Due to changes in the monitoring collection granularity adjustment feature, this operation is only applicable to the previous version of the MongoDB console.
|
|
1958
|
+
* To use this operation, the instance must meet the following requirements:
|
|
1959
|
+
* - A replica set or sharded cluster instance is used.
|
|
1960
|
+
* - MongoDB 3.4 (the latest minor version) or MongoDB 4.0 is selected.
|
|
1863
1961
|
*
|
|
1864
1962
|
* @param request - ModifyDBInstanceMonitorRequest
|
|
1865
1963
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1867,13 +1965,13 @@ export default class Client extends OpenApi {
|
|
|
1867
1965
|
*/
|
|
1868
1966
|
modifyDBInstanceMonitorWithOptions(request: $_model.ModifyDBInstanceMonitorRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceMonitorResponse>;
|
|
1869
1967
|
/**
|
|
1870
|
-
*
|
|
1968
|
+
* Set the monitoring collection granularity for a MongoDB instance.
|
|
1871
1969
|
*
|
|
1872
1970
|
* @remarks
|
|
1873
|
-
* >
|
|
1874
|
-
*
|
|
1875
|
-
*
|
|
1876
|
-
*
|
|
1971
|
+
* > Due to changes in the monitoring collection granularity adjustment feature, this operation is only applicable to the previous version of the MongoDB console.
|
|
1972
|
+
* To use this operation, the instance must meet the following requirements:
|
|
1973
|
+
* - A replica set or sharded cluster instance is used.
|
|
1974
|
+
* - MongoDB 3.4 (the latest minor version) or MongoDB 4.0 is selected.
|
|
1877
1975
|
*
|
|
1878
1976
|
* @param request - ModifyDBInstanceMonitorRequest
|
|
1879
1977
|
* @returns ModifyDBInstanceMonitorResponse
|
|
@@ -1884,9 +1982,9 @@ export default class Client extends OpenApi {
|
|
|
1884
1982
|
*
|
|
1885
1983
|
* @remarks
|
|
1886
1984
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
1887
|
-
*
|
|
1888
|
-
*
|
|
1889
|
-
* >
|
|
1985
|
+
* - The instance is in the Running state.
|
|
1986
|
+
* - The network of the instance is in hybrid access mode.
|
|
1987
|
+
* > This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
|
|
1890
1988
|
*
|
|
1891
1989
|
* @param request - ModifyDBInstanceNetExpireTimeRequest
|
|
1892
1990
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1898,19 +1996,20 @@ export default class Client extends OpenApi {
|
|
|
1898
1996
|
*
|
|
1899
1997
|
* @remarks
|
|
1900
1998
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
1901
|
-
*
|
|
1902
|
-
*
|
|
1903
|
-
* >
|
|
1999
|
+
* - The instance is in the Running state.
|
|
2000
|
+
* - The network of the instance is in hybrid access mode.
|
|
2001
|
+
* > This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
|
|
1904
2002
|
*
|
|
1905
2003
|
* @param request - ModifyDBInstanceNetExpireTimeRequest
|
|
1906
2004
|
* @returns ModifyDBInstanceNetExpireTimeResponse
|
|
1907
2005
|
*/
|
|
1908
2006
|
modifyDBInstanceNetExpireTime(request: $_model.ModifyDBInstanceNetExpireTimeRequest): Promise<$_model.ModifyDBInstanceNetExpireTimeResponse>;
|
|
1909
2007
|
/**
|
|
1910
|
-
*
|
|
2008
|
+
* Switches the network type of a MongoDB instance.
|
|
1911
2009
|
*
|
|
1912
2010
|
* @remarks
|
|
1913
|
-
* This operation
|
|
2011
|
+
* - This operation applies to replica set instances and sharded cluster instances. Single-node instances are not supported. Only the transform from the classic network type to the VPC network type is supported.
|
|
2012
|
+
* - This operation supports only instances that run MongoDB 4.2 or earlier and use local disks.
|
|
1914
2013
|
*
|
|
1915
2014
|
* @param request - ModifyDBInstanceNetworkTypeRequest
|
|
1916
2015
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1918,25 +2017,26 @@ export default class Client extends OpenApi {
|
|
|
1918
2017
|
*/
|
|
1919
2018
|
modifyDBInstanceNetworkTypeWithOptions(request: $_model.ModifyDBInstanceNetworkTypeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceNetworkTypeResponse>;
|
|
1920
2019
|
/**
|
|
1921
|
-
*
|
|
2020
|
+
* Switches the network type of a MongoDB instance.
|
|
1922
2021
|
*
|
|
1923
2022
|
* @remarks
|
|
1924
|
-
* This operation
|
|
2023
|
+
* - This operation applies to replica set instances and sharded cluster instances. Single-node instances are not supported. Only the transform from the classic network type to the VPC network type is supported.
|
|
2024
|
+
* - This operation supports only instances that run MongoDB 4.2 or earlier and use local disks.
|
|
1925
2025
|
*
|
|
1926
2026
|
* @param request - ModifyDBInstanceNetworkTypeRequest
|
|
1927
2027
|
* @returns ModifyDBInstanceNetworkTypeResponse
|
|
1928
2028
|
*/
|
|
1929
2029
|
modifyDBInstanceNetworkType(request: $_model.ModifyDBInstanceNetworkTypeRequest): Promise<$_model.ModifyDBInstanceNetworkTypeResponse>;
|
|
1930
2030
|
/**
|
|
1931
|
-
* Modifies the SSL
|
|
2031
|
+
* Modifies the SSL configuration of a MongoDB instance.
|
|
1932
2032
|
*
|
|
1933
2033
|
* @remarks
|
|
1934
|
-
*
|
|
1935
|
-
*
|
|
1936
|
-
*
|
|
1937
|
-
*
|
|
1938
|
-
*
|
|
1939
|
-
* >
|
|
2034
|
+
* Before you call the ModifyDBInstanceSSL operation, make sure that the instance meets the following requirements:
|
|
2035
|
+
* - The instance is in the running state.
|
|
2036
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
2037
|
+
* - The replica set instance is version 3.4 or later.
|
|
2038
|
+
* - The sharded cluster instance uses enhanced solid-state drives (ESSDs).
|
|
2039
|
+
* > Enabling, updating, or disabling SSL restarts the instance. We recommend that you perform these operations during off-peak hours.
|
|
1940
2040
|
*
|
|
1941
2041
|
* @param request - ModifyDBInstanceSSLRequest
|
|
1942
2042
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1944,26 +2044,26 @@ export default class Client extends OpenApi {
|
|
|
1944
2044
|
*/
|
|
1945
2045
|
modifyDBInstanceSSLWithOptions(request: $_model.ModifyDBInstanceSSLRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceSSLResponse>;
|
|
1946
2046
|
/**
|
|
1947
|
-
* Modifies the SSL
|
|
2047
|
+
* Modifies the SSL configuration of a MongoDB instance.
|
|
1948
2048
|
*
|
|
1949
2049
|
* @remarks
|
|
1950
|
-
*
|
|
1951
|
-
*
|
|
1952
|
-
*
|
|
1953
|
-
*
|
|
1954
|
-
*
|
|
1955
|
-
* >
|
|
2050
|
+
* Before you call the ModifyDBInstanceSSL operation, make sure that the instance meets the following requirements:
|
|
2051
|
+
* - The instance is in the running state.
|
|
2052
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
2053
|
+
* - The replica set instance is version 3.4 or later.
|
|
2054
|
+
* - The sharded cluster instance uses enhanced solid-state drives (ESSDs).
|
|
2055
|
+
* > Enabling, updating, or disabling SSL restarts the instance. We recommend that you perform these operations during off-peak hours.
|
|
1956
2056
|
*
|
|
1957
2057
|
* @param request - ModifyDBInstanceSSLRequest
|
|
1958
2058
|
* @returns ModifyDBInstanceSSLResponse
|
|
1959
2059
|
*/
|
|
1960
2060
|
modifyDBInstanceSSL(request: $_model.ModifyDBInstanceSSLRequest): Promise<$_model.ModifyDBInstanceSSLResponse>;
|
|
1961
2061
|
/**
|
|
1962
|
-
*
|
|
2062
|
+
* Changes the instance type or storage space for ApsaraDB for MongoDB standalone, replica set, or serverless instances. Serverless instances are exclusive to the Alibaba Cloud China website.
|
|
1963
2063
|
*
|
|
1964
2064
|
* @remarks
|
|
1965
|
-
* Before
|
|
1966
|
-
* This operation applies only to standalone and replica set instances. To
|
|
2065
|
+
* Before calling this operation, make sure you understand the billing method and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
2066
|
+
* This operation applies only to ApsaraDB for MongoDB<props="china"> standalone instances, replica set instances, and Serverless instances<props="intl"> standalone instances and replica set instances. To change the configuration of a sharded cluster instance, call the [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html), [CreateNode](https://help.aliyun.com/document_detail/61911.html), [DeleteNode](https://help.aliyun.com/document_detail/61922.html), or [ModifyNodeSpecBatch](https://help.aliyun.com/document_detail/61816.html) operations.
|
|
1967
2067
|
*
|
|
1968
2068
|
* @param request - ModifyDBInstanceSpecRequest
|
|
1969
2069
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1971,27 +2071,27 @@ export default class Client extends OpenApi {
|
|
|
1971
2071
|
*/
|
|
1972
2072
|
modifyDBInstanceSpecWithOptions(request: $_model.ModifyDBInstanceSpecRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceSpecResponse>;
|
|
1973
2073
|
/**
|
|
1974
|
-
*
|
|
2074
|
+
* Changes the instance type or storage space for ApsaraDB for MongoDB standalone, replica set, or serverless instances. Serverless instances are exclusive to the Alibaba Cloud China website.
|
|
1975
2075
|
*
|
|
1976
2076
|
* @remarks
|
|
1977
|
-
* Before
|
|
1978
|
-
* This operation applies only to standalone and replica set instances. To
|
|
2077
|
+
* Before calling this operation, make sure you understand the billing method and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
2078
|
+
* This operation applies only to ApsaraDB for MongoDB<props="china"> standalone instances, replica set instances, and Serverless instances<props="intl"> standalone instances and replica set instances. To change the configuration of a sharded cluster instance, call the [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html), [CreateNode](https://help.aliyun.com/document_detail/61911.html), [DeleteNode](https://help.aliyun.com/document_detail/61922.html), or [ModifyNodeSpecBatch](https://help.aliyun.com/document_detail/61816.html) operations.
|
|
1979
2079
|
*
|
|
1980
2080
|
* @param request - ModifyDBInstanceSpecRequest
|
|
1981
2081
|
* @returns ModifyDBInstanceSpecResponse
|
|
1982
2082
|
*/
|
|
1983
2083
|
modifyDBInstanceSpec(request: $_model.ModifyDBInstanceSpecRequest): Promise<$_model.ModifyDBInstanceSpecResponse>;
|
|
1984
2084
|
/**
|
|
1985
|
-
* Modifies the
|
|
2085
|
+
* Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance.
|
|
1986
2086
|
*
|
|
1987
2087
|
* @remarks
|
|
1988
|
-
*
|
|
1989
|
-
* >
|
|
1990
|
-
* Before you call this operation, make sure that the
|
|
1991
|
-
*
|
|
1992
|
-
*
|
|
1993
|
-
*
|
|
1994
|
-
*
|
|
2088
|
+
* Transparent Data Encryption (TDE) provides real-time I/O encryption and decryption for data files. Data is encrypted before it is written to a disk and decrypted when it is read from the disk into memory. For more information, see [Configure TDE](https://help.aliyun.com/document_detail/131048.html).
|
|
2089
|
+
* > You cannot disable TDE after it is enabled.
|
|
2090
|
+
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
2091
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
2092
|
+
* - The instance uses the WiredTiger storage engine.
|
|
2093
|
+
* - The instance uses local disks.
|
|
2094
|
+
* - The instance runs MongoDB 4.0 or 4.2. If the instance runs an earlier version, you must upgrade the database version by calling the [UpgradeDBInstanceEngineVersion](https://help.aliyun.com/document_detail/67608.html) operation.
|
|
1995
2095
|
*
|
|
1996
2096
|
* @param request - ModifyDBInstanceTDERequest
|
|
1997
2097
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1999,16 +2099,16 @@ export default class Client extends OpenApi {
|
|
|
1999
2099
|
*/
|
|
2000
2100
|
modifyDBInstanceTDEWithOptions(request: $_model.ModifyDBInstanceTDERequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyDBInstanceTDEResponse>;
|
|
2001
2101
|
/**
|
|
2002
|
-
* Modifies the
|
|
2102
|
+
* Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance.
|
|
2003
2103
|
*
|
|
2004
2104
|
* @remarks
|
|
2005
|
-
*
|
|
2006
|
-
* >
|
|
2007
|
-
* Before you call this operation, make sure that the
|
|
2008
|
-
*
|
|
2009
|
-
*
|
|
2010
|
-
*
|
|
2011
|
-
*
|
|
2105
|
+
* Transparent Data Encryption (TDE) provides real-time I/O encryption and decryption for data files. Data is encrypted before it is written to a disk and decrypted when it is read from the disk into memory. For more information, see [Configure TDE](https://help.aliyun.com/document_detail/131048.html).
|
|
2106
|
+
* > You cannot disable TDE after it is enabled.
|
|
2107
|
+
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
2108
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
2109
|
+
* - The instance uses the WiredTiger storage engine.
|
|
2110
|
+
* - The instance uses local disks.
|
|
2111
|
+
* - The instance runs MongoDB 4.0 or 4.2. If the instance runs an earlier version, you must upgrade the database version by calling the [UpgradeDBInstanceEngineVersion](https://help.aliyun.com/document_detail/67608.html) operation.
|
|
2012
2112
|
*
|
|
2013
2113
|
* @param request - ModifyDBInstanceTDERequest
|
|
2014
2114
|
* @returns ModifyDBInstanceTDEResponse
|
|
@@ -2089,10 +2189,10 @@ export default class Client extends OpenApi {
|
|
|
2089
2189
|
*
|
|
2090
2190
|
* @remarks
|
|
2091
2191
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
2092
|
-
*
|
|
2093
|
-
*
|
|
2094
|
-
*
|
|
2095
|
-
*
|
|
2192
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
2193
|
+
* - 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](https://help.aliyun.com/document_detail/62010.html) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](https://help.aliyun.com/document_detail/67608.html) operation to upgrade the database engine version of the instance.
|
|
2194
|
+
* - The network type of the instance must be VPC. If the network type of the instance is classic network, you must call the [ModifyDBInstanceNetworkType](https://help.aliyun.com/document_detail/62138.html) operation to change the network type to VPC.
|
|
2195
|
+
* - You can only disable but not enable password-free access over VPC.
|
|
2096
2196
|
*
|
|
2097
2197
|
* @param request - ModifyInstanceVpcAuthModeRequest
|
|
2098
2198
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2104,20 +2204,20 @@ export default class Client extends OpenApi {
|
|
|
2104
2204
|
*
|
|
2105
2205
|
* @remarks
|
|
2106
2206
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
2107
|
-
*
|
|
2108
|
-
*
|
|
2109
|
-
*
|
|
2110
|
-
*
|
|
2207
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
2208
|
+
* - 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](https://help.aliyun.com/document_detail/62010.html) operation to view the database engine version of the instance. If necessary, you can call the [UpgradeDBInstanceEngineVersion](https://help.aliyun.com/document_detail/67608.html) operation to upgrade the database engine version of the instance.
|
|
2209
|
+
* - The network type of the instance must be VPC. If the network type of the instance is classic network, you must call the [ModifyDBInstanceNetworkType](https://help.aliyun.com/document_detail/62138.html) operation to change the network type to VPC.
|
|
2210
|
+
* - You can only disable but not enable password-free access over VPC.
|
|
2111
2211
|
*
|
|
2112
2212
|
* @param request - ModifyInstanceVpcAuthModeRequest
|
|
2113
2213
|
* @returns ModifyInstanceVpcAuthModeResponse
|
|
2114
2214
|
*/
|
|
2115
2215
|
modifyInstanceVpcAuthMode(request: $_model.ModifyInstanceVpcAuthModeRequest): Promise<$_model.ModifyInstanceVpcAuthModeResponse>;
|
|
2116
2216
|
/**
|
|
2117
|
-
* Changes the
|
|
2217
|
+
* Changes the instance type and storage space of a node in a MongoDB sharded cluster instance.
|
|
2118
2218
|
*
|
|
2119
2219
|
* @remarks
|
|
2120
|
-
* Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of
|
|
2220
|
+
* Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of MongoDB.
|
|
2121
2221
|
* > This operation is applicable only to sharded cluster instances.
|
|
2122
2222
|
*
|
|
2123
2223
|
* @param request - ModifyNodeSpecRequest
|
|
@@ -2126,10 +2226,10 @@ export default class Client extends OpenApi {
|
|
|
2126
2226
|
*/
|
|
2127
2227
|
modifyNodeSpecWithOptions(request: $_model.ModifyNodeSpecRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyNodeSpecResponse>;
|
|
2128
2228
|
/**
|
|
2129
|
-
* Changes the
|
|
2229
|
+
* Changes the instance type and storage space of a node in a MongoDB sharded cluster instance.
|
|
2130
2230
|
*
|
|
2131
2231
|
* @remarks
|
|
2132
|
-
* Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of
|
|
2232
|
+
* Before you call this operation, make sure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of MongoDB.
|
|
2133
2233
|
* > This operation is applicable only to sharded cluster instances.
|
|
2134
2234
|
*
|
|
2135
2235
|
* @param request - ModifyNodeSpecRequest
|
|
@@ -2137,12 +2237,12 @@ export default class Client extends OpenApi {
|
|
|
2137
2237
|
*/
|
|
2138
2238
|
modifyNodeSpec(request: $_model.ModifyNodeSpecRequest): Promise<$_model.ModifyNodeSpecResponse>;
|
|
2139
2239
|
/**
|
|
2140
|
-
* Changes the
|
|
2240
|
+
* Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.
|
|
2141
2241
|
*
|
|
2142
2242
|
* @remarks
|
|
2143
|
-
*
|
|
2144
|
-
* This operation
|
|
2145
|
-
* When you upgrade or downgrade
|
|
2243
|
+
* Before you call this operation, ensure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
2244
|
+
* This operation applies only to ApsaraDB for MongoDB sharded cluster instances.
|
|
2245
|
+
* When you upgrade or downgrade multiple sharded cluster instances in a batch, the target instance types are subject to certain constraints. For example, if you expand storage capacity, the target capacity must be greater than or equal to the current capacity. If the instances have different instance types, the system randomly selects the instance type of one instance and applies its constraints to the entire batch. This may cause the upgrade or downgrade to fail. If you cannot upgrade or downgrade instances in a batch, you can use the ModifyNodeSpec operation to change the configuration of a single sharded cluster instance.
|
|
2146
2246
|
*
|
|
2147
2247
|
* @param request - ModifyNodeSpecBatchRequest
|
|
2148
2248
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2150,12 +2250,12 @@ export default class Client extends OpenApi {
|
|
|
2150
2250
|
*/
|
|
2151
2251
|
modifyNodeSpecBatchWithOptions(request: $_model.ModifyNodeSpecBatchRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifyNodeSpecBatchResponse>;
|
|
2152
2252
|
/**
|
|
2153
|
-
* Changes the
|
|
2253
|
+
* Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.
|
|
2154
2254
|
*
|
|
2155
2255
|
* @remarks
|
|
2156
|
-
*
|
|
2157
|
-
* This operation
|
|
2158
|
-
* When you upgrade or downgrade
|
|
2256
|
+
* Before you call this operation, ensure that you understand the billing methods and <props="china">[pricing](https://www.aliyun.com/price/product#/mongodb/detail)<props="intl">[pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
2257
|
+
* This operation applies only to ApsaraDB for MongoDB sharded cluster instances.
|
|
2258
|
+
* When you upgrade or downgrade multiple sharded cluster instances in a batch, the target instance types are subject to certain constraints. For example, if you expand storage capacity, the target capacity must be greater than or equal to the current capacity. If the instances have different instance types, the system randomly selects the instance type of one instance and applies its constraints to the entire batch. This may cause the upgrade or downgrade to fail. If you cannot upgrade or downgrade instances in a batch, you can use the ModifyNodeSpec operation to change the configuration of a single sharded cluster instance.
|
|
2159
2259
|
*
|
|
2160
2260
|
* @param request - ModifyNodeSpecBatchRequest
|
|
2161
2261
|
* @returns ModifyNodeSpecBatchResponse
|
|
@@ -2165,8 +2265,8 @@ export default class Client extends OpenApi {
|
|
|
2165
2265
|
* Modifies the parameters of an ApsaraDB for MongoDB instance.
|
|
2166
2266
|
*
|
|
2167
2267
|
* @remarks
|
|
2168
|
-
*
|
|
2169
|
-
*
|
|
2268
|
+
* - When you call this operation, the instance status must be running.
|
|
2269
|
+
* - If you call this operation to modify specific instance parameters that require a restart to take effect, the instance is automatically restarted after the operation is called. You can call the [DescribeParameterTemplates](https://help.aliyun.com/document_detail/67618.html) operation to identify which parameters require an instance restart to take effect after modification.
|
|
2170
2270
|
*
|
|
2171
2271
|
* @param request - ModifyParametersRequest
|
|
2172
2272
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2177,8 +2277,8 @@ export default class Client extends OpenApi {
|
|
|
2177
2277
|
* Modifies the parameters of an ApsaraDB for MongoDB instance.
|
|
2178
2278
|
*
|
|
2179
2279
|
* @remarks
|
|
2180
|
-
*
|
|
2181
|
-
*
|
|
2280
|
+
* - When you call this operation, the instance status must be running.
|
|
2281
|
+
* - If you call this operation to modify specific instance parameters that require a restart to take effect, the instance is automatically restarted after the operation is called. You can call the [DescribeParameterTemplates](https://help.aliyun.com/document_detail/67618.html) operation to identify which parameters require an instance restart to take effect after modification.
|
|
2182
2282
|
*
|
|
2183
2283
|
* @param request - ModifyParametersRequest
|
|
2184
2284
|
* @returns ModifyParametersResponse
|
|
@@ -2206,10 +2306,10 @@ export default class Client extends OpenApi {
|
|
|
2206
2306
|
*/
|
|
2207
2307
|
modifyResourceGroup(request: $_model.ModifyResourceGroupRequest): Promise<$_model.ModifyResourceGroupResponse>;
|
|
2208
2308
|
/**
|
|
2209
|
-
*
|
|
2309
|
+
* Modifies the ECS security group bound to an ApsaraDB for MongoDB instance.
|
|
2210
2310
|
*
|
|
2211
2311
|
* @remarks
|
|
2212
|
-
* >
|
|
2312
|
+
* > For a sharded cluster instance, the bound ECS security group takes effect only for mongos nodes.
|
|
2213
2313
|
*
|
|
2214
2314
|
* @param request - ModifySecurityGroupConfigurationRequest
|
|
2215
2315
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2217,10 +2317,10 @@ export default class Client extends OpenApi {
|
|
|
2217
2317
|
*/
|
|
2218
2318
|
modifySecurityGroupConfigurationWithOptions(request: $_model.ModifySecurityGroupConfigurationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifySecurityGroupConfigurationResponse>;
|
|
2219
2319
|
/**
|
|
2220
|
-
*
|
|
2320
|
+
* Modifies the ECS security group bound to an ApsaraDB for MongoDB instance.
|
|
2221
2321
|
*
|
|
2222
2322
|
* @remarks
|
|
2223
|
-
* >
|
|
2323
|
+
* > For a sharded cluster instance, the bound ECS security group takes effect only for mongos nodes.
|
|
2224
2324
|
*
|
|
2225
2325
|
* @param request - ModifySecurityGroupConfigurationRequest
|
|
2226
2326
|
* @returns ModifySecurityGroupConfigurationResponse
|
|
@@ -2242,7 +2342,10 @@ export default class Client extends OpenApi {
|
|
|
2242
2342
|
*/
|
|
2243
2343
|
modifySecurityIps(request: $_model.ModifySecurityIpsRequest): Promise<$_model.ModifySecurityIpsResponse>;
|
|
2244
2344
|
/**
|
|
2245
|
-
* Modifies the SRV connection
|
|
2345
|
+
* Modifies the SRV connection address of a MongoDB instance.
|
|
2346
|
+
*
|
|
2347
|
+
* @remarks
|
|
2348
|
+
* This operation applies only to replica set instances and sharded cluster instances that use disks.
|
|
2246
2349
|
*
|
|
2247
2350
|
* @param request - ModifySrvNetworkAddressRequest
|
|
2248
2351
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2250,7 +2353,10 @@ export default class Client extends OpenApi {
|
|
|
2250
2353
|
*/
|
|
2251
2354
|
modifySrvNetworkAddressWithOptions(request: $_model.ModifySrvNetworkAddressRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ModifySrvNetworkAddressResponse>;
|
|
2252
2355
|
/**
|
|
2253
|
-
* Modifies the SRV connection
|
|
2356
|
+
* Modifies the SRV connection address of a MongoDB instance.
|
|
2357
|
+
*
|
|
2358
|
+
* @remarks
|
|
2359
|
+
* This operation applies only to replica set instances and sharded cluster instances that use disks.
|
|
2254
2360
|
*
|
|
2255
2361
|
* @param request - ModifySrvNetworkAddressRequest
|
|
2256
2362
|
* @returns ModifySrvNetworkAddressResponse
|
|
@@ -2278,11 +2384,11 @@ export default class Client extends OpenApi {
|
|
|
2278
2384
|
*/
|
|
2279
2385
|
modifyTaskInfo(request: $_model.ModifyTaskInfoRequest): Promise<$_model.ModifyTaskInfoResponse>;
|
|
2280
2386
|
/**
|
|
2281
|
-
* Releases the internal endpoint of a shard or Configserver node
|
|
2387
|
+
* Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance.
|
|
2282
2388
|
*
|
|
2283
2389
|
* @remarks
|
|
2284
|
-
*
|
|
2285
|
-
*
|
|
2390
|
+
* - This operation releases the internal endpoint of a shard or Configserver node for a sharded cluster instance. For more information, see [Release the endpoint of a shard or Configserver node](https://help.aliyun.com/document_detail/134067.html).
|
|
2391
|
+
* - To release the public endpoint of a shard or Configserver node for a sharded cluster instance, call the [ReleasePublicNetworkAddress](https://help.aliyun.com/document_detail/67604.html) operation.
|
|
2286
2392
|
*
|
|
2287
2393
|
* @param request - ReleaseNodePrivateNetworkAddressRequest
|
|
2288
2394
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2290,11 +2396,11 @@ export default class Client extends OpenApi {
|
|
|
2290
2396
|
*/
|
|
2291
2397
|
releaseNodePrivateNetworkAddressWithOptions(request: $_model.ReleaseNodePrivateNetworkAddressRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ReleaseNodePrivateNetworkAddressResponse>;
|
|
2292
2398
|
/**
|
|
2293
|
-
* Releases the internal endpoint of a shard or Configserver node
|
|
2399
|
+
* Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance.
|
|
2294
2400
|
*
|
|
2295
2401
|
* @remarks
|
|
2296
|
-
*
|
|
2297
|
-
*
|
|
2402
|
+
* - This operation releases the internal endpoint of a shard or Configserver node for a sharded cluster instance. For more information, see [Release the endpoint of a shard or Configserver node](https://help.aliyun.com/document_detail/134067.html).
|
|
2403
|
+
* - To release the public endpoint of a shard or Configserver node for a sharded cluster instance, call the [ReleasePublicNetworkAddress](https://help.aliyun.com/document_detail/67604.html) operation.
|
|
2298
2404
|
*
|
|
2299
2405
|
* @param request - ReleaseNodePrivateNetworkAddressRequest
|
|
2300
2406
|
* @returns ReleaseNodePrivateNetworkAddressResponse
|
|
@@ -2341,9 +2447,6 @@ export default class Client extends OpenApi {
|
|
|
2341
2447
|
/**
|
|
2342
2448
|
* Resets the password of the root account in an ApsaraDB for MongoDB instance.
|
|
2343
2449
|
*
|
|
2344
|
-
* @remarks
|
|
2345
|
-
* > This operation can be used to reset only the password of the root account of an instance.
|
|
2346
|
-
*
|
|
2347
2450
|
* @param request - ResetAccountPasswordRequest
|
|
2348
2451
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
2349
2452
|
* @returns ResetAccountPasswordResponse
|
|
@@ -2352,9 +2455,6 @@ export default class Client extends OpenApi {
|
|
|
2352
2455
|
/**
|
|
2353
2456
|
* Resets the password of the root account in an ApsaraDB for MongoDB instance.
|
|
2354
2457
|
*
|
|
2355
|
-
* @remarks
|
|
2356
|
-
* > This operation can be used to reset only the password of the root account of an instance.
|
|
2357
|
-
*
|
|
2358
2458
|
* @param request - ResetAccountPasswordRequest
|
|
2359
2459
|
* @returns ResetAccountPasswordResponse
|
|
2360
2460
|
*/
|
|
@@ -2363,7 +2463,7 @@ export default class Client extends OpenApi {
|
|
|
2363
2463
|
* Restarts an ApsaraDB for MongoDB instance.
|
|
2364
2464
|
*
|
|
2365
2465
|
* @remarks
|
|
2366
|
-
*
|
|
2466
|
+
* You can call this operation to restart an instance. You can also restart a shard or Mongos node in a sharded cluster instance.
|
|
2367
2467
|
*
|
|
2368
2468
|
* @param request - RestartDBInstanceRequest
|
|
2369
2469
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2374,20 +2474,19 @@ export default class Client extends OpenApi {
|
|
|
2374
2474
|
* Restarts an ApsaraDB for MongoDB instance.
|
|
2375
2475
|
*
|
|
2376
2476
|
* @remarks
|
|
2377
|
-
*
|
|
2477
|
+
* You can call this operation to restart an instance. You can also restart a shard or Mongos node in a sharded cluster instance.
|
|
2378
2478
|
*
|
|
2379
2479
|
* @param request - RestartDBInstanceRequest
|
|
2380
2480
|
* @returns RestartDBInstanceResponse
|
|
2381
2481
|
*/
|
|
2382
2482
|
restartDBInstance(request: $_model.RestartDBInstanceRequest): Promise<$_model.RestartDBInstanceResponse>;
|
|
2383
2483
|
/**
|
|
2384
|
-
* Restarts a node
|
|
2484
|
+
* Restarts a single node of a MongoDB instance.
|
|
2385
2485
|
*
|
|
2386
2486
|
* @remarks
|
|
2387
|
-
*
|
|
2388
|
-
*
|
|
2389
|
-
*
|
|
2390
|
-
* * The instance is a replica set or sharded cluster instance of the standard edition.
|
|
2487
|
+
* Limitations:
|
|
2488
|
+
* - The instance must be in the Running state.
|
|
2489
|
+
* - The instance must be a standard replica set instance or a sharded cluster instance.
|
|
2391
2490
|
*
|
|
2392
2491
|
* @param request - RestartNodeRequest
|
|
2393
2492
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2395,13 +2494,12 @@ export default class Client extends OpenApi {
|
|
|
2395
2494
|
*/
|
|
2396
2495
|
restartNodeWithOptions(request: $_model.RestartNodeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RestartNodeResponse>;
|
|
2397
2496
|
/**
|
|
2398
|
-
* Restarts a node
|
|
2497
|
+
* Restarts a single node of a MongoDB instance.
|
|
2399
2498
|
*
|
|
2400
2499
|
* @remarks
|
|
2401
|
-
*
|
|
2402
|
-
*
|
|
2403
|
-
*
|
|
2404
|
-
* * The instance is a replica set or sharded cluster instance of the standard edition.
|
|
2500
|
+
* Limitations:
|
|
2501
|
+
* - The instance must be in the Running state.
|
|
2502
|
+
* - The instance must be a standard replica set instance or a sharded cluster instance.
|
|
2405
2503
|
*
|
|
2406
2504
|
* @param request - RestartNodeRequest
|
|
2407
2505
|
* @returns RestartNodeResponse
|
|
@@ -2413,8 +2511,8 @@ export default class Client extends OpenApi {
|
|
|
2413
2511
|
* @remarks
|
|
2414
2512
|
* The instance must be running when you call this operation.
|
|
2415
2513
|
* >
|
|
2416
|
-
*
|
|
2417
|
-
*
|
|
2514
|
+
* - This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.
|
|
2515
|
+
* - On replica set instances, the switch is performed between instances. On sharded cluster instances, the switch is performed between shards.
|
|
2418
2516
|
*
|
|
2419
2517
|
* @param request - SwitchDBInstanceHARequest
|
|
2420
2518
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2427,8 +2525,8 @@ export default class Client extends OpenApi {
|
|
|
2427
2525
|
* @remarks
|
|
2428
2526
|
* The instance must be running when you call this operation.
|
|
2429
2527
|
* >
|
|
2430
|
-
*
|
|
2431
|
-
*
|
|
2528
|
+
* - This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.
|
|
2529
|
+
* - On replica set instances, the switch is performed between instances. On sharded cluster instances, the switch is performed between shards.
|
|
2432
2530
|
*
|
|
2433
2531
|
* @param request - SwitchDBInstanceHARequest
|
|
2434
2532
|
* @returns SwitchDBInstanceHAResponse
|
|
@@ -2439,11 +2537,11 @@ export default class Client extends OpenApi {
|
|
|
2439
2537
|
*
|
|
2440
2538
|
* @remarks
|
|
2441
2539
|
* If you have a large number of instances, you can create multiple tags, bind the tags to the instances, and filter the instances by tag.
|
|
2442
|
-
*
|
|
2443
|
-
*
|
|
2444
|
-
*
|
|
2445
|
-
*
|
|
2446
|
-
*
|
|
2540
|
+
* - A tag consists of a key and a value. Each key must be unique in a region for an Alibaba Cloud account. Different keys can be mapped to the same value.
|
|
2541
|
+
* - If the tag that you specify does not exist, this tag is automatically created and bound to the specified instance.
|
|
2542
|
+
* - If a tag that has the same key is already bound to the instance, the new tag overwrites the existing tag.
|
|
2543
|
+
* - You can bind up to 20 tags to each instance.
|
|
2544
|
+
* - You can bind tags to up to 50 instances each time you call the operation.
|
|
2447
2545
|
*
|
|
2448
2546
|
* @param request - TagResourcesRequest
|
|
2449
2547
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2455,11 +2553,11 @@ export default class Client extends OpenApi {
|
|
|
2455
2553
|
*
|
|
2456
2554
|
* @remarks
|
|
2457
2555
|
* If you have a large number of instances, you can create multiple tags, bind the tags to the instances, and filter the instances by tag.
|
|
2458
|
-
*
|
|
2459
|
-
*
|
|
2460
|
-
*
|
|
2461
|
-
*
|
|
2462
|
-
*
|
|
2556
|
+
* - A tag consists of a key and a value. Each key must be unique in a region for an Alibaba Cloud account. Different keys can be mapped to the same value.
|
|
2557
|
+
* - If the tag that you specify does not exist, this tag is automatically created and bound to the specified instance.
|
|
2558
|
+
* - If a tag that has the same key is already bound to the instance, the new tag overwrites the existing tag.
|
|
2559
|
+
* - You can bind up to 20 tags to each instance.
|
|
2560
|
+
* - You can bind tags to up to 50 instances each time you call the operation.
|
|
2463
2561
|
*
|
|
2464
2562
|
* @param request - TagResourcesRequest
|
|
2465
2563
|
* @returns TagResourcesResponse
|
|
@@ -2469,8 +2567,8 @@ export default class Client extends OpenApi {
|
|
|
2469
2567
|
* Switches the backup mode of an ApsaraDB for MongoDB sharded cluster instance to the cluster backup mode. After the instance is switched to the cluster backup mode, the instance supports high-frequency backup.
|
|
2470
2568
|
*
|
|
2471
2569
|
* @remarks
|
|
2472
|
-
*
|
|
2473
|
-
*
|
|
2570
|
+
* - The instance is an ApsaraDB for MongoDB sharded cluster instance that runs MongoDB 4.4 or later and uses enhanced SSDs (ESSDs) to store data.
|
|
2571
|
+
* - You can call the TransferClusterBackup operation only for instances that are created before October 19, 2023 to switch the instances to the cluster backup mode. Cloud disk-based sharded cluster instances that are created on or after October 19, 2023 are set to the cluster backup mode by default.
|
|
2474
2572
|
*
|
|
2475
2573
|
* @param request - TransferClusterBackupRequest
|
|
2476
2574
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2481,8 +2579,8 @@ export default class Client extends OpenApi {
|
|
|
2481
2579
|
* Switches the backup mode of an ApsaraDB for MongoDB sharded cluster instance to the cluster backup mode. After the instance is switched to the cluster backup mode, the instance supports high-frequency backup.
|
|
2482
2580
|
*
|
|
2483
2581
|
* @remarks
|
|
2484
|
-
*
|
|
2485
|
-
*
|
|
2582
|
+
* - The instance is an ApsaraDB for MongoDB sharded cluster instance that runs MongoDB 4.4 or later and uses enhanced SSDs (ESSDs) to store data.
|
|
2583
|
+
* - You can call the TransferClusterBackup operation only for instances that are created before October 19, 2023 to switch the instances to the cluster backup mode. Cloud disk-based sharded cluster instances that are created on or after October 19, 2023 are set to the cluster backup mode by default.
|
|
2486
2584
|
*
|
|
2487
2585
|
* @param request - TransferClusterBackupRequest
|
|
2488
2586
|
* @returns TransferClusterBackupResponse
|
|
@@ -2494,9 +2592,9 @@ export default class Client extends OpenApi {
|
|
|
2494
2592
|
* @remarks
|
|
2495
2593
|
* Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB
|
|
2496
2594
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
2497
|
-
*
|
|
2498
|
-
*
|
|
2499
|
-
*
|
|
2595
|
+
* - The instance is in the Running state.
|
|
2596
|
+
* - Your instance has no unpaid billing method change orders.
|
|
2597
|
+
* - The instance type is available for purchase. For more information about unavailable instance types, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
2500
2598
|
* > To change the billing method of an instance whose instance type is no longer available to purchase, call the [ModifyDBInstanceSpec](https://help.aliyun.com/document_detail/61816.html) or [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html) operation to change the instance type first.
|
|
2501
2599
|
*
|
|
2502
2600
|
* @param request - TransformInstanceChargeTypeRequest
|
|
@@ -2510,9 +2608,9 @@ export default class Client extends OpenApi {
|
|
|
2510
2608
|
* @remarks
|
|
2511
2609
|
* Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB
|
|
2512
2610
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
2513
|
-
*
|
|
2514
|
-
*
|
|
2515
|
-
*
|
|
2611
|
+
* - The instance is in the Running state.
|
|
2612
|
+
* - Your instance has no unpaid billing method change orders.
|
|
2613
|
+
* - The instance type is available for purchase. For more information about unavailable instance types, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
2516
2614
|
* > To change the billing method of an instance whose instance type is no longer available to purchase, call the [ModifyDBInstanceSpec](https://help.aliyun.com/document_detail/61816.html) or [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html) operation to change the instance type first.
|
|
2517
2615
|
*
|
|
2518
2616
|
* @param request - TransformInstanceChargeTypeRequest
|
|
@@ -2526,11 +2624,11 @@ export default class Client extends OpenApi {
|
|
|
2526
2624
|
* Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).
|
|
2527
2625
|
* A subscription instance cannot be changed to a pay-as-you-go instance. To avoid wasting resources, proceed with caution.
|
|
2528
2626
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
2529
|
-
*
|
|
2530
|
-
*
|
|
2531
|
-
*
|
|
2532
|
-
*
|
|
2533
|
-
* >
|
|
2627
|
+
* - The instance is in the running state.
|
|
2628
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
2629
|
+
* - The instance has no unpaid subscription orders.
|
|
2630
|
+
* - The instance type is available for purchase. For more information about unavailable instance types, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
2631
|
+
* > To change the billing method of an instance whose instance type is no longer available to subscription, call the [ModifyDBInstanceSpec](https://help.aliyun.com/document_detail/61816.html) or [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html) operation to first change the instance type.
|
|
2534
2632
|
*
|
|
2535
2633
|
* @param request - TransformToPrePaidRequest
|
|
2536
2634
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2544,11 +2642,11 @@ export default class Client extends OpenApi {
|
|
|
2544
2642
|
* Before you call this operation, make sure that you understand the billing methods and [pricing](https://www.alibabacloud.com/zh/product/apsaradb-for-mongodb/pricing).
|
|
2545
2643
|
* A subscription instance cannot be changed to a pay-as-you-go instance. To avoid wasting resources, proceed with caution.
|
|
2546
2644
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
2547
|
-
*
|
|
2548
|
-
*
|
|
2549
|
-
*
|
|
2550
|
-
*
|
|
2551
|
-
* >
|
|
2645
|
+
* - The instance is in the running state.
|
|
2646
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
2647
|
+
* - The instance has no unpaid subscription orders.
|
|
2648
|
+
* - The instance type is available for purchase. For more information about unavailable instance types, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
2649
|
+
* > To change the billing method of an instance whose instance type is no longer available to subscription, call the [ModifyDBInstanceSpec](https://help.aliyun.com/document_detail/61816.html) or [ModifyNodeSpec](https://help.aliyun.com/document_detail/61923.html) operation to first change the instance type.
|
|
2552
2650
|
*
|
|
2553
2651
|
* @param request - TransformToPrePaidRequest
|
|
2554
2652
|
* @returns TransformToPrePaidResponse
|
|
@@ -2559,8 +2657,8 @@ export default class Client extends OpenApi {
|
|
|
2559
2657
|
*
|
|
2560
2658
|
* @remarks
|
|
2561
2659
|
* >
|
|
2562
|
-
*
|
|
2563
|
-
*
|
|
2660
|
+
* - You can remove up to 20 tags at a time.
|
|
2661
|
+
* - If you remove a tag from all instances, the tag is automatically deleted.
|
|
2564
2662
|
*
|
|
2565
2663
|
* @param request - UntagResourcesRequest
|
|
2566
2664
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2572,8 +2670,8 @@ export default class Client extends OpenApi {
|
|
|
2572
2670
|
*
|
|
2573
2671
|
* @remarks
|
|
2574
2672
|
* >
|
|
2575
|
-
*
|
|
2576
|
-
*
|
|
2673
|
+
* - You can remove up to 20 tags at a time.
|
|
2674
|
+
* - If you remove a tag from all instances, the tag is automatically deleted.
|
|
2577
2675
|
*
|
|
2578
2676
|
* @param request - UntagResourcesRequest
|
|
2579
2677
|
* @returns UntagResourcesResponse
|
|
@@ -2584,9 +2682,11 @@ export default class Client extends OpenApi {
|
|
|
2584
2682
|
*
|
|
2585
2683
|
* @remarks
|
|
2586
2684
|
* The instance must be in the running state when you call this operation.
|
|
2587
|
-
* >
|
|
2588
|
-
* >
|
|
2589
|
-
* >
|
|
2685
|
+
* > - The available database versions depend on the storage engine used by the instance. For more information, see [Upgrades of MongoDB major versions](https://help.aliyun.com/document_detail/398673.html). You can also call the [DescribeAvailableEngineVersion](https://help.aliyun.com/document_detail/141355.html) operation to query the available database versions.
|
|
2686
|
+
* >
|
|
2687
|
+
* > - You cannot downgrade the MongoDB version of an instance after you upgrade it.
|
|
2688
|
+
* >
|
|
2689
|
+
* > - The instance is automatically restarted for two to three times during the upgrade process. Make sure that you upgrade the instance during off-peak hours.
|
|
2590
2690
|
*
|
|
2591
2691
|
* @param request - UpgradeDBInstanceEngineVersionRequest
|
|
2592
2692
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2598,9 +2698,11 @@ export default class Client extends OpenApi {
|
|
|
2598
2698
|
*
|
|
2599
2699
|
* @remarks
|
|
2600
2700
|
* The instance must be in the running state when you call this operation.
|
|
2601
|
-
* >
|
|
2602
|
-
* >
|
|
2603
|
-
* >
|
|
2701
|
+
* > - The available database versions depend on the storage engine used by the instance. For more information, see [Upgrades of MongoDB major versions](https://help.aliyun.com/document_detail/398673.html). You can also call the [DescribeAvailableEngineVersion](https://help.aliyun.com/document_detail/141355.html) operation to query the available database versions.
|
|
2702
|
+
* >
|
|
2703
|
+
* > - You cannot downgrade the MongoDB version of an instance after you upgrade it.
|
|
2704
|
+
* >
|
|
2705
|
+
* > - The instance is automatically restarted for two to three times during the upgrade process. Make sure that you upgrade the instance during off-peak hours.
|
|
2604
2706
|
*
|
|
2605
2707
|
* @param request - UpgradeDBInstanceEngineVersionRequest
|
|
2606
2708
|
* @returns UpgradeDBInstanceEngineVersionResponse
|