@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/src/client.ts
CHANGED
|
@@ -72,6 +72,21 @@ export default class Client extends OpenApi {
|
|
|
72
72
|
'cn-zhengzhou-nebula-1': "mongodb.aliyuncs.com",
|
|
73
73
|
'eu-west-1-oxs': "mongodb.aliyuncs.com",
|
|
74
74
|
'rus-west-1-pop': "mongodb.aliyuncs.com",
|
|
75
|
+
'us-southeast-1': "mongodb.us-southeast-1.aliyuncs.com",
|
|
76
|
+
'na-south-1': "mongodb.na-south-1.aliyuncs.com",
|
|
77
|
+
'me-central-1': "mongodb.me-central-1.aliyuncs.com",
|
|
78
|
+
'eu-west-2': "mongodb.eu-west-2.aliyuncs.com",
|
|
79
|
+
'cn-zhongwei': "mongodb.cn-zhongwei.aliyuncs.com",
|
|
80
|
+
'cn-zhengzhou-jva': "mongodb.cn-zhengzhou-jva.aliyuncs.com",
|
|
81
|
+
'cn-wulanchabu-gic-1': "mongodb.cn-wulanchabu-gic-1.aliyuncs.com",
|
|
82
|
+
'cn-wuhan-lr': "mongodb.cn-wuhan-lr.aliyuncs.com",
|
|
83
|
+
'cn-nanjing': "mongodb.cn-nanjing.aliyuncs.com",
|
|
84
|
+
'cn-heyuan-acdr-1': "mongodb.cn-heyuan-acdr-1.aliyuncs.com",
|
|
85
|
+
'cn-fuzhou': "mongodb.cn-fuzhou.aliyuncs.com",
|
|
86
|
+
'ap-southeast-8': "mongodb.ap-southeast-8.aliyuncs.com",
|
|
87
|
+
'ap-southeast-7': "mongodb.ap-southeast-7.aliyuncs.com",
|
|
88
|
+
'ap-southeast-6': "mongodb.ap-southeast-6.aliyuncs.com",
|
|
89
|
+
'ap-northeast-2': "mongodb.ap-northeast-2.aliyuncs.com",
|
|
75
90
|
};
|
|
76
91
|
this.checkConfig(config);
|
|
77
92
|
this._endpoint = this.getEndpoint("dds", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
|
|
@@ -91,7 +106,10 @@ export default class Client extends OpenApi {
|
|
|
91
106
|
}
|
|
92
107
|
|
|
93
108
|
/**
|
|
94
|
-
* Applies for an SRV
|
|
109
|
+
* Applies for an SRV connection string for an ApsaraDB for MongoDB instance.
|
|
110
|
+
*
|
|
111
|
+
* @remarks
|
|
112
|
+
* Applicable only to cloud disk-based replica set and sharded cluster instances.
|
|
95
113
|
*
|
|
96
114
|
* @param request - AllocateDBInstanceSrvNetworkAddressRequest
|
|
97
115
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -146,7 +164,10 @@ export default class Client extends OpenApi {
|
|
|
146
164
|
}
|
|
147
165
|
|
|
148
166
|
/**
|
|
149
|
-
* Applies for an SRV
|
|
167
|
+
* Applies for an SRV connection string for an ApsaraDB for MongoDB instance.
|
|
168
|
+
*
|
|
169
|
+
* @remarks
|
|
170
|
+
* Applicable only to cloud disk-based replica set and sharded cluster instances.
|
|
150
171
|
*
|
|
151
172
|
* @param request - AllocateDBInstanceSrvNetworkAddressRequest
|
|
152
173
|
* @returns AllocateDBInstanceSrvNetworkAddressResponse
|
|
@@ -161,7 +182,7 @@ export default class Client extends OpenApi {
|
|
|
161
182
|
*
|
|
162
183
|
* @remarks
|
|
163
184
|
* 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).
|
|
164
|
-
* >
|
|
185
|
+
* > 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.
|
|
165
186
|
*
|
|
166
187
|
* @param request - AllocateNodePrivateNetworkAddressRequest
|
|
167
188
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -228,7 +249,7 @@ export default class Client extends OpenApi {
|
|
|
228
249
|
*
|
|
229
250
|
* @remarks
|
|
230
251
|
* 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).
|
|
231
|
-
* >
|
|
252
|
+
* > 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.
|
|
232
253
|
*
|
|
233
254
|
* @param request - AllocateNodePrivateNetworkAddressRequest
|
|
234
255
|
* @returns AllocateNodePrivateNetworkAddressResponse
|
|
@@ -301,6 +322,14 @@ export default class Client extends OpenApi {
|
|
|
301
322
|
}
|
|
302
323
|
|
|
303
324
|
/**
|
|
325
|
+
* Cancels Operations and Maintenance (O&M) events in a batch.
|
|
326
|
+
*
|
|
327
|
+
* @remarks
|
|
328
|
+
* An O\\&M event cannot be canceled in the following scenarios:
|
|
329
|
+
* - The event is not cancelable if the value of the AllowCancel parameter is 0.
|
|
330
|
+
* - The scheduled start time of the O\\&M event has passed.
|
|
331
|
+
* - The status of the O\\&M event is not Pending if the value of the Status parameter is not 3.
|
|
332
|
+
*
|
|
304
333
|
* @param request - CancelActiveOperationTasksRequest
|
|
305
334
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
306
335
|
* @returns CancelActiveOperationTasksResponse
|
|
@@ -350,6 +379,14 @@ export default class Client extends OpenApi {
|
|
|
350
379
|
}
|
|
351
380
|
|
|
352
381
|
/**
|
|
382
|
+
* Cancels Operations and Maintenance (O&M) events in a batch.
|
|
383
|
+
*
|
|
384
|
+
* @remarks
|
|
385
|
+
* An O\\&M event cannot be canceled in the following scenarios:
|
|
386
|
+
* - The event is not cancelable if the value of the AllowCancel parameter is 0.
|
|
387
|
+
* - The scheduled start time of the O\\&M event has passed.
|
|
388
|
+
* - The status of the O\\&M event is not Pending if the value of the Status parameter is not 3.
|
|
389
|
+
*
|
|
353
390
|
* @param request - CancelActiveOperationTasksRequest
|
|
354
391
|
* @returns CancelActiveOperationTasksResponse
|
|
355
392
|
*/
|
|
@@ -586,8 +623,8 @@ export default class Client extends OpenApi {
|
|
|
586
623
|
* Creates an account that is granted read-only permissions for shard nodes in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
587
624
|
*
|
|
588
625
|
* @remarks
|
|
589
|
-
*
|
|
590
|
-
*
|
|
626
|
+
* - You can create an account for shard nodes only in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
627
|
+
* - The account is granted read-only permissions.
|
|
591
628
|
*
|
|
592
629
|
* @param request - CreateAccountRequest
|
|
593
630
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -649,8 +686,8 @@ export default class Client extends OpenApi {
|
|
|
649
686
|
* Creates an account that is granted read-only permissions for shard nodes in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
650
687
|
*
|
|
651
688
|
* @remarks
|
|
652
|
-
*
|
|
653
|
-
*
|
|
689
|
+
* - You can create an account for shard nodes only in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
690
|
+
* - The account is granted read-only permissions.
|
|
654
691
|
*
|
|
655
692
|
* @param request - CreateAccountRequest
|
|
656
693
|
* @returns CreateAccountResponse
|
|
@@ -661,10 +698,10 @@ export default class Client extends OpenApi {
|
|
|
661
698
|
}
|
|
662
699
|
|
|
663
700
|
/**
|
|
664
|
-
* Creates a backup
|
|
701
|
+
* Creates a backup for a MongoDB instance.
|
|
665
702
|
*
|
|
666
703
|
* @remarks
|
|
667
|
-
*
|
|
704
|
+
* The instance must be in the Running state.
|
|
668
705
|
*
|
|
669
706
|
* @param request - CreateBackupRequest
|
|
670
707
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -719,10 +756,10 @@ export default class Client extends OpenApi {
|
|
|
719
756
|
}
|
|
720
757
|
|
|
721
758
|
/**
|
|
722
|
-
* Creates a backup
|
|
759
|
+
* Creates a backup for a MongoDB instance.
|
|
723
760
|
*
|
|
724
761
|
* @remarks
|
|
725
|
-
*
|
|
762
|
+
* The instance must be in the Running state.
|
|
726
763
|
*
|
|
727
764
|
* @param request - CreateBackupRequest
|
|
728
765
|
* @returns CreateBackupResponse
|
|
@@ -736,9 +773,9 @@ export default class Client extends OpenApi {
|
|
|
736
773
|
* Creates or clones an ApsaraDB for MongoDB replica set instance.
|
|
737
774
|
*
|
|
738
775
|
* @remarks
|
|
739
|
-
*
|
|
740
|
-
* For more information about the instance types of ApsaraDB for MongoDB
|
|
741
|
-
* To create sharded cluster
|
|
776
|
+
* 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.
|
|
777
|
+
* For more information about the instance types of ApsaraDB for MongoDB, see [Instance types]().
|
|
778
|
+
* To create a sharded cluster instance, call the [CreateShardingDBInstance]() operation.
|
|
742
779
|
*
|
|
743
780
|
* @param request - CreateDBInstanceRequest
|
|
744
781
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -932,9 +969,9 @@ export default class Client extends OpenApi {
|
|
|
932
969
|
* Creates or clones an ApsaraDB for MongoDB replica set instance.
|
|
933
970
|
*
|
|
934
971
|
* @remarks
|
|
935
|
-
*
|
|
936
|
-
* For more information about the instance types of ApsaraDB for MongoDB
|
|
937
|
-
* To create sharded cluster
|
|
972
|
+
* 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.
|
|
973
|
+
* For more information about the instance types of ApsaraDB for MongoDB, see [Instance types]().
|
|
974
|
+
* To create a sharded cluster instance, call the [CreateShardingDBInstance]() operation.
|
|
938
975
|
*
|
|
939
976
|
* @param request - CreateDBInstanceRequest
|
|
940
977
|
* @returns CreateDBInstanceResponse
|
|
@@ -1015,10 +1052,10 @@ export default class Client extends OpenApi {
|
|
|
1015
1052
|
}
|
|
1016
1053
|
|
|
1017
1054
|
/**
|
|
1018
|
-
* Adds a shard or mongos node to an ApsaraDB for MongoDB instance.
|
|
1055
|
+
* Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster instance.
|
|
1019
1056
|
*
|
|
1020
1057
|
* @remarks
|
|
1021
|
-
* Before
|
|
1058
|
+
* 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.
|
|
1022
1059
|
* This operation applies only to sharded cluster instances.
|
|
1023
1060
|
*
|
|
1024
1061
|
* @param request - CreateNodeRequest
|
|
@@ -1088,6 +1125,18 @@ export default class Client extends OpenApi {
|
|
|
1088
1125
|
query["ResourceOwnerId"] = request.resourceOwnerId;
|
|
1089
1126
|
}
|
|
1090
1127
|
|
|
1128
|
+
if (!$dara.isNull(request.searchDBInstanceClass)) {
|
|
1129
|
+
query["SearchDBInstanceClass"] = request.searchDBInstanceClass;
|
|
1130
|
+
}
|
|
1131
|
+
|
|
1132
|
+
if (!$dara.isNull(request.searchNodeCount)) {
|
|
1133
|
+
query["SearchNodeCount"] = request.searchNodeCount;
|
|
1134
|
+
}
|
|
1135
|
+
|
|
1136
|
+
if (!$dara.isNull(request.searchStorage)) {
|
|
1137
|
+
query["SearchStorage"] = request.searchStorage;
|
|
1138
|
+
}
|
|
1139
|
+
|
|
1091
1140
|
if (!$dara.isNull(request.shardDirect)) {
|
|
1092
1141
|
query["ShardDirect"] = request.shardDirect;
|
|
1093
1142
|
}
|
|
@@ -1110,10 +1159,10 @@ export default class Client extends OpenApi {
|
|
|
1110
1159
|
}
|
|
1111
1160
|
|
|
1112
1161
|
/**
|
|
1113
|
-
* Adds a shard or mongos node to an ApsaraDB for MongoDB instance.
|
|
1162
|
+
* Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster instance.
|
|
1114
1163
|
*
|
|
1115
1164
|
* @remarks
|
|
1116
|
-
* Before
|
|
1165
|
+
* 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.
|
|
1117
1166
|
* This operation applies only to sharded cluster instances.
|
|
1118
1167
|
*
|
|
1119
1168
|
* @param request - CreateNodeRequest
|
|
@@ -1128,7 +1177,7 @@ export default class Client extends OpenApi {
|
|
|
1128
1177
|
* Batch adds mongos or shard nodes for a sharded cluster instance.
|
|
1129
1178
|
*
|
|
1130
1179
|
* @remarks
|
|
1131
|
-
* Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
1180
|
+
* Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
1132
1181
|
* This operation is applicable only to sharded cluster instances.
|
|
1133
1182
|
*
|
|
1134
1183
|
* @param request - CreateNodeBatchRequest
|
|
@@ -1215,7 +1264,7 @@ export default class Client extends OpenApi {
|
|
|
1215
1264
|
* Batch adds mongos or shard nodes for a sharded cluster instance.
|
|
1216
1265
|
*
|
|
1217
1266
|
* @remarks
|
|
1218
|
-
* Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
1267
|
+
* Before you call this operation, make sure that you fully understand the billing methods and [pricing](https://www.alibabacloud.com/product/apsaradb-for-mongodb/pricing) of ApsaraDB for MongoDB.
|
|
1219
1268
|
* This operation is applicable only to sharded cluster instances.
|
|
1220
1269
|
*
|
|
1221
1270
|
* @param request - CreateNodeBatchRequest
|
|
@@ -1227,6 +1276,8 @@ export default class Client extends OpenApi {
|
|
|
1227
1276
|
}
|
|
1228
1277
|
|
|
1229
1278
|
/**
|
|
1279
|
+
* Creates a role tag for an instance node.
|
|
1280
|
+
*
|
|
1230
1281
|
* @param request - CreateNodeRoleTagRequest
|
|
1231
1282
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1232
1283
|
* @returns CreateNodeRoleTagResponse
|
|
@@ -1276,6 +1327,8 @@ export default class Client extends OpenApi {
|
|
|
1276
1327
|
}
|
|
1277
1328
|
|
|
1278
1329
|
/**
|
|
1330
|
+
* Creates a role tag for an instance node.
|
|
1331
|
+
*
|
|
1279
1332
|
* @param request - CreateNodeRoleTagRequest
|
|
1280
1333
|
* @returns CreateNodeRoleTagResponse
|
|
1281
1334
|
*/
|
|
@@ -1285,12 +1338,12 @@ export default class Client extends OpenApi {
|
|
|
1285
1338
|
}
|
|
1286
1339
|
|
|
1287
1340
|
/**
|
|
1288
|
-
* Creates or clones
|
|
1341
|
+
* Creates or clones a MongoDB sharded cluster instance.
|
|
1289
1342
|
*
|
|
1290
1343
|
* @remarks
|
|
1291
|
-
*
|
|
1292
|
-
*
|
|
1293
|
-
*
|
|
1344
|
+
* - 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.
|
|
1345
|
+
* - For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
1346
|
+
* - To create a standalone or replica set instance, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
|
|
1294
1347
|
*
|
|
1295
1348
|
* @param request - CreateShardingDBInstanceRequest
|
|
1296
1349
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1469,12 +1522,12 @@ export default class Client extends OpenApi {
|
|
|
1469
1522
|
}
|
|
1470
1523
|
|
|
1471
1524
|
/**
|
|
1472
|
-
* Creates or clones
|
|
1525
|
+
* Creates or clones a MongoDB sharded cluster instance.
|
|
1473
1526
|
*
|
|
1474
1527
|
* @remarks
|
|
1475
|
-
*
|
|
1476
|
-
*
|
|
1477
|
-
*
|
|
1528
|
+
* - 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.
|
|
1529
|
+
* - For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
1530
|
+
* - To create a standalone or replica set instance, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
|
|
1478
1531
|
*
|
|
1479
1532
|
* @param request - CreateShardingDBInstanceRequest
|
|
1480
1533
|
* @returns CreateShardingDBInstanceResponse
|
|
@@ -1485,7 +1538,11 @@ export default class Client extends OpenApi {
|
|
|
1485
1538
|
}
|
|
1486
1539
|
|
|
1487
1540
|
/**
|
|
1488
|
-
* Deletes
|
|
1541
|
+
* Deletes a MongoDB backup set.
|
|
1542
|
+
*
|
|
1543
|
+
* @remarks
|
|
1544
|
+
* You can delete only manual backups.
|
|
1545
|
+
* This operation supports only MongoDB instances that use cloud disks.
|
|
1489
1546
|
*
|
|
1490
1547
|
* @param request - DeleteBackupRequest
|
|
1491
1548
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1536,7 +1593,11 @@ export default class Client extends OpenApi {
|
|
|
1536
1593
|
}
|
|
1537
1594
|
|
|
1538
1595
|
/**
|
|
1539
|
-
* Deletes
|
|
1596
|
+
* Deletes a MongoDB backup set.
|
|
1597
|
+
*
|
|
1598
|
+
* @remarks
|
|
1599
|
+
* You can delete only manual backups.
|
|
1600
|
+
* This operation supports only MongoDB instances that use cloud disks.
|
|
1540
1601
|
*
|
|
1541
1602
|
* @param request - DeleteBackupRequest
|
|
1542
1603
|
* @returns DeleteBackupResponse
|
|
@@ -1547,13 +1608,13 @@ export default class Client extends OpenApi {
|
|
|
1547
1608
|
}
|
|
1548
1609
|
|
|
1549
1610
|
/**
|
|
1550
|
-
* Releases
|
|
1611
|
+
* Releases a pay-as-you-go MongoDB instance.
|
|
1551
1612
|
*
|
|
1552
1613
|
* @remarks
|
|
1553
|
-
*
|
|
1554
|
-
*
|
|
1555
|
-
*
|
|
1556
|
-
* > After an instance is released,
|
|
1614
|
+
* The instance must meet the following conditions:
|
|
1615
|
+
* - The instance status is running.
|
|
1616
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
1617
|
+
* > After an instance is released, its data cannot be recovered. Proceed with caution.
|
|
1557
1618
|
*
|
|
1558
1619
|
* @param request - DeleteDBInstanceRequest
|
|
1559
1620
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1604,13 +1665,13 @@ export default class Client extends OpenApi {
|
|
|
1604
1665
|
}
|
|
1605
1666
|
|
|
1606
1667
|
/**
|
|
1607
|
-
* Releases
|
|
1668
|
+
* Releases a pay-as-you-go MongoDB instance.
|
|
1608
1669
|
*
|
|
1609
1670
|
* @remarks
|
|
1610
|
-
*
|
|
1611
|
-
*
|
|
1612
|
-
*
|
|
1613
|
-
* > After an instance is released,
|
|
1671
|
+
* The instance must meet the following conditions:
|
|
1672
|
+
* - The instance status is running.
|
|
1673
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
1674
|
+
* > After an instance is released, its data cannot be recovered. Proceed with caution.
|
|
1614
1675
|
*
|
|
1615
1676
|
* @param request - DeleteDBInstanceRequest
|
|
1616
1677
|
* @returns DeleteDBInstanceResponse
|
|
@@ -1621,7 +1682,7 @@ export default class Client extends OpenApi {
|
|
|
1621
1682
|
}
|
|
1622
1683
|
|
|
1623
1684
|
/**
|
|
1624
|
-
* Deletes a global IP whitelist template.
|
|
1685
|
+
* Deletes a global IP address whitelist template.
|
|
1625
1686
|
*
|
|
1626
1687
|
* @param request - DeleteGlobalSecurityIPGroupRequest
|
|
1627
1688
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1680,7 +1741,7 @@ export default class Client extends OpenApi {
|
|
|
1680
1741
|
}
|
|
1681
1742
|
|
|
1682
1743
|
/**
|
|
1683
|
-
* Deletes a global IP whitelist template.
|
|
1744
|
+
* Deletes a global IP address whitelist template.
|
|
1684
1745
|
*
|
|
1685
1746
|
* @param request - DeleteGlobalSecurityIPGroupRequest
|
|
1686
1747
|
* @returns DeleteGlobalSecurityIPGroupResponse
|
|
@@ -1695,10 +1756,10 @@ export default class Client extends OpenApi {
|
|
|
1695
1756
|
*
|
|
1696
1757
|
* @remarks
|
|
1697
1758
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
1698
|
-
*
|
|
1699
|
-
*
|
|
1700
|
-
*
|
|
1701
|
-
*
|
|
1759
|
+
* - The instance is in the Running state.
|
|
1760
|
+
* - The instance is a sharded cluster instance.
|
|
1761
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
1762
|
+
* - The number of the shard or mongos nodes in the instance is greater than two.
|
|
1702
1763
|
*
|
|
1703
1764
|
* @param request - DeleteNodeRequest
|
|
1704
1765
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1757,10 +1818,10 @@ export default class Client extends OpenApi {
|
|
|
1757
1818
|
*
|
|
1758
1819
|
* @remarks
|
|
1759
1820
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
1760
|
-
*
|
|
1761
|
-
*
|
|
1762
|
-
*
|
|
1763
|
-
*
|
|
1821
|
+
* - The instance is in the Running state.
|
|
1822
|
+
* - The instance is a sharded cluster instance.
|
|
1823
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
1824
|
+
* - The number of the shard or mongos nodes in the instance is greater than two.
|
|
1764
1825
|
*
|
|
1765
1826
|
* @param request - DeleteNodeRequest
|
|
1766
1827
|
* @returns DeleteNodeResponse
|
|
@@ -1773,9 +1834,6 @@ export default class Client extends OpenApi {
|
|
|
1773
1834
|
/**
|
|
1774
1835
|
* Queries the database accounts of an ApsaraDB for MongoDB instance.
|
|
1775
1836
|
*
|
|
1776
|
-
* @remarks
|
|
1777
|
-
* > This operation can be used to query only the information of the root account.
|
|
1778
|
-
*
|
|
1779
1837
|
* @param request - DescribeAccountsRequest
|
|
1780
1838
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1781
1839
|
* @returns DescribeAccountsResponse
|
|
@@ -1827,9 +1885,6 @@ export default class Client extends OpenApi {
|
|
|
1827
1885
|
/**
|
|
1828
1886
|
* Queries the database accounts of an ApsaraDB for MongoDB instance.
|
|
1829
1887
|
*
|
|
1830
|
-
* @remarks
|
|
1831
|
-
* > This operation can be used to query only the information of the root account.
|
|
1832
|
-
*
|
|
1833
1888
|
* @param request - DescribeAccountsRequest
|
|
1834
1889
|
* @returns DescribeAccountsResponse
|
|
1835
1890
|
*/
|
|
@@ -1839,6 +1894,8 @@ export default class Client extends OpenApi {
|
|
|
1839
1894
|
}
|
|
1840
1895
|
|
|
1841
1896
|
/**
|
|
1897
|
+
* Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
1898
|
+
*
|
|
1842
1899
|
* @param request - DescribeActiveOperationMaintenanceConfigRequest
|
|
1843
1900
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1844
1901
|
* @returns DescribeActiveOperationMaintenanceConfigResponse
|
|
@@ -1880,6 +1937,8 @@ export default class Client extends OpenApi {
|
|
|
1880
1937
|
}
|
|
1881
1938
|
|
|
1882
1939
|
/**
|
|
1940
|
+
* Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
1941
|
+
*
|
|
1883
1942
|
* @param request - DescribeActiveOperationMaintenanceConfigRequest
|
|
1884
1943
|
* @returns DescribeActiveOperationMaintenanceConfigResponse
|
|
1885
1944
|
*/
|
|
@@ -1889,7 +1948,7 @@ export default class Client extends OpenApi {
|
|
|
1889
1948
|
}
|
|
1890
1949
|
|
|
1891
1950
|
/**
|
|
1892
|
-
* Queries the detailed information about
|
|
1951
|
+
* Queries the detailed information about tasks of an ApsaraDB for MongoDB instance.
|
|
1893
1952
|
*
|
|
1894
1953
|
* @param request - DescribeActiveOperationTaskRequest
|
|
1895
1954
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1956,7 +2015,7 @@ export default class Client extends OpenApi {
|
|
|
1956
2015
|
}
|
|
1957
2016
|
|
|
1958
2017
|
/**
|
|
1959
|
-
* Queries the detailed information about
|
|
2018
|
+
* Queries the detailed information about tasks of an ApsaraDB for MongoDB instance.
|
|
1960
2019
|
*
|
|
1961
2020
|
* @param request - DescribeActiveOperationTaskRequest
|
|
1962
2021
|
* @returns DescribeActiveOperationTaskResponse
|
|
@@ -2025,7 +2084,7 @@ export default class Client extends OpenApi {
|
|
|
2025
2084
|
}
|
|
2026
2085
|
|
|
2027
2086
|
/**
|
|
2028
|
-
*
|
|
2087
|
+
* Queries the types and number of O&M tasks for a MongoDB instance.
|
|
2029
2088
|
*
|
|
2030
2089
|
* @param request - DescribeActiveOperationTaskRegionRequest
|
|
2031
2090
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2076,7 +2135,7 @@ export default class Client extends OpenApi {
|
|
|
2076
2135
|
}
|
|
2077
2136
|
|
|
2078
2137
|
/**
|
|
2079
|
-
*
|
|
2138
|
+
* Queries the types and number of O&M tasks for a MongoDB instance.
|
|
2080
2139
|
*
|
|
2081
2140
|
* @param request - DescribeActiveOperationTaskRegionRequest
|
|
2082
2141
|
* @returns DescribeActiveOperationTaskRegionResponse
|
|
@@ -2155,7 +2214,7 @@ export default class Client extends OpenApi {
|
|
|
2155
2214
|
}
|
|
2156
2215
|
|
|
2157
2216
|
/**
|
|
2158
|
-
* Queries
|
|
2217
|
+
* Queries O&M task details for MongoDB instances.
|
|
2159
2218
|
*
|
|
2160
2219
|
* @param request - DescribeActiveOperationTasksRequest
|
|
2161
2220
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2246,7 +2305,7 @@ export default class Client extends OpenApi {
|
|
|
2246
2305
|
}
|
|
2247
2306
|
|
|
2248
2307
|
/**
|
|
2249
|
-
* Queries
|
|
2308
|
+
* Queries O&M task details for MongoDB instances.
|
|
2250
2309
|
*
|
|
2251
2310
|
* @param request - DescribeActiveOperationTasksRequest
|
|
2252
2311
|
* @returns DescribeActiveOperationTasksResponse
|
|
@@ -2257,12 +2316,12 @@ export default class Client extends OpenApi {
|
|
|
2257
2316
|
}
|
|
2258
2317
|
|
|
2259
2318
|
/**
|
|
2260
|
-
* Queries the
|
|
2319
|
+
* Queries the audit log types collected for a MongoDB instance.
|
|
2261
2320
|
*
|
|
2262
2321
|
* @remarks
|
|
2263
|
-
*
|
|
2264
|
-
*
|
|
2265
|
-
*
|
|
2322
|
+
* - The instance must be in the running state when you call this operation.
|
|
2323
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
2324
|
+
* - 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).
|
|
2266
2325
|
*
|
|
2267
2326
|
* @param request - DescribeAuditLogFilterRequest
|
|
2268
2327
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2313,12 +2372,12 @@ export default class Client extends OpenApi {
|
|
|
2313
2372
|
}
|
|
2314
2373
|
|
|
2315
2374
|
/**
|
|
2316
|
-
* Queries the
|
|
2375
|
+
* Queries the audit log types collected for a MongoDB instance.
|
|
2317
2376
|
*
|
|
2318
2377
|
* @remarks
|
|
2319
|
-
*
|
|
2320
|
-
*
|
|
2321
|
-
*
|
|
2378
|
+
* - The instance must be in the running state when you call this operation.
|
|
2379
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
2380
|
+
* - 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).
|
|
2322
2381
|
*
|
|
2323
2382
|
* @param request - DescribeAuditLogFilterRequest
|
|
2324
2383
|
* @returns DescribeAuditLogFilterResponse
|
|
@@ -2329,12 +2388,12 @@ export default class Client extends OpenApi {
|
|
|
2329
2388
|
}
|
|
2330
2389
|
|
|
2331
2390
|
/**
|
|
2332
|
-
*
|
|
2391
|
+
* Checks whether audit logging is enabled for a MongoDB instance.
|
|
2333
2392
|
*
|
|
2334
2393
|
* @remarks
|
|
2335
|
-
*
|
|
2336
|
-
*
|
|
2337
|
-
*
|
|
2394
|
+
* - The instance must be in the running state.
|
|
2395
|
+
* - This operation is available only for **General-purpose Local Disk Edition** and **Dedicated Local Disk Edition** instances.
|
|
2396
|
+
* - 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).
|
|
2338
2397
|
*
|
|
2339
2398
|
* @param request - DescribeAuditPolicyRequest
|
|
2340
2399
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2381,12 +2440,12 @@ export default class Client extends OpenApi {
|
|
|
2381
2440
|
}
|
|
2382
2441
|
|
|
2383
2442
|
/**
|
|
2384
|
-
*
|
|
2443
|
+
* Checks whether audit logging is enabled for a MongoDB instance.
|
|
2385
2444
|
*
|
|
2386
2445
|
* @remarks
|
|
2387
|
-
*
|
|
2388
|
-
*
|
|
2389
|
-
*
|
|
2446
|
+
* - The instance must be in the running state.
|
|
2447
|
+
* - This operation is available only for **General-purpose Local Disk Edition** and **Dedicated Local Disk Edition** instances.
|
|
2448
|
+
* - 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).
|
|
2390
2449
|
*
|
|
2391
2450
|
* @param request - DescribeAuditPolicyRequest
|
|
2392
2451
|
* @returns DescribeAuditPolicyResponse
|
|
@@ -2397,12 +2456,12 @@ export default class Client extends OpenApi {
|
|
|
2397
2456
|
}
|
|
2398
2457
|
|
|
2399
2458
|
/**
|
|
2400
|
-
* Queries
|
|
2459
|
+
* Queries audit log entries for a MongoDB instance.
|
|
2401
2460
|
*
|
|
2402
2461
|
* @remarks
|
|
2403
|
-
*
|
|
2404
|
-
*
|
|
2405
|
-
*
|
|
2462
|
+
* - When you call this operation, ensure that the audit log feature of the instance is enabled. Otherwise, the operation returns an empty audit log.
|
|
2463
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
2464
|
+
* - 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).
|
|
2406
2465
|
*
|
|
2407
2466
|
* @param request - DescribeAuditRecordsRequest
|
|
2408
2467
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2493,12 +2552,12 @@ export default class Client extends OpenApi {
|
|
|
2493
2552
|
}
|
|
2494
2553
|
|
|
2495
2554
|
/**
|
|
2496
|
-
* Queries
|
|
2555
|
+
* Queries audit log entries for a MongoDB instance.
|
|
2497
2556
|
*
|
|
2498
2557
|
* @remarks
|
|
2499
|
-
*
|
|
2500
|
-
*
|
|
2501
|
-
*
|
|
2558
|
+
* - When you call this operation, ensure that the audit log feature of the instance is enabled. Otherwise, the operation returns an empty audit log.
|
|
2559
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
2560
|
+
* - 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).
|
|
2502
2561
|
*
|
|
2503
2562
|
* @param request - DescribeAuditRecordsRequest
|
|
2504
2563
|
* @returns DescribeAuditRecordsResponse
|
|
@@ -2782,11 +2841,11 @@ export default class Client extends OpenApi {
|
|
|
2782
2841
|
* @remarks
|
|
2783
2842
|
* 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).
|
|
2784
2843
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
2785
|
-
*
|
|
2786
|
-
*
|
|
2787
|
-
*
|
|
2788
|
-
*
|
|
2789
|
-
*
|
|
2844
|
+
* - The instance was created after March 26, 2019.
|
|
2845
|
+
* - 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.
|
|
2846
|
+
* - The instance is a replica set instance.
|
|
2847
|
+
* - The instance runs MongoDB 3.4, MongoDB 4.0, or MongoDB 4.2. In addition, the instance uses local disks to store data.
|
|
2848
|
+
* - The storage engine of the instance is WiredTiger.
|
|
2790
2849
|
*
|
|
2791
2850
|
* @param request - DescribeBackupDBsRequest
|
|
2792
2851
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2862,11 +2921,11 @@ export default class Client extends OpenApi {
|
|
|
2862
2921
|
* @remarks
|
|
2863
2922
|
* 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).
|
|
2864
2923
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
2865
|
-
*
|
|
2866
|
-
*
|
|
2867
|
-
*
|
|
2868
|
-
*
|
|
2869
|
-
*
|
|
2924
|
+
* - The instance was created after March 26, 2019.
|
|
2925
|
+
* - 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.
|
|
2926
|
+
* - The instance is a replica set instance.
|
|
2927
|
+
* - The instance runs MongoDB 3.4, MongoDB 4.0, or MongoDB 4.2. In addition, the instance uses local disks to store data.
|
|
2928
|
+
* - The storage engine of the instance is WiredTiger.
|
|
2870
2929
|
*
|
|
2871
2930
|
* @param request - DescribeBackupDBsRequest
|
|
2872
2931
|
* @returns DescribeBackupDBsResponse
|
|
@@ -2877,7 +2936,7 @@ export default class Client extends OpenApi {
|
|
|
2877
2936
|
}
|
|
2878
2937
|
|
|
2879
2938
|
/**
|
|
2880
|
-
* Queries the backup policy of
|
|
2939
|
+
* Queries the backup policy of a MongoDB instance.
|
|
2881
2940
|
*
|
|
2882
2941
|
* @param request - DescribeBackupPolicyRequest
|
|
2883
2942
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2936,7 +2995,7 @@ export default class Client extends OpenApi {
|
|
|
2936
2995
|
}
|
|
2937
2996
|
|
|
2938
2997
|
/**
|
|
2939
|
-
* Queries the backup policy of
|
|
2998
|
+
* Queries the backup policy of a MongoDB instance.
|
|
2940
2999
|
*
|
|
2941
3000
|
* @param request - DescribeBackupPolicyRequest
|
|
2942
3001
|
* @returns DescribeBackupPolicyResponse
|
|
@@ -2947,7 +3006,10 @@ export default class Client extends OpenApi {
|
|
|
2947
3006
|
}
|
|
2948
3007
|
|
|
2949
3008
|
/**
|
|
2950
|
-
* Queries the backup
|
|
3009
|
+
* Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks.
|
|
3010
|
+
*
|
|
3011
|
+
* @remarks
|
|
3012
|
+
* 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.
|
|
2951
3013
|
*
|
|
2952
3014
|
* @param request - DescribeBackupStorageRequest
|
|
2953
3015
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3002,7 +3064,10 @@ export default class Client extends OpenApi {
|
|
|
3002
3064
|
}
|
|
3003
3065
|
|
|
3004
3066
|
/**
|
|
3005
|
-
* Queries the backup
|
|
3067
|
+
* Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks.
|
|
3068
|
+
*
|
|
3069
|
+
* @remarks
|
|
3070
|
+
* 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.
|
|
3006
3071
|
*
|
|
3007
3072
|
* @param request - DescribeBackupStorageRequest
|
|
3008
3073
|
* @returns DescribeBackupStorageResponse
|
|
@@ -3013,7 +3078,7 @@ export default class Client extends OpenApi {
|
|
|
3013
3078
|
}
|
|
3014
3079
|
|
|
3015
3080
|
/**
|
|
3016
|
-
* Queries backup
|
|
3081
|
+
* Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks.
|
|
3017
3082
|
*
|
|
3018
3083
|
* @param request - DescribeBackupTasksRequest
|
|
3019
3084
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3068,7 +3133,7 @@ export default class Client extends OpenApi {
|
|
|
3068
3133
|
}
|
|
3069
3134
|
|
|
3070
3135
|
/**
|
|
3071
|
-
* Queries backup
|
|
3136
|
+
* Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks.
|
|
3072
3137
|
*
|
|
3073
3138
|
* @param request - DescribeBackupTasksRequest
|
|
3074
3139
|
* @returns DescribeBackupTasksResponse
|
|
@@ -3079,7 +3144,7 @@ export default class Client extends OpenApi {
|
|
|
3079
3144
|
}
|
|
3080
3145
|
|
|
3081
3146
|
/**
|
|
3082
|
-
* Queries the
|
|
3147
|
+
* Queries the backups of a MongoDB instance.
|
|
3083
3148
|
*
|
|
3084
3149
|
* @param request - DescribeBackupsRequest
|
|
3085
3150
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3166,7 +3231,7 @@ export default class Client extends OpenApi {
|
|
|
3166
3231
|
}
|
|
3167
3232
|
|
|
3168
3233
|
/**
|
|
3169
|
-
* Queries the
|
|
3234
|
+
* Queries the backups of a MongoDB instance.
|
|
3170
3235
|
*
|
|
3171
3236
|
* @param request - DescribeBackupsRequest
|
|
3172
3237
|
* @returns DescribeBackupsResponse
|
|
@@ -3177,7 +3242,7 @@ export default class Client extends OpenApi {
|
|
|
3177
3242
|
}
|
|
3178
3243
|
|
|
3179
3244
|
/**
|
|
3180
|
-
*
|
|
3245
|
+
* Query log backup files for an ApsaraDB for MongoDB instance.
|
|
3181
3246
|
*
|
|
3182
3247
|
* @param request - DescribeBinlogFilesRequest
|
|
3183
3248
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3264,7 +3329,7 @@ export default class Client extends OpenApi {
|
|
|
3264
3329
|
}
|
|
3265
3330
|
|
|
3266
3331
|
/**
|
|
3267
|
-
*
|
|
3332
|
+
* Query log backup files for an ApsaraDB for MongoDB instance.
|
|
3268
3333
|
*
|
|
3269
3334
|
* @param request - DescribeBinlogFilesRequest
|
|
3270
3335
|
* @returns DescribeBinlogFilesResponse
|
|
@@ -3275,11 +3340,11 @@ export default class Client extends OpenApi {
|
|
|
3275
3340
|
}
|
|
3276
3341
|
|
|
3277
3342
|
/**
|
|
3278
|
-
* Queries the backup sets
|
|
3343
|
+
* Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
3279
3344
|
*
|
|
3280
3345
|
* @remarks
|
|
3281
|
-
* For
|
|
3282
|
-
*
|
|
3346
|
+
* 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.
|
|
3347
|
+
* Sharded cluster instances that use cloud disks and were created after October 19, 2023 use cluster backups by default.
|
|
3283
3348
|
*
|
|
3284
3349
|
* @param request - DescribeClusterBackupsRequest
|
|
3285
3350
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3366,11 +3431,11 @@ export default class Client extends OpenApi {
|
|
|
3366
3431
|
}
|
|
3367
3432
|
|
|
3368
3433
|
/**
|
|
3369
|
-
* Queries the backup sets
|
|
3434
|
+
* Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
3370
3435
|
*
|
|
3371
3436
|
* @remarks
|
|
3372
|
-
* For
|
|
3373
|
-
*
|
|
3437
|
+
* 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.
|
|
3438
|
+
* Sharded cluster instances that use cloud disks and were created after October 19, 2023 use cluster backups by default.
|
|
3374
3439
|
*
|
|
3375
3440
|
* @param request - DescribeClusterBackupsRequest
|
|
3376
3441
|
* @returns DescribeClusterBackupsResponse
|
|
@@ -3381,11 +3446,11 @@ export default class Client extends OpenApi {
|
|
|
3381
3446
|
}
|
|
3382
3447
|
|
|
3383
3448
|
/**
|
|
3384
|
-
* Queries the time range
|
|
3449
|
+
* Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB.
|
|
3385
3450
|
*
|
|
3386
3451
|
* @remarks
|
|
3387
|
-
*
|
|
3388
|
-
*
|
|
3452
|
+
* - 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.
|
|
3453
|
+
* - 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.
|
|
3389
3454
|
*
|
|
3390
3455
|
* @param request - DescribeClusterRecoverTimeRequest
|
|
3391
3456
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3402,6 +3467,10 @@ export default class Client extends OpenApi {
|
|
|
3402
3467
|
query["DestRegion"] = request.destRegion;
|
|
3403
3468
|
}
|
|
3404
3469
|
|
|
3470
|
+
if (!$dara.isNull(request.onlyDbTableRecovery)) {
|
|
3471
|
+
query["OnlyDbTableRecovery"] = request.onlyDbTableRecovery;
|
|
3472
|
+
}
|
|
3473
|
+
|
|
3405
3474
|
if (!$dara.isNull(request.ownerAccount)) {
|
|
3406
3475
|
query["OwnerAccount"] = request.ownerAccount;
|
|
3407
3476
|
}
|
|
@@ -3444,11 +3513,11 @@ export default class Client extends OpenApi {
|
|
|
3444
3513
|
}
|
|
3445
3514
|
|
|
3446
3515
|
/**
|
|
3447
|
-
* Queries the time range
|
|
3516
|
+
* Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB.
|
|
3448
3517
|
*
|
|
3449
3518
|
* @remarks
|
|
3450
|
-
*
|
|
3451
|
-
*
|
|
3519
|
+
* - 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.
|
|
3520
|
+
* - 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.
|
|
3452
3521
|
*
|
|
3453
3522
|
* @param request - DescribeClusterRecoverTimeRequest
|
|
3454
3523
|
* @returns DescribeClusterRecoverTimeResponse
|
|
@@ -3459,7 +3528,7 @@ export default class Client extends OpenApi {
|
|
|
3459
3528
|
}
|
|
3460
3529
|
|
|
3461
3530
|
/**
|
|
3462
|
-
* Queries
|
|
3531
|
+
* Queries information about an ApsaraDB for MongoDB instance.
|
|
3463
3532
|
*
|
|
3464
3533
|
* @param request - DescribeDBInstanceAttributeRequest
|
|
3465
3534
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3522,7 +3591,7 @@ export default class Client extends OpenApi {
|
|
|
3522
3591
|
}
|
|
3523
3592
|
|
|
3524
3593
|
/**
|
|
3525
|
-
* Queries
|
|
3594
|
+
* Queries information about an ApsaraDB for MongoDB instance.
|
|
3526
3595
|
*
|
|
3527
3596
|
* @param request - DescribeDBInstanceAttributeRequest
|
|
3528
3597
|
* @returns DescribeDBInstanceAttributeResponse
|
|
@@ -3533,7 +3602,7 @@ export default class Client extends OpenApi {
|
|
|
3533
3602
|
}
|
|
3534
3603
|
|
|
3535
3604
|
/**
|
|
3536
|
-
* Queries the
|
|
3605
|
+
* Queries the encryption key of a MongoDB instance.
|
|
3537
3606
|
*
|
|
3538
3607
|
* @remarks
|
|
3539
3608
|
* 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.
|
|
@@ -3587,7 +3656,7 @@ export default class Client extends OpenApi {
|
|
|
3587
3656
|
}
|
|
3588
3657
|
|
|
3589
3658
|
/**
|
|
3590
|
-
* Queries the
|
|
3659
|
+
* Queries the encryption key of a MongoDB instance.
|
|
3591
3660
|
*
|
|
3592
3661
|
* @remarks
|
|
3593
3662
|
* 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.
|
|
@@ -3659,7 +3728,7 @@ export default class Client extends OpenApi {
|
|
|
3659
3728
|
}
|
|
3660
3729
|
|
|
3661
3730
|
/**
|
|
3662
|
-
* Queries the performance data of
|
|
3731
|
+
* Queries the performance data of a MongoDB instance.
|
|
3663
3732
|
*
|
|
3664
3733
|
* @param request - DescribeDBInstancePerformanceRequest
|
|
3665
3734
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3738,7 +3807,7 @@ export default class Client extends OpenApi {
|
|
|
3738
3807
|
}
|
|
3739
3808
|
|
|
3740
3809
|
/**
|
|
3741
|
-
* Queries the performance data of
|
|
3810
|
+
* Queries the performance data of a MongoDB instance.
|
|
3742
3811
|
*
|
|
3743
3812
|
* @param request - DescribeDBInstancePerformanceRequest
|
|
3744
3813
|
* @returns DescribeDBInstancePerformanceResponse
|
|
@@ -3749,13 +3818,14 @@ export default class Client extends OpenApi {
|
|
|
3749
3818
|
}
|
|
3750
3819
|
|
|
3751
3820
|
/**
|
|
3752
|
-
*
|
|
3821
|
+
* Query SSL configuration details for a MongoDB instance.
|
|
3753
3822
|
*
|
|
3754
3823
|
* @remarks
|
|
3755
|
-
*
|
|
3756
|
-
*
|
|
3757
|
-
*
|
|
3758
|
-
*
|
|
3824
|
+
* To use this operation, the instance must meet the following requirements:
|
|
3825
|
+
* - The instance status is Running.
|
|
3826
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
3827
|
+
* - The replica set instance must be version 3.4 or later.
|
|
3828
|
+
* - The sharded cluster instance must use Enhanced SSDs (ESSDs).
|
|
3759
3829
|
*
|
|
3760
3830
|
* @param request - DescribeDBInstanceSSLRequest
|
|
3761
3831
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3802,13 +3872,14 @@ export default class Client extends OpenApi {
|
|
|
3802
3872
|
}
|
|
3803
3873
|
|
|
3804
3874
|
/**
|
|
3805
|
-
*
|
|
3875
|
+
* Query SSL configuration details for a MongoDB instance.
|
|
3806
3876
|
*
|
|
3807
3877
|
* @remarks
|
|
3808
|
-
*
|
|
3809
|
-
*
|
|
3810
|
-
*
|
|
3811
|
-
*
|
|
3878
|
+
* To use this operation, the instance must meet the following requirements:
|
|
3879
|
+
* - The instance status is Running.
|
|
3880
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
3881
|
+
* - The replica set instance must be version 3.4 or later.
|
|
3882
|
+
* - The sharded cluster instance must use Enhanced SSDs (ESSDs).
|
|
3812
3883
|
*
|
|
3813
3884
|
* @param request - DescribeDBInstanceSSLRequest
|
|
3814
3885
|
* @returns DescribeDBInstanceSSLResponse
|
|
@@ -3819,7 +3890,7 @@ export default class Client extends OpenApi {
|
|
|
3819
3890
|
}
|
|
3820
3891
|
|
|
3821
3892
|
/**
|
|
3822
|
-
*
|
|
3893
|
+
* Gets instance type details.
|
|
3823
3894
|
*
|
|
3824
3895
|
* @param request - DescribeDBInstanceSpecInfoRequest
|
|
3825
3896
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3870,7 +3941,7 @@ export default class Client extends OpenApi {
|
|
|
3870
3941
|
}
|
|
3871
3942
|
|
|
3872
3943
|
/**
|
|
3873
|
-
*
|
|
3944
|
+
* Gets instance type details.
|
|
3874
3945
|
*
|
|
3875
3946
|
* @param request - DescribeDBInstanceSpecInfoRequest
|
|
3876
3947
|
* @returns DescribeDBInstanceSpecInfoResponse
|
|
@@ -3885,8 +3956,8 @@ export default class Client extends OpenApi {
|
|
|
3885
3956
|
*
|
|
3886
3957
|
* @remarks
|
|
3887
3958
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
3888
|
-
*
|
|
3889
|
-
*
|
|
3959
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
3960
|
+
* - The instance uses local physical disks to store data.
|
|
3890
3961
|
*
|
|
3891
3962
|
* @param request - DescribeDBInstanceSwitchLogRequest
|
|
3892
3963
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3941,8 +4012,8 @@ export default class Client extends OpenApi {
|
|
|
3941
4012
|
*
|
|
3942
4013
|
* @remarks
|
|
3943
4014
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
3944
|
-
*
|
|
3945
|
-
*
|
|
4015
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
4016
|
+
* - The instance uses local physical disks to store data.
|
|
3946
4017
|
*
|
|
3947
4018
|
* @param request - DescribeDBInstanceSwitchLogRequest
|
|
3948
4019
|
* @returns DescribeDBInstanceSwitchLogResponse
|
|
@@ -3956,11 +4027,11 @@ export default class Client extends OpenApi {
|
|
|
3956
4027
|
* Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.
|
|
3957
4028
|
*
|
|
3958
4029
|
* @remarks
|
|
3959
|
-
* >
|
|
3960
|
-
*
|
|
3961
|
-
*
|
|
3962
|
-
*
|
|
3963
|
-
*
|
|
4030
|
+
* > For more information about this feature, see [Settings for transparent data encryption TDE](https://help.aliyun.com/document_detail/131048.html).
|
|
4031
|
+
* When you invoke this operation, the instance must meet the following conditions:
|
|
4032
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
4033
|
+
* - The storage DPI engine of the instance is WiredTiger.
|
|
4034
|
+
* - 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.
|
|
3964
4035
|
*
|
|
3965
4036
|
* @param request - DescribeDBInstanceTDEInfoRequest
|
|
3966
4037
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4010,11 +4081,11 @@ export default class Client extends OpenApi {
|
|
|
4010
4081
|
* Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.
|
|
4011
4082
|
*
|
|
4012
4083
|
* @remarks
|
|
4013
|
-
* >
|
|
4014
|
-
*
|
|
4015
|
-
*
|
|
4016
|
-
*
|
|
4017
|
-
*
|
|
4084
|
+
* > For more information about this feature, see [Settings for transparent data encryption TDE](https://help.aliyun.com/document_detail/131048.html).
|
|
4085
|
+
* When you invoke this operation, the instance must meet the following conditions:
|
|
4086
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
4087
|
+
* - The storage DPI engine of the instance is WiredTiger.
|
|
4088
|
+
* - 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.
|
|
4018
4089
|
*
|
|
4019
4090
|
* @param request - DescribeDBInstanceTDEInfoRequest
|
|
4020
4091
|
* @returns DescribeDBInstanceTDEInfoResponse
|
|
@@ -4025,10 +4096,11 @@ export default class Client extends OpenApi {
|
|
|
4025
4096
|
}
|
|
4026
4097
|
|
|
4027
4098
|
/**
|
|
4028
|
-
* Queries a list of
|
|
4099
|
+
* Queries a list of MongoDB instances.
|
|
4029
4100
|
*
|
|
4030
4101
|
* @remarks
|
|
4031
|
-
*
|
|
4102
|
+
* <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**.
|
|
4103
|
+
* <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**.
|
|
4032
4104
|
*
|
|
4033
4105
|
* @param request - DescribeDBInstancesRequest
|
|
4034
4106
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4159,10 +4231,11 @@ export default class Client extends OpenApi {
|
|
|
4159
4231
|
}
|
|
4160
4232
|
|
|
4161
4233
|
/**
|
|
4162
|
-
* Queries a list of
|
|
4234
|
+
* Queries a list of MongoDB instances.
|
|
4163
4235
|
*
|
|
4164
4236
|
* @remarks
|
|
4165
|
-
*
|
|
4237
|
+
* <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**.
|
|
4238
|
+
* <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**.
|
|
4166
4239
|
*
|
|
4167
4240
|
* @param request - DescribeDBInstancesRequest
|
|
4168
4241
|
* @returns DescribeDBInstancesResponse
|
|
@@ -4173,11 +4246,11 @@ export default class Client extends OpenApi {
|
|
|
4173
4246
|
}
|
|
4174
4247
|
|
|
4175
4248
|
/**
|
|
4176
|
-
* Queries the overview
|
|
4249
|
+
* Queries the overview of one or more ApsaraDB for MongoDB instances.
|
|
4177
4250
|
*
|
|
4178
4251
|
* @remarks
|
|
4179
|
-
*
|
|
4180
|
-
*
|
|
4252
|
+
* - 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.
|
|
4253
|
+
* - The results of this operation are not paginated.
|
|
4181
4254
|
*
|
|
4182
4255
|
* @param request - DescribeDBInstancesOverviewRequest
|
|
4183
4256
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4272,11 +4345,11 @@ export default class Client extends OpenApi {
|
|
|
4272
4345
|
}
|
|
4273
4346
|
|
|
4274
4347
|
/**
|
|
4275
|
-
* Queries the overview
|
|
4348
|
+
* Queries the overview of one or more ApsaraDB for MongoDB instances.
|
|
4276
4349
|
*
|
|
4277
4350
|
* @remarks
|
|
4278
|
-
*
|
|
4279
|
-
*
|
|
4351
|
+
* - 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.
|
|
4352
|
+
* - The results of this operation are not paginated.
|
|
4280
4353
|
*
|
|
4281
4354
|
* @param request - DescribeDBInstancesOverviewRequest
|
|
4282
4355
|
* @returns DescribeDBInstancesOverviewResponse
|
|
@@ -4287,11 +4360,11 @@ export default class Client extends OpenApi {
|
|
|
4287
4360
|
}
|
|
4288
4361
|
|
|
4289
4362
|
/**
|
|
4290
|
-
* Queries
|
|
4363
|
+
* Queries error log entries for a MongoDB instance.
|
|
4291
4364
|
*
|
|
4292
4365
|
* @remarks
|
|
4293
|
-
*
|
|
4294
|
-
*
|
|
4366
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
4367
|
+
* - 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).
|
|
4295
4368
|
*
|
|
4296
4369
|
* @param request - DescribeErrorLogRecordsRequest
|
|
4297
4370
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4378,11 +4451,11 @@ export default class Client extends OpenApi {
|
|
|
4378
4451
|
}
|
|
4379
4452
|
|
|
4380
4453
|
/**
|
|
4381
|
-
* Queries
|
|
4454
|
+
* Queries error log entries for a MongoDB instance.
|
|
4382
4455
|
*
|
|
4383
4456
|
* @remarks
|
|
4384
|
-
*
|
|
4385
|
-
*
|
|
4457
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
4458
|
+
* - 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).
|
|
4386
4459
|
*
|
|
4387
4460
|
* @param request - DescribeErrorLogRecordsRequest
|
|
4388
4461
|
* @returns DescribeErrorLogRecordsResponse
|
|
@@ -4431,7 +4504,7 @@ export default class Client extends OpenApi {
|
|
|
4431
4504
|
}
|
|
4432
4505
|
|
|
4433
4506
|
/**
|
|
4434
|
-
* Queries the
|
|
4507
|
+
* Queries the mapping between an instance and a global IP address whitelist template.
|
|
4435
4508
|
*
|
|
4436
4509
|
* @param request - DescribeGlobalSecurityIPGroupRelationRequest
|
|
4437
4510
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4482,7 +4555,7 @@ export default class Client extends OpenApi {
|
|
|
4482
4555
|
}
|
|
4483
4556
|
|
|
4484
4557
|
/**
|
|
4485
|
-
* Queries the
|
|
4558
|
+
* Queries the mapping between an instance and a global IP address whitelist template.
|
|
4486
4559
|
*
|
|
4487
4560
|
* @param request - DescribeGlobalSecurityIPGroupRelationRequest
|
|
4488
4561
|
* @returns DescribeGlobalSecurityIPGroupRelationResponse
|
|
@@ -4677,7 +4750,7 @@ export default class Client extends OpenApi {
|
|
|
4677
4750
|
}
|
|
4678
4751
|
|
|
4679
4752
|
/**
|
|
4680
|
-
*
|
|
4753
|
+
* Queries the auto-renewal status of MongoDB instances.
|
|
4681
4754
|
*
|
|
4682
4755
|
* @remarks
|
|
4683
4756
|
* This operation is applicable to subscription instances.
|
|
@@ -4743,7 +4816,7 @@ export default class Client extends OpenApi {
|
|
|
4743
4816
|
}
|
|
4744
4817
|
|
|
4745
4818
|
/**
|
|
4746
|
-
*
|
|
4819
|
+
* Queries the auto-renewal status of MongoDB instances.
|
|
4747
4820
|
*
|
|
4748
4821
|
* @remarks
|
|
4749
4822
|
* This operation is applicable to subscription instances.
|
|
@@ -4757,7 +4830,7 @@ export default class Client extends OpenApi {
|
|
|
4757
4830
|
}
|
|
4758
4831
|
|
|
4759
4832
|
/**
|
|
4760
|
-
* Queries the time
|
|
4833
|
+
* Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks.
|
|
4761
4834
|
*
|
|
4762
4835
|
* @param request - DescribeInstanceRecoverTimeRequest
|
|
4763
4836
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4774,6 +4847,10 @@ export default class Client extends OpenApi {
|
|
|
4774
4847
|
query["DestRegion"] = request.destRegion;
|
|
4775
4848
|
}
|
|
4776
4849
|
|
|
4850
|
+
if (!$dara.isNull(request.onlyDbTableRecovery)) {
|
|
4851
|
+
query["OnlyDbTableRecovery"] = request.onlyDbTableRecovery;
|
|
4852
|
+
}
|
|
4853
|
+
|
|
4777
4854
|
if (!$dara.isNull(request.ownerAccount)) {
|
|
4778
4855
|
query["OwnerAccount"] = request.ownerAccount;
|
|
4779
4856
|
}
|
|
@@ -4820,7 +4897,7 @@ export default class Client extends OpenApi {
|
|
|
4820
4897
|
}
|
|
4821
4898
|
|
|
4822
4899
|
/**
|
|
4823
|
-
* Queries the time
|
|
4900
|
+
* Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks.
|
|
4824
4901
|
*
|
|
4825
4902
|
* @param request - DescribeInstanceRecoverTimeRequest
|
|
4826
4903
|
* @returns DescribeInstanceRecoverTimeResponse
|
|
@@ -4949,13 +5026,13 @@ export default class Client extends OpenApi {
|
|
|
4949
5026
|
}
|
|
4950
5027
|
|
|
4951
5028
|
/**
|
|
4952
|
-
*
|
|
5029
|
+
* You can view the configuration of MongoDB Log Service.
|
|
4953
5030
|
*
|
|
4954
5031
|
* @remarks
|
|
4955
|
-
* This
|
|
4956
|
-
*
|
|
4957
|
-
*
|
|
4958
|
-
*
|
|
5032
|
+
* This API applies to General-purpose and Dedicated instances that use local disks.
|
|
5033
|
+
* 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).
|
|
5034
|
+
* - 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~~).
|
|
5035
|
+
* - 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).
|
|
4959
5036
|
*
|
|
4960
5037
|
* @param request - DescribeMongoDBLogConfigRequest
|
|
4961
5038
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5002,13 +5079,13 @@ export default class Client extends OpenApi {
|
|
|
5002
5079
|
}
|
|
5003
5080
|
|
|
5004
5081
|
/**
|
|
5005
|
-
*
|
|
5082
|
+
* You can view the configuration of MongoDB Log Service.
|
|
5006
5083
|
*
|
|
5007
5084
|
* @remarks
|
|
5008
|
-
* This
|
|
5009
|
-
*
|
|
5010
|
-
*
|
|
5011
|
-
*
|
|
5085
|
+
* This API applies to General-purpose and Dedicated instances that use local disks.
|
|
5086
|
+
* 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).
|
|
5087
|
+
* - 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~~).
|
|
5088
|
+
* - 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).
|
|
5012
5089
|
*
|
|
5013
5090
|
* @param request - DescribeMongoDBLogConfigRequest
|
|
5014
5091
|
* @returns DescribeMongoDBLogConfigResponse
|
|
@@ -5093,7 +5170,7 @@ export default class Client extends OpenApi {
|
|
|
5093
5170
|
}
|
|
5094
5171
|
|
|
5095
5172
|
/**
|
|
5096
|
-
* Queries the
|
|
5173
|
+
* Queries the default parameter templates for MongoDB instances.
|
|
5097
5174
|
*
|
|
5098
5175
|
* @param request - DescribeParameterTemplatesRequest
|
|
5099
5176
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5152,7 +5229,7 @@ export default class Client extends OpenApi {
|
|
|
5152
5229
|
}
|
|
5153
5230
|
|
|
5154
5231
|
/**
|
|
5155
|
-
* Queries the
|
|
5232
|
+
* Queries the default parameter templates for MongoDB instances.
|
|
5156
5233
|
*
|
|
5157
5234
|
* @param request - DescribeParameterTemplatesRequest
|
|
5158
5235
|
* @returns DescribeParameterTemplatesResponse
|
|
@@ -5233,7 +5310,7 @@ export default class Client extends OpenApi {
|
|
|
5233
5310
|
}
|
|
5234
5311
|
|
|
5235
5312
|
/**
|
|
5236
|
-
*
|
|
5313
|
+
* Query prices.
|
|
5237
5314
|
*
|
|
5238
5315
|
* @param request - DescribePriceRequest
|
|
5239
5316
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5312,7 +5389,7 @@ export default class Client extends OpenApi {
|
|
|
5312
5389
|
}
|
|
5313
5390
|
|
|
5314
5391
|
/**
|
|
5315
|
-
*
|
|
5392
|
+
* Query prices.
|
|
5316
5393
|
*
|
|
5317
5394
|
* @param request - DescribePriceRequest
|
|
5318
5395
|
* @returns DescribePriceResponse
|
|
@@ -5323,6 +5400,11 @@ export default class Client extends OpenApi {
|
|
|
5323
5400
|
}
|
|
5324
5401
|
|
|
5325
5402
|
/**
|
|
5403
|
+
* Retrieves a list of vSwitches.
|
|
5404
|
+
*
|
|
5405
|
+
* @remarks
|
|
5406
|
+
* 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.
|
|
5407
|
+
*
|
|
5326
5408
|
* @param request - DescribeRdsVSwitchsRequest
|
|
5327
5409
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
5328
5410
|
* @returns DescribeRdsVSwitchsResponse
|
|
@@ -5376,6 +5458,11 @@ export default class Client extends OpenApi {
|
|
|
5376
5458
|
}
|
|
5377
5459
|
|
|
5378
5460
|
/**
|
|
5461
|
+
* Retrieves a list of vSwitches.
|
|
5462
|
+
*
|
|
5463
|
+
* @remarks
|
|
5464
|
+
* 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.
|
|
5465
|
+
*
|
|
5379
5466
|
* @param request - DescribeRdsVSwitchsRequest
|
|
5380
5467
|
* @returns DescribeRdsVSwitchsResponse
|
|
5381
5468
|
*/
|
|
@@ -5385,6 +5472,11 @@ export default class Client extends OpenApi {
|
|
|
5385
5472
|
}
|
|
5386
5473
|
|
|
5387
5474
|
/**
|
|
5475
|
+
* Retrieves a list of VPCs.
|
|
5476
|
+
*
|
|
5477
|
+
* @remarks
|
|
5478
|
+
* Queries available VPCs in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a VPC.
|
|
5479
|
+
*
|
|
5388
5480
|
* @param request - DescribeRdsVpcsRequest
|
|
5389
5481
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
5390
5482
|
* @returns DescribeRdsVpcsResponse
|
|
@@ -5434,6 +5526,11 @@ export default class Client extends OpenApi {
|
|
|
5434
5526
|
}
|
|
5435
5527
|
|
|
5436
5528
|
/**
|
|
5529
|
+
* Retrieves a list of VPCs.
|
|
5530
|
+
*
|
|
5531
|
+
* @remarks
|
|
5532
|
+
* Queries available VPCs in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a VPC.
|
|
5533
|
+
*
|
|
5437
5534
|
* @param request - DescribeRdsVpcsRequest
|
|
5438
5535
|
* @returns DescribeRdsVpcsResponse
|
|
5439
5536
|
*/
|
|
@@ -5446,7 +5543,7 @@ export default class Client extends OpenApi {
|
|
|
5446
5543
|
* Queries all regions and zones supported for an ApsaraDB for MongoDB instance.
|
|
5447
5544
|
*
|
|
5448
5545
|
* @remarks
|
|
5449
|
-
* >
|
|
5546
|
+
* > 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.
|
|
5450
5547
|
*
|
|
5451
5548
|
* @param request - DescribeRegionsRequest
|
|
5452
5549
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5500,7 +5597,7 @@ export default class Client extends OpenApi {
|
|
|
5500
5597
|
* Queries all regions and zones supported for an ApsaraDB for MongoDB instance.
|
|
5501
5598
|
*
|
|
5502
5599
|
* @remarks
|
|
5503
|
-
* >
|
|
5600
|
+
* > 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.
|
|
5504
5601
|
*
|
|
5505
5602
|
* @param request - DescribeRegionsRequest
|
|
5506
5603
|
* @returns DescribeRegionsResponse
|
|
@@ -5511,10 +5608,10 @@ export default class Client extends OpenApi {
|
|
|
5511
5608
|
}
|
|
5512
5609
|
|
|
5513
5610
|
/**
|
|
5514
|
-
*
|
|
5611
|
+
* Get the price to renew a specific MongoDB instance for one month.
|
|
5515
5612
|
*
|
|
5516
5613
|
* @remarks
|
|
5517
|
-
* This operation
|
|
5614
|
+
* This operation applies to subscription MongoDB instances.
|
|
5518
5615
|
*
|
|
5519
5616
|
* @param request - DescribeRenewalPriceRequest
|
|
5520
5617
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5569,10 +5666,10 @@ export default class Client extends OpenApi {
|
|
|
5569
5666
|
}
|
|
5570
5667
|
|
|
5571
5668
|
/**
|
|
5572
|
-
*
|
|
5669
|
+
* Get the price to renew a specific MongoDB instance for one month.
|
|
5573
5670
|
*
|
|
5574
5671
|
* @remarks
|
|
5575
|
-
* This operation
|
|
5672
|
+
* This operation applies to subscription MongoDB instances.
|
|
5576
5673
|
*
|
|
5577
5674
|
* @param request - DescribeRenewalPriceRequest
|
|
5578
5675
|
* @returns DescribeRenewalPriceResponse
|
|
@@ -5583,10 +5680,10 @@ export default class Client extends OpenApi {
|
|
|
5583
5680
|
}
|
|
5584
5681
|
|
|
5585
5682
|
/**
|
|
5586
|
-
*
|
|
5683
|
+
* Retrieves the role information and connection details for a MongoDB instance.
|
|
5587
5684
|
*
|
|
5588
5685
|
* @remarks
|
|
5589
|
-
* This operation
|
|
5686
|
+
* This operation applies to replica set instances and single-node instances. It does not apply to sharded cluster instances.
|
|
5590
5687
|
*
|
|
5591
5688
|
* @param request - DescribeReplicaSetRoleRequest
|
|
5592
5689
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5633,10 +5730,10 @@ export default class Client extends OpenApi {
|
|
|
5633
5730
|
}
|
|
5634
5731
|
|
|
5635
5732
|
/**
|
|
5636
|
-
*
|
|
5733
|
+
* Retrieves the role information and connection details for a MongoDB instance.
|
|
5637
5734
|
*
|
|
5638
5735
|
* @remarks
|
|
5639
|
-
* This operation
|
|
5736
|
+
* This operation applies to replica set instances and single-node instances. It does not apply to sharded cluster instances.
|
|
5640
5737
|
*
|
|
5641
5738
|
* @param request - DescribeReplicaSetRoleRequest
|
|
5642
5739
|
* @returns DescribeReplicaSetRoleResponse
|
|
@@ -5717,6 +5814,8 @@ export default class Client extends OpenApi {
|
|
|
5717
5814
|
}
|
|
5718
5815
|
|
|
5719
5816
|
/**
|
|
5817
|
+
* Describes the status of a tag for a node.
|
|
5818
|
+
*
|
|
5720
5819
|
* @param request - DescribeRoleTagStatusRequest
|
|
5721
5820
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
5722
5821
|
* @returns DescribeRoleTagStatusResponse
|
|
@@ -5762,6 +5861,8 @@ export default class Client extends OpenApi {
|
|
|
5762
5861
|
}
|
|
5763
5862
|
|
|
5764
5863
|
/**
|
|
5864
|
+
* Describes the status of a tag for a node.
|
|
5865
|
+
*
|
|
5765
5866
|
* @param request - DescribeRoleTagStatusRequest
|
|
5766
5867
|
* @returns DescribeRoleTagStatusResponse
|
|
5767
5868
|
*/
|
|
@@ -5837,11 +5938,11 @@ export default class Client extends OpenApi {
|
|
|
5837
5938
|
}
|
|
5838
5939
|
|
|
5839
5940
|
/**
|
|
5840
|
-
*
|
|
5941
|
+
* View the running logs for a MongoDB instance.
|
|
5841
5942
|
*
|
|
5842
5943
|
* @remarks
|
|
5843
|
-
*
|
|
5844
|
-
*
|
|
5944
|
+
* - This API is for instances with the following specification types: **general-purpose local disk**, **dedicated local disk**, and **cloud disk**.
|
|
5945
|
+
* - 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).
|
|
5845
5946
|
*
|
|
5846
5947
|
* @param request - DescribeRunningLogRecordsRequest
|
|
5847
5948
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5936,11 +6037,11 @@ export default class Client extends OpenApi {
|
|
|
5936
6037
|
}
|
|
5937
6038
|
|
|
5938
6039
|
/**
|
|
5939
|
-
*
|
|
6040
|
+
* View the running logs for a MongoDB instance.
|
|
5940
6041
|
*
|
|
5941
6042
|
* @remarks
|
|
5942
|
-
*
|
|
5943
|
-
*
|
|
6043
|
+
* - This API is for instances with the following specification types: **general-purpose local disk**, **dedicated local disk**, and **cloud disk**.
|
|
6044
|
+
* - 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).
|
|
5944
6045
|
*
|
|
5945
6046
|
* @param request - DescribeRunningLogRecordsRequest
|
|
5946
6047
|
* @returns DescribeRunningLogRecordsResponse
|
|
@@ -6009,7 +6110,7 @@ export default class Client extends OpenApi {
|
|
|
6009
6110
|
}
|
|
6010
6111
|
|
|
6011
6112
|
/**
|
|
6012
|
-
*
|
|
6113
|
+
* Retrieves the IP whitelists of an ApsaraDB for MongoDB instance.
|
|
6013
6114
|
*
|
|
6014
6115
|
* @param request - DescribeSecurityIpsRequest
|
|
6015
6116
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6060,7 +6161,7 @@ export default class Client extends OpenApi {
|
|
|
6060
6161
|
}
|
|
6061
6162
|
|
|
6062
6163
|
/**
|
|
6063
|
-
*
|
|
6164
|
+
* Retrieves the IP whitelists of an ApsaraDB for MongoDB instance.
|
|
6064
6165
|
*
|
|
6065
6166
|
* @param request - DescribeSecurityIpsRequest
|
|
6066
6167
|
* @returns DescribeSecurityIpsResponse
|
|
@@ -6071,10 +6172,10 @@ export default class Client extends OpenApi {
|
|
|
6071
6172
|
}
|
|
6072
6173
|
|
|
6073
6174
|
/**
|
|
6074
|
-
*
|
|
6175
|
+
* Retrieves the connection information for a MongoDB sharded cluster instance.
|
|
6075
6176
|
*
|
|
6076
6177
|
* @remarks
|
|
6077
|
-
* This
|
|
6178
|
+
* This API is for sharded cluster instances only.
|
|
6078
6179
|
*
|
|
6079
6180
|
* @param request - DescribeShardingNetworkAddressRequest
|
|
6080
6181
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6129,10 +6230,10 @@ export default class Client extends OpenApi {
|
|
|
6129
6230
|
}
|
|
6130
6231
|
|
|
6131
6232
|
/**
|
|
6132
|
-
*
|
|
6233
|
+
* Retrieves the connection information for a MongoDB sharded cluster instance.
|
|
6133
6234
|
*
|
|
6134
6235
|
* @remarks
|
|
6135
|
-
* This
|
|
6236
|
+
* This API is for sharded cluster instances only.
|
|
6136
6237
|
*
|
|
6137
6238
|
* @param request - DescribeShardingNetworkAddressRequest
|
|
6138
6239
|
* @returns DescribeShardingNetworkAddressResponse
|
|
@@ -6143,11 +6244,11 @@ export default class Client extends OpenApi {
|
|
|
6143
6244
|
}
|
|
6144
6245
|
|
|
6145
6246
|
/**
|
|
6146
|
-
* Queries
|
|
6247
|
+
* Queries slow query log entries for a MongoDB instance.
|
|
6147
6248
|
*
|
|
6148
6249
|
* @remarks
|
|
6149
|
-
*
|
|
6150
|
-
*
|
|
6250
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
6251
|
+
* - 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).
|
|
6151
6252
|
*
|
|
6152
6253
|
* @param request - DescribeSlowLogRecordsRequest
|
|
6153
6254
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6234,11 +6335,11 @@ export default class Client extends OpenApi {
|
|
|
6234
6335
|
}
|
|
6235
6336
|
|
|
6236
6337
|
/**
|
|
6237
|
-
* Queries
|
|
6338
|
+
* Queries slow query log entries for a MongoDB instance.
|
|
6238
6339
|
*
|
|
6239
6340
|
* @remarks
|
|
6240
|
-
*
|
|
6241
|
-
*
|
|
6341
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
6342
|
+
* - 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).
|
|
6242
6343
|
*
|
|
6243
6344
|
* @param request - DescribeSlowLogRecordsRequest
|
|
6244
6345
|
* @returns DescribeSlowLogRecordsResponse
|
|
@@ -6319,10 +6420,10 @@ export default class Client extends OpenApi {
|
|
|
6319
6420
|
}
|
|
6320
6421
|
|
|
6321
6422
|
/**
|
|
6322
|
-
* Queries the
|
|
6423
|
+
* Queries the custom keys for an instance.
|
|
6323
6424
|
*
|
|
6324
6425
|
* @remarks
|
|
6325
|
-
* You can use the custom
|
|
6426
|
+
* 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).
|
|
6326
6427
|
*
|
|
6327
6428
|
* @param request - DescribeUserEncryptionKeyListRequest
|
|
6328
6429
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6377,10 +6478,10 @@ export default class Client extends OpenApi {
|
|
|
6377
6478
|
}
|
|
6378
6479
|
|
|
6379
6480
|
/**
|
|
6380
|
-
* Queries the
|
|
6481
|
+
* Queries the custom keys for an instance.
|
|
6381
6482
|
*
|
|
6382
6483
|
* @remarks
|
|
6383
|
-
* You can use the custom
|
|
6484
|
+
* 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).
|
|
6384
6485
|
*
|
|
6385
6486
|
* @param request - DescribeUserEncryptionKeyListRequest
|
|
6386
6487
|
* @returns DescribeUserEncryptionKeyListResponse
|
|
@@ -6391,6 +6492,8 @@ export default class Client extends OpenApi {
|
|
|
6391
6492
|
}
|
|
6392
6493
|
|
|
6393
6494
|
/**
|
|
6495
|
+
* Queries a paginated list of VPCs.
|
|
6496
|
+
*
|
|
6394
6497
|
* @param request - DescribeVpcsForMongoDBRequest
|
|
6395
6498
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
6396
6499
|
* @returns DescribeVpcsForMongoDBResponse
|
|
@@ -6452,6 +6555,8 @@ export default class Client extends OpenApi {
|
|
|
6452
6555
|
}
|
|
6453
6556
|
|
|
6454
6557
|
/**
|
|
6558
|
+
* Queries a paginated list of VPCs.
|
|
6559
|
+
*
|
|
6455
6560
|
* @param request - DescribeVpcsForMongoDBRequest
|
|
6456
6561
|
* @returns DescribeVpcsForMongoDBResponse
|
|
6457
6562
|
*/
|
|
@@ -6547,11 +6652,11 @@ export default class Client extends OpenApi {
|
|
|
6547
6652
|
}
|
|
6548
6653
|
|
|
6549
6654
|
/**
|
|
6550
|
-
*
|
|
6655
|
+
* Evaluate resource availability before purchasing a new instance or changing the configuration of an existing instance.
|
|
6551
6656
|
*
|
|
6552
6657
|
* @remarks
|
|
6553
|
-
*
|
|
6554
|
-
* > You can call this operation
|
|
6658
|
+
* 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.
|
|
6659
|
+
* > You can call this operation up to 200 times per minute. Calls that exceed this limit are subject to traffic throttling.
|
|
6555
6660
|
*
|
|
6556
6661
|
* @param request - EvaluateResourceRequest
|
|
6557
6662
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6634,11 +6739,11 @@ export default class Client extends OpenApi {
|
|
|
6634
6739
|
}
|
|
6635
6740
|
|
|
6636
6741
|
/**
|
|
6637
|
-
*
|
|
6742
|
+
* Evaluate resource availability before purchasing a new instance or changing the configuration of an existing instance.
|
|
6638
6743
|
*
|
|
6639
6744
|
* @remarks
|
|
6640
|
-
*
|
|
6641
|
-
* > You can call this operation
|
|
6745
|
+
* 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.
|
|
6746
|
+
* > You can call this operation up to 200 times per minute. Calls that exceed this limit are subject to traffic throttling.
|
|
6642
6747
|
*
|
|
6643
6748
|
* @param request - EvaluateResourceRequest
|
|
6644
6749
|
* @returns EvaluateResourceResponse
|
|
@@ -6726,11 +6831,11 @@ export default class Client extends OpenApi {
|
|
|
6726
6831
|
* Migrates an ApsaraDB for MongoDB instance to a specific zone.
|
|
6727
6832
|
*
|
|
6728
6833
|
* @remarks
|
|
6729
|
-
*
|
|
6730
|
-
*
|
|
6731
|
-
*
|
|
6732
|
-
*
|
|
6733
|
-
*
|
|
6834
|
+
* - This operation is available only for replica set instances that run MongoDB 4.2 or earlier and sharded cluster instances.
|
|
6835
|
+
* - 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.
|
|
6836
|
+
* - Transparent data encryption (TDE) is disabled for the ApsaraDB for MongoDB instance.
|
|
6837
|
+
* - The source zone and the destination zone belong to the same region.
|
|
6838
|
+
* - 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).
|
|
6734
6839
|
*
|
|
6735
6840
|
* @param request - MigrateAvailableZoneRequest
|
|
6736
6841
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6800,11 +6905,11 @@ export default class Client extends OpenApi {
|
|
|
6800
6905
|
* Migrates an ApsaraDB for MongoDB instance to a specific zone.
|
|
6801
6906
|
*
|
|
6802
6907
|
* @remarks
|
|
6803
|
-
*
|
|
6804
|
-
*
|
|
6805
|
-
*
|
|
6806
|
-
*
|
|
6807
|
-
*
|
|
6908
|
+
* - This operation is available only for replica set instances that run MongoDB 4.2 or earlier and sharded cluster instances.
|
|
6909
|
+
* - 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.
|
|
6910
|
+
* - Transparent data encryption (TDE) is disabled for the ApsaraDB for MongoDB instance.
|
|
6911
|
+
* - The source zone and the destination zone belong to the same region.
|
|
6912
|
+
* - 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).
|
|
6808
6913
|
*
|
|
6809
6914
|
* @param request - MigrateAvailableZoneRequest
|
|
6810
6915
|
* @returns MigrateAvailableZoneResponse
|
|
@@ -6815,11 +6920,11 @@ export default class Client extends OpenApi {
|
|
|
6815
6920
|
}
|
|
6816
6921
|
|
|
6817
6922
|
/**
|
|
6818
|
-
*
|
|
6923
|
+
* Migrates an ApsaraDB for MongoDB instance to another zone.
|
|
6819
6924
|
*
|
|
6820
6925
|
* @remarks
|
|
6821
6926
|
* This operation is applicable only to replica set instances, but not to standalone instances or sharded cluster instances.
|
|
6822
|
-
* >
|
|
6927
|
+
* > 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.
|
|
6823
6928
|
*
|
|
6824
6929
|
* @param request - MigrateToOtherZoneRequest
|
|
6825
6930
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6878,11 +6983,11 @@ export default class Client extends OpenApi {
|
|
|
6878
6983
|
}
|
|
6879
6984
|
|
|
6880
6985
|
/**
|
|
6881
|
-
*
|
|
6986
|
+
* Migrates an ApsaraDB for MongoDB instance to another zone.
|
|
6882
6987
|
*
|
|
6883
6988
|
* @remarks
|
|
6884
6989
|
* This operation is applicable only to replica set instances, but not to standalone instances or sharded cluster instances.
|
|
6885
|
-
* >
|
|
6990
|
+
* > 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.
|
|
6886
6991
|
*
|
|
6887
6992
|
* @param request - MigrateToOtherZoneRequest
|
|
6888
6993
|
* @returns MigrateToOtherZoneResponse
|
|
@@ -6895,6 +7000,9 @@ export default class Client extends OpenApi {
|
|
|
6895
7000
|
/**
|
|
6896
7001
|
* Modifies the description of the root account in an ApsaraDB for MongoDB instance.
|
|
6897
7002
|
*
|
|
7003
|
+
* @remarks
|
|
7004
|
+
* This operation is not supported for sharded cluster instances.
|
|
7005
|
+
*
|
|
6898
7006
|
* @param request - ModifyAccountDescriptionRequest
|
|
6899
7007
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
6900
7008
|
* @returns ModifyAccountDescriptionResponse
|
|
@@ -6954,6 +7062,9 @@ export default class Client extends OpenApi {
|
|
|
6954
7062
|
/**
|
|
6955
7063
|
* Modifies the description of the root account in an ApsaraDB for MongoDB instance.
|
|
6956
7064
|
*
|
|
7065
|
+
* @remarks
|
|
7066
|
+
* This operation is not supported for sharded cluster instances.
|
|
7067
|
+
*
|
|
6957
7068
|
* @param request - ModifyAccountDescriptionRequest
|
|
6958
7069
|
* @returns ModifyAccountDescriptionResponse
|
|
6959
7070
|
*/
|
|
@@ -6963,7 +7074,7 @@ export default class Client extends OpenApi {
|
|
|
6963
7074
|
}
|
|
6964
7075
|
|
|
6965
7076
|
/**
|
|
6966
|
-
* Modifies the O
|
|
7077
|
+
* Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
6967
7078
|
*
|
|
6968
7079
|
* @param request - ModifyActiveOperationMaintenanceConfigRequest
|
|
6969
7080
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7026,7 +7137,7 @@ export default class Client extends OpenApi {
|
|
|
7026
7137
|
}
|
|
7027
7138
|
|
|
7028
7139
|
/**
|
|
7029
|
-
* Modifies the O
|
|
7140
|
+
* Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
7030
7141
|
*
|
|
7031
7142
|
* @param request - ModifyActiveOperationMaintenanceConfigRequest
|
|
7032
7143
|
* @returns ModifyActiveOperationMaintenanceConfigResponse
|
|
@@ -7107,12 +7218,12 @@ export default class Client extends OpenApi {
|
|
|
7107
7218
|
}
|
|
7108
7219
|
|
|
7109
7220
|
/**
|
|
7110
|
-
*
|
|
7221
|
+
* Modifies the audit log types collected for a MongoDB instance.
|
|
7111
7222
|
*
|
|
7112
7223
|
* @remarks
|
|
7113
|
-
*
|
|
7114
|
-
*
|
|
7115
|
-
*
|
|
7224
|
+
* - The instance must be in the running state when you call this operation.
|
|
7225
|
+
* - This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
|
|
7226
|
+
* - 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).
|
|
7116
7227
|
*
|
|
7117
7228
|
* @param request - ModifyAuditLogFilterRequest
|
|
7118
7229
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7167,12 +7278,12 @@ export default class Client extends OpenApi {
|
|
|
7167
7278
|
}
|
|
7168
7279
|
|
|
7169
7280
|
/**
|
|
7170
|
-
*
|
|
7281
|
+
* Modifies the audit log types collected for a MongoDB instance.
|
|
7171
7282
|
*
|
|
7172
7283
|
* @remarks
|
|
7173
|
-
*
|
|
7174
|
-
*
|
|
7175
|
-
*
|
|
7284
|
+
* - The instance must be in the running state when you call this operation.
|
|
7285
|
+
* - This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
|
|
7286
|
+
* - 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).
|
|
7176
7287
|
*
|
|
7177
7288
|
* @param request - ModifyAuditLogFilterRequest
|
|
7178
7289
|
* @returns ModifyAuditLogFilterResponse
|
|
@@ -7183,11 +7294,10 @@ export default class Client extends OpenApi {
|
|
|
7183
7294
|
}
|
|
7184
7295
|
|
|
7185
7296
|
/**
|
|
7186
|
-
* Enables or disables the audit log
|
|
7297
|
+
* Enables or disables the audit log for a MongoDB instance, or modifies the log retention period.
|
|
7187
7298
|
*
|
|
7188
7299
|
* @remarks
|
|
7189
|
-
*
|
|
7190
|
-
* * 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).
|
|
7300
|
+
* - 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).
|
|
7191
7301
|
*
|
|
7192
7302
|
* @param request - ModifyAuditPolicyRequest
|
|
7193
7303
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7254,11 +7364,10 @@ export default class Client extends OpenApi {
|
|
|
7254
7364
|
}
|
|
7255
7365
|
|
|
7256
7366
|
/**
|
|
7257
|
-
* Enables or disables the audit log
|
|
7367
|
+
* Enables or disables the audit log for a MongoDB instance, or modifies the log retention period.
|
|
7258
7368
|
*
|
|
7259
7369
|
* @remarks
|
|
7260
|
-
*
|
|
7261
|
-
* * 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).
|
|
7370
|
+
* - 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).
|
|
7262
7371
|
*
|
|
7263
7372
|
* @param request - ModifyAuditPolicyRequest
|
|
7264
7373
|
* @returns ModifyAuditPolicyResponse
|
|
@@ -7269,7 +7378,11 @@ export default class Client extends OpenApi {
|
|
|
7269
7378
|
}
|
|
7270
7379
|
|
|
7271
7380
|
/**
|
|
7272
|
-
* Modifies the
|
|
7381
|
+
* Modifies the time-to-live (TTL) of a MongoDB backup set.
|
|
7382
|
+
*
|
|
7383
|
+
* @remarks
|
|
7384
|
+
* You can modify the TTL only for manual backups.
|
|
7385
|
+
* This operation is applicable only to MongoDB instances that use cloud disks.
|
|
7273
7386
|
*
|
|
7274
7387
|
* @param request - ModifyBackupExpireTimeRequest
|
|
7275
7388
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7324,7 +7437,11 @@ export default class Client extends OpenApi {
|
|
|
7324
7437
|
}
|
|
7325
7438
|
|
|
7326
7439
|
/**
|
|
7327
|
-
* Modifies the
|
|
7440
|
+
* Modifies the time-to-live (TTL) of a MongoDB backup set.
|
|
7441
|
+
*
|
|
7442
|
+
* @remarks
|
|
7443
|
+
* You can modify the TTL only for manual backups.
|
|
7444
|
+
* This operation is applicable only to MongoDB instances that use cloud disks.
|
|
7328
7445
|
*
|
|
7329
7446
|
* @param request - ModifyBackupExpireTimeRequest
|
|
7330
7447
|
* @returns ModifyBackupExpireTimeResponse
|
|
@@ -7335,10 +7452,10 @@ export default class Client extends OpenApi {
|
|
|
7335
7452
|
}
|
|
7336
7453
|
|
|
7337
7454
|
/**
|
|
7338
|
-
* Modifies
|
|
7455
|
+
* Modifies the backup policy of a MongoDB instance.
|
|
7339
7456
|
*
|
|
7340
7457
|
* @remarks
|
|
7341
|
-
*
|
|
7458
|
+
* Geo-redundancy is available only for replica set instances and sharded cluster instances that use cloud disks.
|
|
7342
7459
|
*
|
|
7343
7460
|
* @param request - ModifyBackupPolicyRequest
|
|
7344
7461
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7465,10 +7582,10 @@ export default class Client extends OpenApi {
|
|
|
7465
7582
|
}
|
|
7466
7583
|
|
|
7467
7584
|
/**
|
|
7468
|
-
* Modifies
|
|
7585
|
+
* Modifies the backup policy of a MongoDB instance.
|
|
7469
7586
|
*
|
|
7470
7587
|
* @remarks
|
|
7471
|
-
*
|
|
7588
|
+
* Geo-redundancy is available only for replica set instances and sharded cluster instances that use cloud disks.
|
|
7472
7589
|
*
|
|
7473
7590
|
* @param request - ModifyBackupPolicyRequest
|
|
7474
7591
|
* @returns ModifyBackupPolicyResponse
|
|
@@ -7479,7 +7596,10 @@ export default class Client extends OpenApi {
|
|
|
7479
7596
|
}
|
|
7480
7597
|
|
|
7481
7598
|
/**
|
|
7482
|
-
* Modifies
|
|
7599
|
+
* Modifies instance release protection configuration.
|
|
7600
|
+
*
|
|
7601
|
+
* @remarks
|
|
7602
|
+
* This operation is applicable only to pay-as-you-go instances.
|
|
7483
7603
|
*
|
|
7484
7604
|
* @param request - ModifyDBInstanceAttributeRequest
|
|
7485
7605
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7530,7 +7650,10 @@ export default class Client extends OpenApi {
|
|
|
7530
7650
|
}
|
|
7531
7651
|
|
|
7532
7652
|
/**
|
|
7533
|
-
* Modifies
|
|
7653
|
+
* Modifies instance release protection configuration.
|
|
7654
|
+
*
|
|
7655
|
+
* @remarks
|
|
7656
|
+
* This operation is applicable only to pay-as-you-go instances.
|
|
7534
7657
|
*
|
|
7535
7658
|
* @param request - ModifyDBInstanceAttributeRequest
|
|
7536
7659
|
* @returns ModifyDBInstanceAttributeResponse
|
|
@@ -7541,7 +7664,7 @@ export default class Client extends OpenApi {
|
|
|
7541
7664
|
}
|
|
7542
7665
|
|
|
7543
7666
|
/**
|
|
7544
|
-
* Modifies
|
|
7667
|
+
* Modifies instance configuration
|
|
7545
7668
|
*
|
|
7546
7669
|
* @param request - ModifyDBInstanceConfigRequest
|
|
7547
7670
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7596,7 +7719,7 @@ export default class Client extends OpenApi {
|
|
|
7596
7719
|
}
|
|
7597
7720
|
|
|
7598
7721
|
/**
|
|
7599
|
-
* Modifies
|
|
7722
|
+
* Modifies instance configuration
|
|
7600
7723
|
*
|
|
7601
7724
|
* @param request - ModifyDBInstanceConfigRequest
|
|
7602
7725
|
* @returns ModifyDBInstanceConfigResponse
|
|
@@ -7607,12 +7730,12 @@ export default class Client extends OpenApi {
|
|
|
7607
7730
|
}
|
|
7608
7731
|
|
|
7609
7732
|
/**
|
|
7610
|
-
* Modifies the
|
|
7733
|
+
* Modifies the connection address and port of a MongoDB instance.
|
|
7611
7734
|
*
|
|
7612
7735
|
* @remarks
|
|
7613
|
-
* You can modify the connection
|
|
7614
|
-
*
|
|
7615
|
-
*
|
|
7736
|
+
* You can modify the connection address and port for the following instance types:
|
|
7737
|
+
* - You can modify the connection address and port for instances that use local disks or cloud disks.
|
|
7738
|
+
* - For sharded cluster instances, you can modify only the connection address of Mongos nodes.
|
|
7616
7739
|
*
|
|
7617
7740
|
* @param request - ModifyDBInstanceConnectionStringRequest
|
|
7618
7741
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7687,12 +7810,12 @@ export default class Client extends OpenApi {
|
|
|
7687
7810
|
}
|
|
7688
7811
|
|
|
7689
7812
|
/**
|
|
7690
|
-
* Modifies the
|
|
7813
|
+
* Modifies the connection address and port of a MongoDB instance.
|
|
7691
7814
|
*
|
|
7692
7815
|
* @remarks
|
|
7693
|
-
* You can modify the connection
|
|
7694
|
-
*
|
|
7695
|
-
*
|
|
7816
|
+
* You can modify the connection address and port for the following instance types:
|
|
7817
|
+
* - You can modify the connection address and port for instances that use local disks or cloud disks.
|
|
7818
|
+
* - For sharded cluster instances, you can modify only the connection address of Mongos nodes.
|
|
7696
7819
|
*
|
|
7697
7820
|
* @param request - ModifyDBInstanceConnectionStringRequest
|
|
7698
7821
|
* @returns ModifyDBInstanceConnectionStringResponse
|
|
@@ -7771,6 +7894,11 @@ export default class Client extends OpenApi {
|
|
|
7771
7894
|
/**
|
|
7772
7895
|
* Modifies the disk type of an ApsaraDB for MongoDB instance.
|
|
7773
7896
|
*
|
|
7897
|
+
* @remarks
|
|
7898
|
+
* - This feature is not supported for instances with less than 40 GB of disk space.
|
|
7899
|
+
* - You can change the disk type only to an ESSD AutoPL disk (cloud_auto).
|
|
7900
|
+
* - 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).
|
|
7901
|
+
*
|
|
7774
7902
|
* @param request - ModifyDBInstanceDiskTypeRequest
|
|
7775
7903
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
7776
7904
|
* @returns ModifyDBInstanceDiskTypeResponse
|
|
@@ -7838,6 +7966,11 @@ export default class Client extends OpenApi {
|
|
|
7838
7966
|
/**
|
|
7839
7967
|
* Modifies the disk type of an ApsaraDB for MongoDB instance.
|
|
7840
7968
|
*
|
|
7969
|
+
* @remarks
|
|
7970
|
+
* - This feature is not supported for instances with less than 40 GB of disk space.
|
|
7971
|
+
* - You can change the disk type only to an ESSD AutoPL disk (cloud_auto).
|
|
7972
|
+
* - 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).
|
|
7973
|
+
*
|
|
7841
7974
|
* @param request - ModifyDBInstanceDiskTypeRequest
|
|
7842
7975
|
* @returns ModifyDBInstanceDiskTypeResponse
|
|
7843
7976
|
*/
|
|
@@ -7913,13 +8046,13 @@ export default class Client extends OpenApi {
|
|
|
7913
8046
|
}
|
|
7914
8047
|
|
|
7915
8048
|
/**
|
|
7916
|
-
*
|
|
8049
|
+
* Set the monitoring collection granularity for a MongoDB instance.
|
|
7917
8050
|
*
|
|
7918
8051
|
* @remarks
|
|
7919
|
-
* >
|
|
7920
|
-
*
|
|
7921
|
-
*
|
|
7922
|
-
*
|
|
8052
|
+
* > Due to changes in the monitoring collection granularity adjustment feature, this operation is only applicable to the previous version of the MongoDB console.
|
|
8053
|
+
* To use this operation, the instance must meet the following requirements:
|
|
8054
|
+
* - A replica set or sharded cluster instance is used.
|
|
8055
|
+
* - MongoDB 3.4 (the latest minor version) or MongoDB 4.0 is selected.
|
|
7923
8056
|
*
|
|
7924
8057
|
* @param request - ModifyDBInstanceMonitorRequest
|
|
7925
8058
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7970,13 +8103,13 @@ export default class Client extends OpenApi {
|
|
|
7970
8103
|
}
|
|
7971
8104
|
|
|
7972
8105
|
/**
|
|
7973
|
-
*
|
|
8106
|
+
* Set the monitoring collection granularity for a MongoDB instance.
|
|
7974
8107
|
*
|
|
7975
8108
|
* @remarks
|
|
7976
|
-
* >
|
|
7977
|
-
*
|
|
7978
|
-
*
|
|
7979
|
-
*
|
|
8109
|
+
* > Due to changes in the monitoring collection granularity adjustment feature, this operation is only applicable to the previous version of the MongoDB console.
|
|
8110
|
+
* To use this operation, the instance must meet the following requirements:
|
|
8111
|
+
* - A replica set or sharded cluster instance is used.
|
|
8112
|
+
* - MongoDB 3.4 (the latest minor version) or MongoDB 4.0 is selected.
|
|
7980
8113
|
*
|
|
7981
8114
|
* @param request - ModifyDBInstanceMonitorRequest
|
|
7982
8115
|
* @returns ModifyDBInstanceMonitorResponse
|
|
@@ -7991,9 +8124,9 @@ export default class Client extends OpenApi {
|
|
|
7991
8124
|
*
|
|
7992
8125
|
* @remarks
|
|
7993
8126
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
7994
|
-
*
|
|
7995
|
-
*
|
|
7996
|
-
* >
|
|
8127
|
+
* - The instance is in the Running state.
|
|
8128
|
+
* - The network of the instance is in hybrid access mode.
|
|
8129
|
+
* > This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
|
|
7997
8130
|
*
|
|
7998
8131
|
* @param request - ModifyDBInstanceNetExpireTimeRequest
|
|
7999
8132
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8052,9 +8185,9 @@ export default class Client extends OpenApi {
|
|
|
8052
8185
|
*
|
|
8053
8186
|
* @remarks
|
|
8054
8187
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
8055
|
-
*
|
|
8056
|
-
*
|
|
8057
|
-
* >
|
|
8188
|
+
* - The instance is in the Running state.
|
|
8189
|
+
* - The network of the instance is in hybrid access mode.
|
|
8190
|
+
* > This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
|
|
8058
8191
|
*
|
|
8059
8192
|
* @param request - ModifyDBInstanceNetExpireTimeRequest
|
|
8060
8193
|
* @returns ModifyDBInstanceNetExpireTimeResponse
|
|
@@ -8065,10 +8198,11 @@ export default class Client extends OpenApi {
|
|
|
8065
8198
|
}
|
|
8066
8199
|
|
|
8067
8200
|
/**
|
|
8068
|
-
*
|
|
8201
|
+
* Switches the network type of a MongoDB instance.
|
|
8069
8202
|
*
|
|
8070
8203
|
* @remarks
|
|
8071
|
-
* This operation
|
|
8204
|
+
* - 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.
|
|
8205
|
+
* - This operation supports only instances that run MongoDB 4.2 or earlier and use local disks.
|
|
8072
8206
|
*
|
|
8073
8207
|
* @param request - ModifyDBInstanceNetworkTypeRequest
|
|
8074
8208
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8139,10 +8273,11 @@ export default class Client extends OpenApi {
|
|
|
8139
8273
|
}
|
|
8140
8274
|
|
|
8141
8275
|
/**
|
|
8142
|
-
*
|
|
8276
|
+
* Switches the network type of a MongoDB instance.
|
|
8143
8277
|
*
|
|
8144
8278
|
* @remarks
|
|
8145
|
-
* This operation
|
|
8279
|
+
* - 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.
|
|
8280
|
+
* - This operation supports only instances that run MongoDB 4.2 or earlier and use local disks.
|
|
8146
8281
|
*
|
|
8147
8282
|
* @param request - ModifyDBInstanceNetworkTypeRequest
|
|
8148
8283
|
* @returns ModifyDBInstanceNetworkTypeResponse
|
|
@@ -8153,15 +8288,15 @@ export default class Client extends OpenApi {
|
|
|
8153
8288
|
}
|
|
8154
8289
|
|
|
8155
8290
|
/**
|
|
8156
|
-
* Modifies the SSL
|
|
8291
|
+
* Modifies the SSL configuration of a MongoDB instance.
|
|
8157
8292
|
*
|
|
8158
8293
|
* @remarks
|
|
8159
|
-
*
|
|
8160
|
-
*
|
|
8161
|
-
*
|
|
8162
|
-
*
|
|
8163
|
-
*
|
|
8164
|
-
* >
|
|
8294
|
+
* Before you call the ModifyDBInstanceSSL operation, make sure that the instance meets the following requirements:
|
|
8295
|
+
* - The instance is in the running state.
|
|
8296
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
8297
|
+
* - The replica set instance is version 3.4 or later.
|
|
8298
|
+
* - The sharded cluster instance uses enhanced solid-state drives (ESSDs).
|
|
8299
|
+
* > Enabling, updating, or disabling SSL restarts the instance. We recommend that you perform these operations during off-peak hours.
|
|
8165
8300
|
*
|
|
8166
8301
|
* @param request - ModifyDBInstanceSSLRequest
|
|
8167
8302
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8220,15 +8355,15 @@ export default class Client extends OpenApi {
|
|
|
8220
8355
|
}
|
|
8221
8356
|
|
|
8222
8357
|
/**
|
|
8223
|
-
* Modifies the SSL
|
|
8358
|
+
* Modifies the SSL configuration of a MongoDB instance.
|
|
8224
8359
|
*
|
|
8225
8360
|
* @remarks
|
|
8226
|
-
*
|
|
8227
|
-
*
|
|
8228
|
-
*
|
|
8229
|
-
*
|
|
8230
|
-
*
|
|
8231
|
-
* >
|
|
8361
|
+
* Before you call the ModifyDBInstanceSSL operation, make sure that the instance meets the following requirements:
|
|
8362
|
+
* - The instance is in the running state.
|
|
8363
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
8364
|
+
* - The replica set instance is version 3.4 or later.
|
|
8365
|
+
* - The sharded cluster instance uses enhanced solid-state drives (ESSDs).
|
|
8366
|
+
* > Enabling, updating, or disabling SSL restarts the instance. We recommend that you perform these operations during off-peak hours.
|
|
8232
8367
|
*
|
|
8233
8368
|
* @param request - ModifyDBInstanceSSLRequest
|
|
8234
8369
|
* @returns ModifyDBInstanceSSLResponse
|
|
@@ -8239,11 +8374,11 @@ export default class Client extends OpenApi {
|
|
|
8239
8374
|
}
|
|
8240
8375
|
|
|
8241
8376
|
/**
|
|
8242
|
-
*
|
|
8377
|
+
* 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.
|
|
8243
8378
|
*
|
|
8244
8379
|
* @remarks
|
|
8245
|
-
* Before
|
|
8246
|
-
* This operation applies only to standalone and replica set instances. To
|
|
8380
|
+
* 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.
|
|
8381
|
+
* 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.
|
|
8247
8382
|
*
|
|
8248
8383
|
* @param request - ModifyDBInstanceSpecRequest
|
|
8249
8384
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8358,11 +8493,11 @@ export default class Client extends OpenApi {
|
|
|
8358
8493
|
}
|
|
8359
8494
|
|
|
8360
8495
|
/**
|
|
8361
|
-
*
|
|
8496
|
+
* 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.
|
|
8362
8497
|
*
|
|
8363
8498
|
* @remarks
|
|
8364
|
-
* Before
|
|
8365
|
-
* This operation applies only to standalone and replica set instances. To
|
|
8499
|
+
* 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.
|
|
8500
|
+
* 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.
|
|
8366
8501
|
*
|
|
8367
8502
|
* @param request - ModifyDBInstanceSpecRequest
|
|
8368
8503
|
* @returns ModifyDBInstanceSpecResponse
|
|
@@ -8373,16 +8508,16 @@ export default class Client extends OpenApi {
|
|
|
8373
8508
|
}
|
|
8374
8509
|
|
|
8375
8510
|
/**
|
|
8376
|
-
* Modifies the
|
|
8511
|
+
* Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance.
|
|
8377
8512
|
*
|
|
8378
8513
|
* @remarks
|
|
8379
|
-
*
|
|
8380
|
-
* >
|
|
8381
|
-
* Before you call this operation, make sure that the
|
|
8382
|
-
*
|
|
8383
|
-
*
|
|
8384
|
-
*
|
|
8385
|
-
*
|
|
8514
|
+
* 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).
|
|
8515
|
+
* > You cannot disable TDE after it is enabled.
|
|
8516
|
+
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
8517
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
8518
|
+
* - The instance uses the WiredTiger storage engine.
|
|
8519
|
+
* - The instance uses local disks.
|
|
8520
|
+
* - 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.
|
|
8386
8521
|
*
|
|
8387
8522
|
* @param request - ModifyDBInstanceTDERequest
|
|
8388
8523
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8449,16 +8584,16 @@ export default class Client extends OpenApi {
|
|
|
8449
8584
|
}
|
|
8450
8585
|
|
|
8451
8586
|
/**
|
|
8452
|
-
* Modifies the
|
|
8587
|
+
* Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance.
|
|
8453
8588
|
*
|
|
8454
8589
|
* @remarks
|
|
8455
|
-
*
|
|
8456
|
-
* >
|
|
8457
|
-
* Before you call this operation, make sure that the
|
|
8458
|
-
*
|
|
8459
|
-
*
|
|
8460
|
-
*
|
|
8461
|
-
*
|
|
8590
|
+
* 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).
|
|
8591
|
+
* > You cannot disable TDE after it is enabled.
|
|
8592
|
+
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
8593
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
8594
|
+
* - The instance uses the WiredTiger storage engine.
|
|
8595
|
+
* - The instance uses local disks.
|
|
8596
|
+
* - 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.
|
|
8462
8597
|
*
|
|
8463
8598
|
* @param request - ModifyDBInstanceTDERequest
|
|
8464
8599
|
* @returns ModifyDBInstanceTDEResponse
|
|
@@ -8755,10 +8890,10 @@ export default class Client extends OpenApi {
|
|
|
8755
8890
|
*
|
|
8756
8891
|
* @remarks
|
|
8757
8892
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8758
|
-
*
|
|
8759
|
-
*
|
|
8760
|
-
*
|
|
8761
|
-
*
|
|
8893
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
8894
|
+
* - 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.
|
|
8895
|
+
* - 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.
|
|
8896
|
+
* - You can only disable but not enable password-free access over VPC.
|
|
8762
8897
|
*
|
|
8763
8898
|
* @param request - ModifyInstanceVpcAuthModeRequest
|
|
8764
8899
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8817,10 +8952,10 @@ export default class Client extends OpenApi {
|
|
|
8817
8952
|
*
|
|
8818
8953
|
* @remarks
|
|
8819
8954
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8820
|
-
*
|
|
8821
|
-
*
|
|
8822
|
-
*
|
|
8823
|
-
*
|
|
8955
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
8956
|
+
* - 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.
|
|
8957
|
+
* - 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.
|
|
8958
|
+
* - You can only disable but not enable password-free access over VPC.
|
|
8824
8959
|
*
|
|
8825
8960
|
* @param request - ModifyInstanceVpcAuthModeRequest
|
|
8826
8961
|
* @returns ModifyInstanceVpcAuthModeResponse
|
|
@@ -8831,10 +8966,10 @@ export default class Client extends OpenApi {
|
|
|
8831
8966
|
}
|
|
8832
8967
|
|
|
8833
8968
|
/**
|
|
8834
|
-
* Changes the
|
|
8969
|
+
* Changes the instance type and storage space of a node in a MongoDB sharded cluster instance.
|
|
8835
8970
|
*
|
|
8836
8971
|
* @remarks
|
|
8837
|
-
* 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
|
|
8972
|
+
* 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.
|
|
8838
8973
|
* > This operation is applicable only to sharded cluster instances.
|
|
8839
8974
|
*
|
|
8840
8975
|
* @param request - ModifyNodeSpecRequest
|
|
@@ -8946,10 +9081,10 @@ export default class Client extends OpenApi {
|
|
|
8946
9081
|
}
|
|
8947
9082
|
|
|
8948
9083
|
/**
|
|
8949
|
-
* Changes the
|
|
9084
|
+
* Changes the instance type and storage space of a node in a MongoDB sharded cluster instance.
|
|
8950
9085
|
*
|
|
8951
9086
|
* @remarks
|
|
8952
|
-
* 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
|
|
9087
|
+
* 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.
|
|
8953
9088
|
* > This operation is applicable only to sharded cluster instances.
|
|
8954
9089
|
*
|
|
8955
9090
|
* @param request - ModifyNodeSpecRequest
|
|
@@ -8961,12 +9096,12 @@ export default class Client extends OpenApi {
|
|
|
8961
9096
|
}
|
|
8962
9097
|
|
|
8963
9098
|
/**
|
|
8964
|
-
* Changes the
|
|
9099
|
+
* Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.
|
|
8965
9100
|
*
|
|
8966
9101
|
* @remarks
|
|
8967
|
-
*
|
|
8968
|
-
* This operation
|
|
8969
|
-
* When you upgrade or downgrade
|
|
9102
|
+
* 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.
|
|
9103
|
+
* This operation applies only to ApsaraDB for MongoDB sharded cluster instances.
|
|
9104
|
+
* 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.
|
|
8970
9105
|
*
|
|
8971
9106
|
* @param request - ModifyNodeSpecBatchRequest
|
|
8972
9107
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9061,12 +9196,12 @@ export default class Client extends OpenApi {
|
|
|
9061
9196
|
}
|
|
9062
9197
|
|
|
9063
9198
|
/**
|
|
9064
|
-
* Changes the
|
|
9199
|
+
* Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.
|
|
9065
9200
|
*
|
|
9066
9201
|
* @remarks
|
|
9067
|
-
*
|
|
9068
|
-
* This operation
|
|
9069
|
-
* When you upgrade or downgrade
|
|
9202
|
+
* 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.
|
|
9203
|
+
* This operation applies only to ApsaraDB for MongoDB sharded cluster instances.
|
|
9204
|
+
* 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.
|
|
9070
9205
|
*
|
|
9071
9206
|
* @param request - ModifyNodeSpecBatchRequest
|
|
9072
9207
|
* @returns ModifyNodeSpecBatchResponse
|
|
@@ -9080,8 +9215,8 @@ export default class Client extends OpenApi {
|
|
|
9080
9215
|
* Modifies the parameters of an ApsaraDB for MongoDB instance.
|
|
9081
9216
|
*
|
|
9082
9217
|
* @remarks
|
|
9083
|
-
*
|
|
9084
|
-
*
|
|
9218
|
+
* - When you call this operation, the instance status must be running.
|
|
9219
|
+
* - 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.
|
|
9085
9220
|
*
|
|
9086
9221
|
* @param request - ModifyParametersRequest
|
|
9087
9222
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9151,8 +9286,8 @@ export default class Client extends OpenApi {
|
|
|
9151
9286
|
* Modifies the parameters of an ApsaraDB for MongoDB instance.
|
|
9152
9287
|
*
|
|
9153
9288
|
* @remarks
|
|
9154
|
-
*
|
|
9155
|
-
*
|
|
9289
|
+
* - When you call this operation, the instance status must be running.
|
|
9290
|
+
* - 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.
|
|
9156
9291
|
*
|
|
9157
9292
|
* @param request - ModifyParametersRequest
|
|
9158
9293
|
* @returns ModifyParametersResponse
|
|
@@ -9235,10 +9370,10 @@ export default class Client extends OpenApi {
|
|
|
9235
9370
|
}
|
|
9236
9371
|
|
|
9237
9372
|
/**
|
|
9238
|
-
*
|
|
9373
|
+
* Modifies the ECS security group bound to an ApsaraDB for MongoDB instance.
|
|
9239
9374
|
*
|
|
9240
9375
|
* @remarks
|
|
9241
|
-
* >
|
|
9376
|
+
* > For a sharded cluster instance, the bound ECS security group takes effect only for mongos nodes.
|
|
9242
9377
|
*
|
|
9243
9378
|
* @param request - ModifySecurityGroupConfigurationRequest
|
|
9244
9379
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9289,10 +9424,10 @@ export default class Client extends OpenApi {
|
|
|
9289
9424
|
}
|
|
9290
9425
|
|
|
9291
9426
|
/**
|
|
9292
|
-
*
|
|
9427
|
+
* Modifies the ECS security group bound to an ApsaraDB for MongoDB instance.
|
|
9293
9428
|
*
|
|
9294
9429
|
* @remarks
|
|
9295
|
-
* >
|
|
9430
|
+
* > For a sharded cluster instance, the bound ECS security group takes effect only for mongos nodes.
|
|
9296
9431
|
*
|
|
9297
9432
|
* @param request - ModifySecurityGroupConfigurationRequest
|
|
9298
9433
|
* @returns ModifySecurityGroupConfigurationResponse
|
|
@@ -9377,7 +9512,10 @@ export default class Client extends OpenApi {
|
|
|
9377
9512
|
}
|
|
9378
9513
|
|
|
9379
9514
|
/**
|
|
9380
|
-
* Modifies the SRV connection
|
|
9515
|
+
* Modifies the SRV connection address of a MongoDB instance.
|
|
9516
|
+
*
|
|
9517
|
+
* @remarks
|
|
9518
|
+
* This operation applies only to replica set instances and sharded cluster instances that use disks.
|
|
9381
9519
|
*
|
|
9382
9520
|
* @param request - ModifySrvNetworkAddressRequest
|
|
9383
9521
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9432,7 +9570,10 @@ export default class Client extends OpenApi {
|
|
|
9432
9570
|
}
|
|
9433
9571
|
|
|
9434
9572
|
/**
|
|
9435
|
-
* Modifies the SRV connection
|
|
9573
|
+
* Modifies the SRV connection address of a MongoDB instance.
|
|
9574
|
+
*
|
|
9575
|
+
* @remarks
|
|
9576
|
+
* This operation applies only to replica set instances and sharded cluster instances that use disks.
|
|
9436
9577
|
*
|
|
9437
9578
|
* @param request - ModifySrvNetworkAddressRequest
|
|
9438
9579
|
* @returns ModifySrvNetworkAddressResponse
|
|
@@ -9515,11 +9656,11 @@ export default class Client extends OpenApi {
|
|
|
9515
9656
|
}
|
|
9516
9657
|
|
|
9517
9658
|
/**
|
|
9518
|
-
* Releases the internal endpoint of a shard or Configserver node
|
|
9659
|
+
* Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance.
|
|
9519
9660
|
*
|
|
9520
9661
|
* @remarks
|
|
9521
|
-
*
|
|
9522
|
-
*
|
|
9662
|
+
* - 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).
|
|
9663
|
+
* - 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.
|
|
9523
9664
|
*
|
|
9524
9665
|
* @param request - ReleaseNodePrivateNetworkAddressRequest
|
|
9525
9666
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9578,11 +9719,11 @@ export default class Client extends OpenApi {
|
|
|
9578
9719
|
}
|
|
9579
9720
|
|
|
9580
9721
|
/**
|
|
9581
|
-
* Releases the internal endpoint of a shard or Configserver node
|
|
9722
|
+
* Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance.
|
|
9582
9723
|
*
|
|
9583
9724
|
* @remarks
|
|
9584
|
-
*
|
|
9585
|
-
*
|
|
9725
|
+
* - 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).
|
|
9726
|
+
* - 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.
|
|
9586
9727
|
*
|
|
9587
9728
|
* @param request - ReleaseNodePrivateNetworkAddressRequest
|
|
9588
9729
|
* @returns ReleaseNodePrivateNetworkAddressResponse
|
|
@@ -9751,9 +9892,6 @@ export default class Client extends OpenApi {
|
|
|
9751
9892
|
/**
|
|
9752
9893
|
* Resets the password of the root account in an ApsaraDB for MongoDB instance.
|
|
9753
9894
|
*
|
|
9754
|
-
* @remarks
|
|
9755
|
-
* > This operation can be used to reset only the password of the root account of an instance.
|
|
9756
|
-
*
|
|
9757
9895
|
* @param request - ResetAccountPasswordRequest
|
|
9758
9896
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
9759
9897
|
* @returns ResetAccountPasswordResponse
|
|
@@ -9813,9 +9951,6 @@ export default class Client extends OpenApi {
|
|
|
9813
9951
|
/**
|
|
9814
9952
|
* Resets the password of the root account in an ApsaraDB for MongoDB instance.
|
|
9815
9953
|
*
|
|
9816
|
-
* @remarks
|
|
9817
|
-
* > This operation can be used to reset only the password of the root account of an instance.
|
|
9818
|
-
*
|
|
9819
9954
|
* @param request - ResetAccountPasswordRequest
|
|
9820
9955
|
* @returns ResetAccountPasswordResponse
|
|
9821
9956
|
*/
|
|
@@ -9828,7 +9963,7 @@ export default class Client extends OpenApi {
|
|
|
9828
9963
|
* Restarts an ApsaraDB for MongoDB instance.
|
|
9829
9964
|
*
|
|
9830
9965
|
* @remarks
|
|
9831
|
-
*
|
|
9966
|
+
* You can call this operation to restart an instance. You can also restart a shard or Mongos node in a sharded cluster instance.
|
|
9832
9967
|
*
|
|
9833
9968
|
* @param request - RestartDBInstanceRequest
|
|
9834
9969
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9845,6 +9980,10 @@ export default class Client extends OpenApi {
|
|
|
9845
9980
|
query["NodeId"] = request.nodeId;
|
|
9846
9981
|
}
|
|
9847
9982
|
|
|
9983
|
+
if (!$dara.isNull(request.nodeType)) {
|
|
9984
|
+
query["NodeType"] = request.nodeType;
|
|
9985
|
+
}
|
|
9986
|
+
|
|
9848
9987
|
if (!$dara.isNull(request.ownerAccount)) {
|
|
9849
9988
|
query["OwnerAccount"] = request.ownerAccount;
|
|
9850
9989
|
}
|
|
@@ -9886,7 +10025,7 @@ export default class Client extends OpenApi {
|
|
|
9886
10025
|
* Restarts an ApsaraDB for MongoDB instance.
|
|
9887
10026
|
*
|
|
9888
10027
|
* @remarks
|
|
9889
|
-
*
|
|
10028
|
+
* You can call this operation to restart an instance. You can also restart a shard or Mongos node in a sharded cluster instance.
|
|
9890
10029
|
*
|
|
9891
10030
|
* @param request - RestartDBInstanceRequest
|
|
9892
10031
|
* @returns RestartDBInstanceResponse
|
|
@@ -9897,13 +10036,12 @@ export default class Client extends OpenApi {
|
|
|
9897
10036
|
}
|
|
9898
10037
|
|
|
9899
10038
|
/**
|
|
9900
|
-
* Restarts a node
|
|
10039
|
+
* Restarts a single node of a MongoDB instance.
|
|
9901
10040
|
*
|
|
9902
10041
|
* @remarks
|
|
9903
|
-
*
|
|
9904
|
-
*
|
|
9905
|
-
*
|
|
9906
|
-
* * The instance is a replica set or sharded cluster instance of the standard edition.
|
|
10042
|
+
* Limitations:
|
|
10043
|
+
* - The instance must be in the Running state.
|
|
10044
|
+
* - The instance must be a standard replica set instance or a sharded cluster instance.
|
|
9907
10045
|
*
|
|
9908
10046
|
* @param request - RestartNodeRequest
|
|
9909
10047
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9962,13 +10100,12 @@ export default class Client extends OpenApi {
|
|
|
9962
10100
|
}
|
|
9963
10101
|
|
|
9964
10102
|
/**
|
|
9965
|
-
* Restarts a node
|
|
10103
|
+
* Restarts a single node of a MongoDB instance.
|
|
9966
10104
|
*
|
|
9967
10105
|
* @remarks
|
|
9968
|
-
*
|
|
9969
|
-
*
|
|
9970
|
-
*
|
|
9971
|
-
* * The instance is a replica set or sharded cluster instance of the standard edition.
|
|
10106
|
+
* Limitations:
|
|
10107
|
+
* - The instance must be in the Running state.
|
|
10108
|
+
* - The instance must be a standard replica set instance or a sharded cluster instance.
|
|
9972
10109
|
*
|
|
9973
10110
|
* @param request - RestartNodeRequest
|
|
9974
10111
|
* @returns RestartNodeResponse
|
|
@@ -9983,9 +10120,9 @@ export default class Client extends OpenApi {
|
|
|
9983
10120
|
*
|
|
9984
10121
|
* @remarks
|
|
9985
10122
|
* The instance must be running when you call this operation.
|
|
9986
|
-
* >
|
|
9987
|
-
*
|
|
9988
|
-
*
|
|
10123
|
+
* >
|
|
10124
|
+
* - This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.
|
|
10125
|
+
* - On replica set instances, the switch is performed between instances. On sharded cluster instances, the switch is performed between shards.
|
|
9989
10126
|
*
|
|
9990
10127
|
* @param request - SwitchDBInstanceHARequest
|
|
9991
10128
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10048,9 +10185,9 @@ export default class Client extends OpenApi {
|
|
|
10048
10185
|
*
|
|
10049
10186
|
* @remarks
|
|
10050
10187
|
* The instance must be running when you call this operation.
|
|
10051
|
-
* >
|
|
10052
|
-
*
|
|
10053
|
-
*
|
|
10188
|
+
* >
|
|
10189
|
+
* - This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.
|
|
10190
|
+
* - On replica set instances, the switch is performed between instances. On sharded cluster instances, the switch is performed between shards.
|
|
10054
10191
|
*
|
|
10055
10192
|
* @param request - SwitchDBInstanceHARequest
|
|
10056
10193
|
* @returns SwitchDBInstanceHAResponse
|
|
@@ -10065,11 +10202,11 @@ export default class Client extends OpenApi {
|
|
|
10065
10202
|
*
|
|
10066
10203
|
* @remarks
|
|
10067
10204
|
* 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.
|
|
10068
|
-
*
|
|
10069
|
-
*
|
|
10070
|
-
*
|
|
10071
|
-
*
|
|
10072
|
-
*
|
|
10205
|
+
* - 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.
|
|
10206
|
+
* - If the tag that you specify does not exist, this tag is automatically created and bound to the specified instance.
|
|
10207
|
+
* - If a tag that has the same key is already bound to the instance, the new tag overwrites the existing tag.
|
|
10208
|
+
* - You can bind up to 20 tags to each instance.
|
|
10209
|
+
* - You can bind tags to up to 50 instances each time you call the operation.
|
|
10073
10210
|
*
|
|
10074
10211
|
* @param request - TagResourcesRequest
|
|
10075
10212
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10136,11 +10273,11 @@ export default class Client extends OpenApi {
|
|
|
10136
10273
|
*
|
|
10137
10274
|
* @remarks
|
|
10138
10275
|
* 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.
|
|
10139
|
-
*
|
|
10140
|
-
*
|
|
10141
|
-
*
|
|
10142
|
-
*
|
|
10143
|
-
*
|
|
10276
|
+
* - 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.
|
|
10277
|
+
* - If the tag that you specify does not exist, this tag is automatically created and bound to the specified instance.
|
|
10278
|
+
* - If a tag that has the same key is already bound to the instance, the new tag overwrites the existing tag.
|
|
10279
|
+
* - You can bind up to 20 tags to each instance.
|
|
10280
|
+
* - You can bind tags to up to 50 instances each time you call the operation.
|
|
10144
10281
|
*
|
|
10145
10282
|
* @param request - TagResourcesRequest
|
|
10146
10283
|
* @returns TagResourcesResponse
|
|
@@ -10154,8 +10291,8 @@ export default class Client extends OpenApi {
|
|
|
10154
10291
|
* 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.
|
|
10155
10292
|
*
|
|
10156
10293
|
* @remarks
|
|
10157
|
-
*
|
|
10158
|
-
*
|
|
10294
|
+
* - 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.
|
|
10295
|
+
* - 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.
|
|
10159
10296
|
*
|
|
10160
10297
|
* @param request - TransferClusterBackupRequest
|
|
10161
10298
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10205,8 +10342,8 @@ export default class Client extends OpenApi {
|
|
|
10205
10342
|
* 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.
|
|
10206
10343
|
*
|
|
10207
10344
|
* @remarks
|
|
10208
|
-
*
|
|
10209
|
-
*
|
|
10345
|
+
* - 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.
|
|
10346
|
+
* - 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.
|
|
10210
10347
|
*
|
|
10211
10348
|
* @param request - TransferClusterBackupRequest
|
|
10212
10349
|
* @returns TransferClusterBackupResponse
|
|
@@ -10222,9 +10359,9 @@ export default class Client extends OpenApi {
|
|
|
10222
10359
|
* @remarks
|
|
10223
10360
|
* 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
|
|
10224
10361
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
10225
|
-
*
|
|
10226
|
-
*
|
|
10227
|
-
*
|
|
10362
|
+
* - The instance is in the Running state.
|
|
10363
|
+
* - Your instance has no unpaid billing method change orders.
|
|
10364
|
+
* - 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).
|
|
10228
10365
|
* > 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.
|
|
10229
10366
|
*
|
|
10230
10367
|
* @param request - TransformInstanceChargeTypeRequest
|
|
@@ -10305,9 +10442,9 @@ export default class Client extends OpenApi {
|
|
|
10305
10442
|
* @remarks
|
|
10306
10443
|
* 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
|
|
10307
10444
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
10308
|
-
*
|
|
10309
|
-
*
|
|
10310
|
-
*
|
|
10445
|
+
* - The instance is in the Running state.
|
|
10446
|
+
* - Your instance has no unpaid billing method change orders.
|
|
10447
|
+
* - 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).
|
|
10311
10448
|
* > 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.
|
|
10312
10449
|
*
|
|
10313
10450
|
* @param request - TransformInstanceChargeTypeRequest
|
|
@@ -10325,11 +10462,11 @@ export default class Client extends OpenApi {
|
|
|
10325
10462
|
* 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).
|
|
10326
10463
|
* A subscription instance cannot be changed to a pay-as-you-go instance. To avoid wasting resources, proceed with caution.
|
|
10327
10464
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
10328
|
-
*
|
|
10329
|
-
*
|
|
10330
|
-
*
|
|
10331
|
-
*
|
|
10332
|
-
* >
|
|
10465
|
+
* - The instance is in the running state.
|
|
10466
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
10467
|
+
* - The instance has no unpaid subscription orders.
|
|
10468
|
+
* - 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).
|
|
10469
|
+
* > 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.
|
|
10333
10470
|
*
|
|
10334
10471
|
* @param request - TransformToPrePaidRequest
|
|
10335
10472
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10402,11 +10539,11 @@ export default class Client extends OpenApi {
|
|
|
10402
10539
|
* 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).
|
|
10403
10540
|
* A subscription instance cannot be changed to a pay-as-you-go instance. To avoid wasting resources, proceed with caution.
|
|
10404
10541
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
10405
|
-
*
|
|
10406
|
-
*
|
|
10407
|
-
*
|
|
10408
|
-
*
|
|
10409
|
-
* >
|
|
10542
|
+
* - The instance is in the running state.
|
|
10543
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
10544
|
+
* - The instance has no unpaid subscription orders.
|
|
10545
|
+
* - 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).
|
|
10546
|
+
* > 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.
|
|
10410
10547
|
*
|
|
10411
10548
|
* @param request - TransformToPrePaidRequest
|
|
10412
10549
|
* @returns TransformToPrePaidResponse
|
|
@@ -10420,9 +10557,9 @@ export default class Client extends OpenApi {
|
|
|
10420
10557
|
* Removes a tag if the tag is not added to another instance.
|
|
10421
10558
|
*
|
|
10422
10559
|
* @remarks
|
|
10423
|
-
* >
|
|
10424
|
-
*
|
|
10425
|
-
*
|
|
10560
|
+
* >
|
|
10561
|
+
* - You can remove up to 20 tags at a time.
|
|
10562
|
+
* - If you remove a tag from all instances, the tag is automatically deleted.
|
|
10426
10563
|
*
|
|
10427
10564
|
* @param request - UntagResourcesRequest
|
|
10428
10565
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10492,9 +10629,9 @@ export default class Client extends OpenApi {
|
|
|
10492
10629
|
* Removes a tag if the tag is not added to another instance.
|
|
10493
10630
|
*
|
|
10494
10631
|
* @remarks
|
|
10495
|
-
* >
|
|
10496
|
-
*
|
|
10497
|
-
*
|
|
10632
|
+
* >
|
|
10633
|
+
* - You can remove up to 20 tags at a time.
|
|
10634
|
+
* - If you remove a tag from all instances, the tag is automatically deleted.
|
|
10498
10635
|
*
|
|
10499
10636
|
* @param request - UntagResourcesRequest
|
|
10500
10637
|
* @returns UntagResourcesResponse
|
|
@@ -10509,9 +10646,11 @@ export default class Client extends OpenApi {
|
|
|
10509
10646
|
*
|
|
10510
10647
|
* @remarks
|
|
10511
10648
|
* The instance must be in the running state when you call this operation.
|
|
10512
|
-
* >
|
|
10513
|
-
* >
|
|
10514
|
-
* >
|
|
10649
|
+
* > - 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.
|
|
10650
|
+
* >
|
|
10651
|
+
* > - You cannot downgrade the MongoDB version of an instance after you upgrade it.
|
|
10652
|
+
* >
|
|
10653
|
+
* > - 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.
|
|
10515
10654
|
*
|
|
10516
10655
|
* @param request - UpgradeDBInstanceEngineVersionRequest
|
|
10517
10656
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -10570,9 +10709,11 @@ export default class Client extends OpenApi {
|
|
|
10570
10709
|
*
|
|
10571
10710
|
* @remarks
|
|
10572
10711
|
* The instance must be in the running state when you call this operation.
|
|
10573
|
-
* >
|
|
10574
|
-
* >
|
|
10575
|
-
* >
|
|
10712
|
+
* > - 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.
|
|
10713
|
+
* >
|
|
10714
|
+
* > - You cannot downgrade the MongoDB version of an instance after you upgrade it.
|
|
10715
|
+
* >
|
|
10716
|
+
* > - 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.
|
|
10576
10717
|
*
|
|
10577
10718
|
* @param request - UpgradeDBInstanceEngineVersionRequest
|
|
10578
10719
|
* @returns UpgradeDBInstanceEngineVersionResponse
|