@alicloud/dds20151201 8.4.0 → 8.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +530 -428
- package/dist/client.js +563 -428
- package/dist/client.js.map +1 -1
- package/dist/models/AllocateDbinstanceSrvNetworkAddressRequest.d.ts +16 -0
- package/dist/models/AllocateDbinstanceSrvNetworkAddressRequest.js.map +1 -1
- package/dist/models/AllocateDbinstanceSrvNetworkAddressResponseBody.d.ts +3 -0
- package/dist/models/AllocateDbinstanceSrvNetworkAddressResponseBody.js.map +1 -1
- package/dist/models/AllocateNodePrivateNetworkAddressRequest.d.ts +8 -7
- package/dist/models/AllocateNodePrivateNetworkAddressRequest.js.map +1 -1
- package/dist/models/CancelActiveOperationTasksRequest.d.ts +5 -0
- package/dist/models/CancelActiveOperationTasksRequest.js.map +1 -1
- package/dist/models/CancelActiveOperationTasksResponseBody.d.ts +6 -0
- package/dist/models/CancelActiveOperationTasksResponseBody.js.map +1 -1
- package/dist/models/CheckCloudResourceAuthorizedResponseBody.d.ts +6 -4
- package/dist/models/CheckCloudResourceAuthorizedResponseBody.js.map +1 -1
- package/dist/models/CreateAccountRequest.d.ts +6 -4
- package/dist/models/CreateAccountRequest.js.map +1 -1
- package/dist/models/CreateBackupRequest.d.ts +22 -4
- package/dist/models/CreateBackupRequest.js.map +1 -1
- package/dist/models/CreateBackupResponseBody.d.ts +6 -1
- package/dist/models/CreateBackupResponseBody.js.map +1 -1
- package/dist/models/CreateDbinstanceRequest.d.ts +212 -139
- package/dist/models/CreateDbinstanceRequest.js.map +1 -1
- package/dist/models/CreateDbinstanceResponseBody.d.ts +3 -3
- package/dist/models/CreateGlobalSecurityIpgroupRequest.d.ts +5 -3
- package/dist/models/CreateGlobalSecurityIpgroupRequest.js.map +1 -1
- package/dist/models/CreateGlobalSecurityIpgroupResponseBody.d.ts +5 -3
- package/dist/models/CreateGlobalSecurityIpgroupResponseBody.js.map +1 -1
- package/dist/models/CreateNodeBatchRequest.d.ts +24 -8
- package/dist/models/CreateNodeBatchRequest.js.map +1 -1
- package/dist/models/CreateNodeRequest.d.ts +59 -34
- package/dist/models/CreateNodeRequest.js +6 -0
- package/dist/models/CreateNodeRequest.js.map +1 -1
- package/dist/models/CreateNodeRoleTagRequest.d.ts +7 -0
- package/dist/models/CreateNodeRoleTagRequest.js.map +1 -1
- package/dist/models/CreateNodeRoleTagResponseBody.d.ts +3 -0
- package/dist/models/CreateNodeRoleTagResponseBody.js.map +1 -1
- package/dist/models/CreateShardingDbinstanceRequest.d.ts +205 -157
- package/dist/models/CreateShardingDbinstanceRequest.js.map +1 -1
- package/dist/models/DeleteBackupRequest.d.ts +4 -0
- package/dist/models/DeleteBackupRequest.js.map +1 -1
- package/dist/models/DeleteBackupResponseBody.d.ts +3 -0
- package/dist/models/DeleteBackupResponseBody.js.map +1 -1
- package/dist/models/DeleteDbinstanceRequest.d.ts +1 -1
- package/dist/models/DeleteGlobalSecurityIpgroupRequest.d.ts +8 -6
- package/dist/models/DeleteGlobalSecurityIpgroupRequest.js.map +1 -1
- package/dist/models/DeleteGlobalSecurityIpgroupResponseBody.d.ts +1 -1
- package/dist/models/DescribeActiveOperationMaintenanceConfigResponseBody.d.ts +30 -17
- package/dist/models/DescribeActiveOperationMaintenanceConfigResponseBody.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskCountResponseBody.d.ts +3 -2
- package/dist/models/DescribeActiveOperationTaskCountResponseBody.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskRegionRequest.d.ts +10 -8
- package/dist/models/DescribeActiveOperationTaskRegionRequest.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskRegionResponseBody.d.ts +3 -3
- package/dist/models/DescribeActiveOperationTaskRequest.d.ts +4 -1
- package/dist/models/DescribeActiveOperationTaskRequest.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskResponseBody.d.ts +8 -0
- package/dist/models/DescribeActiveOperationTaskResponseBody.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskTypeRequest.d.ts +3 -2
- package/dist/models/DescribeActiveOperationTaskTypeRequest.js.map +1 -1
- package/dist/models/DescribeActiveOperationTaskTypeResponseBody.d.ts +4 -3
- package/dist/models/DescribeActiveOperationTaskTypeResponseBody.js.map +1 -1
- package/dist/models/DescribeActiveOperationTasksRequest.d.ts +55 -30
- package/dist/models/DescribeActiveOperationTasksRequest.js.map +1 -1
- package/dist/models/DescribeActiveOperationTasksResponseBody.d.ts +92 -56
- package/dist/models/DescribeActiveOperationTasksResponseBody.js.map +1 -1
- package/dist/models/DescribeAuditLogFilterRequest.d.ts +5 -3
- package/dist/models/DescribeAuditLogFilterRequest.js.map +1 -1
- package/dist/models/DescribeAuditLogFilterResponseBody.d.ts +13 -7
- package/dist/models/DescribeAuditLogFilterResponseBody.js.map +1 -1
- package/dist/models/DescribeAuditPolicyResponseBody.d.ts +5 -4
- package/dist/models/DescribeAuditPolicyResponseBody.js.map +1 -1
- package/dist/models/DescribeAuditRecordsRequest.d.ts +21 -20
- package/dist/models/DescribeAuditRecordsRequest.js.map +1 -1
- package/dist/models/DescribeAuditRecordsResponseBody.d.ts +3 -3
- package/dist/models/DescribeAvailabilityZonesRequest.d.ts +36 -23
- package/dist/models/DescribeAvailabilityZonesRequest.js.map +1 -1
- package/dist/models/DescribeAvailabilityZonesResponseBody.d.ts +3 -2
- package/dist/models/DescribeAvailabilityZonesResponseBody.js.map +1 -1
- package/dist/models/DescribeAvailableResourceRequest.d.ts +15 -9
- package/dist/models/DescribeAvailableResourceRequest.js.map +1 -1
- package/dist/models/DescribeBackupDbsRequest.d.ts +4 -4
- package/dist/models/DescribeBackupPolicyRequest.d.ts +5 -4
- package/dist/models/DescribeBackupPolicyRequest.js.map +1 -1
- package/dist/models/DescribeBackupPolicyResponseBody.d.ts +99 -56
- package/dist/models/DescribeBackupPolicyResponseBody.js.map +1 -1
- package/dist/models/DescribeBackupStorageRequest.d.ts +2 -2
- package/dist/models/DescribeBackupStorageResponseBody.d.ts +4 -4
- package/dist/models/DescribeBackupTasksRequest.d.ts +2 -2
- package/dist/models/DescribeBackupTasksResponseBody.d.ts +15 -11
- package/dist/models/DescribeBackupTasksResponseBody.js.map +1 -1
- package/dist/models/DescribeBackupsRequest.d.ts +30 -17
- package/dist/models/DescribeBackupsRequest.js.map +1 -1
- package/dist/models/DescribeBackupsResponseBody.d.ts +8 -6
- package/dist/models/DescribeBackupsResponseBody.js.map +1 -1
- package/dist/models/DescribeBinlogFilesRequest.d.ts +48 -0
- package/dist/models/DescribeBinlogFilesRequest.js.map +1 -1
- package/dist/models/DescribeBinlogFilesResponseBody.d.ts +12 -0
- package/dist/models/DescribeBinlogFilesResponseBody.js.map +1 -1
- package/dist/models/DescribeClusterBackupsRequest.d.ts +29 -18
- package/dist/models/DescribeClusterBackupsRequest.js.map +1 -1
- package/dist/models/DescribeClusterBackupsResponseBody.d.ts +76 -50
- package/dist/models/DescribeClusterBackupsResponseBody.js.map +1 -1
- package/dist/models/DescribeClusterRecoverTimeRequest.d.ts +23 -1
- package/dist/models/DescribeClusterRecoverTimeRequest.js +2 -0
- package/dist/models/DescribeClusterRecoverTimeRequest.js.map +1 -1
- package/dist/models/DescribeClusterRecoverTimeResponseBody.d.ts +5 -6
- package/dist/models/DescribeClusterRecoverTimeResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceAttributeRequest.d.ts +8 -7
- package/dist/models/DescribeDbinstanceAttributeRequest.js.map +1 -1
- package/dist/models/DescribeDbinstanceAttributeResponseBody.d.ts +33 -1
- package/dist/models/DescribeDbinstanceAttributeResponseBody.js +57 -1
- package/dist/models/DescribeDbinstanceAttributeResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceEncryptionKeyResponseBody.d.ts +3 -2
- package/dist/models/DescribeDbinstanceEncryptionKeyResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstancePerformanceRequest.d.ts +26 -15
- package/dist/models/DescribeDbinstancePerformanceRequest.js.map +1 -1
- package/dist/models/DescribeDbinstancePerformanceResponseBody.d.ts +2 -2
- package/dist/models/DescribeDbinstanceSpecInfoRequest.d.ts +10 -0
- package/dist/models/DescribeDbinstanceSpecInfoRequest.js.map +1 -1
- package/dist/models/DescribeDbinstanceSpecInfoResponseBody.d.ts +16 -0
- package/dist/models/DescribeDbinstanceSpecInfoResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceSslresponseBody.d.ts +16 -4
- package/dist/models/DescribeDbinstanceSslresponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceSwitchLogResponseBody.d.ts +12 -7
- package/dist/models/DescribeDbinstanceSwitchLogResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstanceTdeinfoResponseBody.d.ts +16 -15
- package/dist/models/DescribeDbinstanceTdeinfoResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstancesOverviewRequest.d.ts +38 -26
- package/dist/models/DescribeDbinstancesOverviewRequest.js.map +1 -1
- package/dist/models/DescribeDbinstancesOverviewResponseBody.d.ts +82 -58
- package/dist/models/DescribeDbinstancesOverviewResponseBody.js.map +1 -1
- package/dist/models/DescribeDbinstancesRequest.d.ts +78 -51
- package/dist/models/DescribeDbinstancesRequest.js.map +1 -1
- package/dist/models/DescribeDbinstancesResponseBody.d.ts +3 -3
- package/dist/models/DescribeErrorLogRecordsRequest.d.ts +9 -7
- package/dist/models/DescribeErrorLogRecordsRequest.js.map +1 -1
- package/dist/models/DescribeGlobalSecurityIpgroupRelationRequest.d.ts +1 -1
- package/dist/models/DescribeGlobalSecurityIpgroupRelationResponseBody.d.ts +6 -6
- package/dist/models/DescribeHistoryTasksRequest.d.ts +58 -30
- package/dist/models/DescribeHistoryTasksRequest.js.map +1 -1
- package/dist/models/DescribeHistoryTasksResponseBody.d.ts +85 -53
- package/dist/models/DescribeHistoryTasksResponseBody.js.map +1 -1
- package/dist/models/DescribeInstanceAutoRenewalAttributeRequest.d.ts +4 -3
- package/dist/models/DescribeInstanceAutoRenewalAttributeRequest.js.map +1 -1
- package/dist/models/DescribeInstanceRecoverTimeRequest.d.ts +22 -0
- package/dist/models/DescribeInstanceRecoverTimeRequest.js +2 -0
- package/dist/models/DescribeInstanceRecoverTimeRequest.js.map +1 -1
- package/dist/models/DescribeInstanceRecoverTimeResponseBody.d.ts +5 -6
- package/dist/models/DescribeInstanceRecoverTimeResponseBody.js.map +1 -1
- package/dist/models/DescribeKernelReleaseNotesRequest.d.ts +1 -1
- package/dist/models/DescribeMongoDblogConfigRequest.d.ts +1 -1
- package/dist/models/DescribeMongoDblogConfigResponseBody.d.ts +39 -19
- package/dist/models/DescribeMongoDblogConfigResponseBody.js.map +1 -1
- package/dist/models/DescribeParameterModificationHistoryRequest.d.ts +11 -8
- package/dist/models/DescribeParameterModificationHistoryRequest.js.map +1 -1
- package/dist/models/DescribeParameterTemplatesRequest.d.ts +22 -14
- package/dist/models/DescribeParameterTemplatesRequest.js.map +1 -1
- package/dist/models/DescribeParameterTemplatesResponseBody.d.ts +4 -4
- package/dist/models/DescribeParametersRequest.d.ts +7 -5
- package/dist/models/DescribeParametersRequest.js.map +1 -1
- package/dist/models/DescribePriceRequest.d.ts +37 -25
- package/dist/models/DescribePriceRequest.js.map +1 -1
- package/dist/models/DescribePriceResponseBody.d.ts +32 -25
- package/dist/models/DescribePriceResponseBody.js.map +1 -1
- package/dist/models/DescribeRdsVpcsRequest.d.ts +6 -0
- package/dist/models/DescribeRdsVpcsRequest.js.map +1 -1
- package/dist/models/DescribeRdsVpcsResponseBody.d.ts +73 -2
- package/dist/models/DescribeRdsVpcsResponseBody.js.map +1 -1
- package/dist/models/DescribeRdsVswitchsRequest.d.ts +9 -0
- package/dist/models/DescribeRdsVswitchsRequest.js.map +1 -1
- package/dist/models/DescribeRdsVswitchsResponseBody.d.ts +46 -1
- package/dist/models/DescribeRdsVswitchsResponseBody.js.map +1 -1
- package/dist/models/DescribeRegionsRequest.d.ts +4 -3
- package/dist/models/DescribeRegionsRequest.js.map +1 -1
- package/dist/models/DescribeRenewalPriceRequest.d.ts +8 -4
- package/dist/models/DescribeRenewalPriceRequest.js.map +1 -1
- package/dist/models/DescribeRenewalPriceResponseBody.d.ts +22 -9
- package/dist/models/DescribeRenewalPriceResponseBody.js.map +1 -1
- package/dist/models/DescribeReplicaSetRoleResponseBody.d.ts +11 -0
- package/dist/models/DescribeReplicaSetRoleResponseBody.js.map +1 -1
- package/dist/models/DescribeRestoreDbinstanceListRequest.d.ts +2 -2
- package/dist/models/DescribeRoleTagStatusRequest.d.ts +2 -0
- package/dist/models/DescribeRoleTagStatusRequest.js.map +1 -1
- package/dist/models/DescribeRoleTagStatusResponseBody.d.ts +19 -0
- package/dist/models/DescribeRoleTagStatusResponseBody.js.map +1 -1
- package/dist/models/DescribeRunningLogRecordsRequest.d.ts +19 -20
- package/dist/models/DescribeRunningLogRecordsRequest.js.map +1 -1
- package/dist/models/DescribeRunningLogRecordsResponseBody.d.ts +4 -4
- package/dist/models/DescribeShardingNetworkAddressRequest.d.ts +15 -2
- package/dist/models/DescribeShardingNetworkAddressRequest.js.map +1 -1
- package/dist/models/DescribeShardingNetworkAddressResponseBody.d.ts +7 -0
- package/dist/models/DescribeShardingNetworkAddressResponseBody.js.map +1 -1
- package/dist/models/DescribeSlowLogRecordsRequest.d.ts +8 -6
- package/dist/models/DescribeSlowLogRecordsRequest.js.map +1 -1
- package/dist/models/DescribeTagsRequest.d.ts +1 -1
- package/dist/models/DescribeTagsResponseBody.d.ts +5 -2
- package/dist/models/DescribeTagsResponseBody.js.map +1 -1
- package/dist/models/DescribeUserEncryptionKeyListRequest.d.ts +13 -2
- package/dist/models/DescribeUserEncryptionKeyListRequest.js.map +1 -1
- package/dist/models/DescribeUserEncryptionKeyListResponseBody.d.ts +1 -1
- package/dist/models/DescribeVpcsForMongoDbrequest.d.ts +15 -0
- package/dist/models/DescribeVpcsForMongoDbrequest.js.map +1 -1
- package/dist/models/DescribeVpcsForMongoDbresponseBody.d.ts +80 -2
- package/dist/models/DescribeVpcsForMongoDbresponseBody.js.map +1 -1
- package/dist/models/EvaluateResourceRequest.d.ts +51 -37
- package/dist/models/EvaluateResourceRequest.js.map +1 -1
- package/dist/models/EvaluateResourceResponseBody.d.ts +7 -6
- package/dist/models/EvaluateResourceResponseBody.js.map +1 -1
- package/dist/models/ListTagResourcesRequest.d.ts +4 -4
- package/dist/models/ListTagResourcesResponseBody.d.ts +1 -1
- package/dist/models/MigrateAvailableZoneRequest.d.ts +5 -4
- package/dist/models/MigrateAvailableZoneRequest.js.map +1 -1
- package/dist/models/MigrateToOtherZoneRequest.d.ts +8 -6
- package/dist/models/MigrateToOtherZoneRequest.js.map +1 -1
- package/dist/models/ModifyAccountDescriptionRequest.d.ts +9 -6
- package/dist/models/ModifyAccountDescriptionRequest.js.map +1 -1
- package/dist/models/ModifyActiveOperationMaintenanceConfigRequest.d.ts +27 -0
- package/dist/models/ModifyActiveOperationMaintenanceConfigRequest.js.map +1 -1
- package/dist/models/ModifyActiveOperationMaintenanceConfigResponseBody.d.ts +3 -0
- package/dist/models/ModifyActiveOperationMaintenanceConfigResponseBody.js.map +1 -1
- package/dist/models/ModifyAuditLogFilterRequest.d.ts +16 -9
- package/dist/models/ModifyAuditLogFilterRequest.js.map +1 -1
- package/dist/models/ModifyAuditPolicyRequest.d.ts +24 -9
- package/dist/models/ModifyAuditPolicyRequest.js.map +1 -1
- package/dist/models/ModifyBackupExpireTimeRequest.d.ts +13 -0
- package/dist/models/ModifyBackupExpireTimeRequest.js.map +1 -1
- package/dist/models/ModifyBackupExpireTimeResponseBody.d.ts +15 -0
- package/dist/models/ModifyBackupExpireTimeResponseBody.js.map +1 -1
- package/dist/models/ModifyBackupPolicyRequest.d.ts +128 -93
- package/dist/models/ModifyBackupPolicyRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceAttributeRequest.d.ts +9 -0
- package/dist/models/ModifyDbinstanceAttributeRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceAttributeResponseBody.d.ts +3 -0
- package/dist/models/ModifyDbinstanceAttributeResponseBody.js.map +1 -1
- package/dist/models/ModifyDbinstanceConfigRequest.d.ts +6 -0
- package/dist/models/ModifyDbinstanceConfigRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceConfigResponseBody.d.ts +3 -0
- package/dist/models/ModifyDbinstanceConfigResponseBody.js.map +1 -1
- package/dist/models/ModifyDbinstanceConnectionStringRequest.d.ts +17 -9
- package/dist/models/ModifyDbinstanceConnectionStringRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceConnectionStringResponseBody.d.ts +1 -1
- package/dist/models/ModifyDbinstanceDescriptionRequest.d.ts +5 -5
- package/dist/models/ModifyDbinstanceDiskTypeRequest.d.ts +28 -16
- package/dist/models/ModifyDbinstanceDiskTypeRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceMaintainTimeRequest.d.ts +1 -1
- package/dist/models/ModifyDbinstanceNetworkTypeRequest.d.ts +14 -20
- package/dist/models/ModifyDbinstanceNetworkTypeRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceSpecRequest.d.ts +125 -42
- package/dist/models/ModifyDbinstanceSpecRequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceSpecResponseBody.d.ts +2 -2
- package/dist/models/ModifyDbinstanceSslrequest.d.ts +39 -5
- package/dist/models/ModifyDbinstanceSslrequest.js.map +1 -1
- package/dist/models/ModifyDbinstanceSslresponseBody.d.ts +1 -1
- package/dist/models/ModifyDbinstanceTderequest.d.ts +33 -7
- package/dist/models/ModifyDbinstanceTderequest.js.map +1 -1
- package/dist/models/ModifyGlobalSecurityIpgroupNameRequest.d.ts +5 -3
- package/dist/models/ModifyGlobalSecurityIpgroupNameRequest.js.map +1 -1
- package/dist/models/ModifyInstanceVpcAuthModeRequest.d.ts +2 -2
- package/dist/models/ModifyNodeSpecBatchRequest.d.ts +114 -19
- package/dist/models/ModifyNodeSpecBatchRequest.js.map +1 -1
- package/dist/models/ModifyNodeSpecRequest.d.ts +75 -22
- package/dist/models/ModifyNodeSpecRequest.js.map +1 -1
- package/dist/models/ModifyNodeSpecResponseBody.d.ts +2 -2
- package/dist/models/ModifyParametersRequest.d.ts +23 -10
- package/dist/models/ModifyParametersRequest.js.map +1 -1
- package/dist/models/ModifySecurityGroupConfigurationRequest.d.ts +3 -2
- package/dist/models/ModifySecurityGroupConfigurationRequest.js.map +1 -1
- package/dist/models/ModifySecurityIpsRequest.d.ts +8 -5
- package/dist/models/ModifySecurityIpsRequest.js.map +1 -1
- package/dist/models/ModifySrvNetworkAddressRequest.d.ts +20 -0
- package/dist/models/ModifySrvNetworkAddressRequest.js.map +1 -1
- package/dist/models/ModifySrvNetworkAddressResponseBody.d.ts +3 -0
- package/dist/models/ModifySrvNetworkAddressResponseBody.js.map +1 -1
- package/dist/models/ReleaseNodePrivateNetworkAddressRequest.d.ts +17 -9
- package/dist/models/ReleaseNodePrivateNetworkAddressRequest.js.map +1 -1
- package/dist/models/ReleasePublicNetworkAddressRequest.d.ts +8 -6
- package/dist/models/ReleasePublicNetworkAddressRequest.js.map +1 -1
- package/dist/models/RenewDbinstanceRequest.d.ts +10 -7
- package/dist/models/RenewDbinstanceRequest.js.map +1 -1
- package/dist/models/ResetAccountPasswordRequest.d.ts +6 -4
- package/dist/models/ResetAccountPasswordRequest.js.map +1 -1
- package/dist/models/RestartDbinstanceRequest.d.ts +14 -2
- package/dist/models/RestartDbinstanceRequest.js +2 -0
- package/dist/models/RestartDbinstanceRequest.js.map +1 -1
- package/dist/models/RestartNodeRequest.d.ts +19 -5
- package/dist/models/RestartNodeRequest.js.map +1 -1
- package/dist/models/SwitchDbinstanceHarequest.d.ts +5 -4
- package/dist/models/SwitchDbinstanceHarequest.js.map +1 -1
- package/dist/models/TagResourcesRequest.d.ts +4 -2
- package/dist/models/TagResourcesRequest.js.map +1 -1
- package/dist/models/TransformInstanceChargeTypeRequest.d.ts +17 -13
- package/dist/models/TransformInstanceChargeTypeRequest.js.map +1 -1
- package/dist/models/TransformToPrePaidRequest.d.ts +9 -7
- package/dist/models/TransformToPrePaidRequest.js.map +1 -1
- package/dist/models/UntagResourcesRequest.d.ts +8 -4
- package/dist/models/UntagResourcesRequest.js.map +1 -1
- package/dist/models/UpgradeDbinstanceEngineVersionRequest.d.ts +4 -3
- package/dist/models/UpgradeDbinstanceEngineVersionRequest.js.map +1 -1
- package/dist/models/model.d.ts +2 -0
- package/dist/models/model.js +21 -17
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +575 -434
- package/src/models/AllocateDbinstanceSrvNetworkAddressRequest.ts +16 -0
- package/src/models/AllocateDbinstanceSrvNetworkAddressResponseBody.ts +3 -0
- package/src/models/AllocateNodePrivateNetworkAddressRequest.ts +9 -8
- package/src/models/CancelActiveOperationTasksRequest.ts +5 -0
- package/src/models/CancelActiveOperationTasksResponseBody.ts +6 -0
- package/src/models/CheckCloudResourceAuthorizedResponseBody.ts +6 -4
- package/src/models/CreateAccountRequest.ts +6 -4
- package/src/models/CreateBackupRequest.ts +22 -4
- package/src/models/CreateBackupResponseBody.ts +6 -1
- package/src/models/CreateDbinstanceRequest.ts +212 -139
- package/src/models/CreateDbinstanceResponseBody.ts +3 -3
- package/src/models/CreateGlobalSecurityIpgroupRequest.ts +5 -3
- package/src/models/CreateGlobalSecurityIpgroupResponseBody.ts +5 -3
- package/src/models/CreateNodeBatchRequest.ts +33 -17
- package/src/models/CreateNodeRequest.ts +65 -34
- package/src/models/CreateNodeRoleTagRequest.ts +7 -0
- package/src/models/CreateNodeRoleTagResponseBody.ts +3 -0
- package/src/models/CreateShardingDbinstanceRequest.ts +208 -160
- package/src/models/DeleteBackupRequest.ts +4 -0
- package/src/models/DeleteBackupResponseBody.ts +3 -0
- package/src/models/DeleteDbinstanceRequest.ts +1 -1
- package/src/models/DeleteGlobalSecurityIpgroupRequest.ts +8 -6
- package/src/models/DeleteGlobalSecurityIpgroupResponseBody.ts +1 -1
- package/src/models/DescribeActiveOperationMaintenanceConfigResponseBody.ts +30 -17
- package/src/models/DescribeActiveOperationTaskCountResponseBody.ts +3 -2
- package/src/models/DescribeActiveOperationTaskRegionRequest.ts +10 -8
- package/src/models/DescribeActiveOperationTaskRegionResponseBody.ts +3 -3
- package/src/models/DescribeActiveOperationTaskRequest.ts +5 -2
- package/src/models/DescribeActiveOperationTaskResponseBody.ts +8 -0
- package/src/models/DescribeActiveOperationTaskTypeRequest.ts +3 -2
- package/src/models/DescribeActiveOperationTaskTypeResponseBody.ts +4 -3
- package/src/models/DescribeActiveOperationTasksRequest.ts +55 -30
- package/src/models/DescribeActiveOperationTasksResponseBody.ts +92 -56
- package/src/models/DescribeAuditLogFilterRequest.ts +5 -3
- package/src/models/DescribeAuditLogFilterResponseBody.ts +13 -7
- package/src/models/DescribeAuditPolicyResponseBody.ts +5 -4
- package/src/models/DescribeAuditRecordsRequest.ts +21 -20
- package/src/models/DescribeAuditRecordsResponseBody.ts +3 -3
- package/src/models/DescribeAvailabilityZonesRequest.ts +36 -23
- package/src/models/DescribeAvailabilityZonesResponseBody.ts +3 -2
- package/src/models/DescribeAvailableResourceRequest.ts +15 -9
- package/src/models/DescribeBackupDbsRequest.ts +6 -6
- package/src/models/DescribeBackupPolicyRequest.ts +5 -4
- package/src/models/DescribeBackupPolicyResponseBody.ts +100 -57
- package/src/models/DescribeBackupStorageRequest.ts +2 -2
- package/src/models/DescribeBackupStorageResponseBody.ts +4 -4
- package/src/models/DescribeBackupTasksRequest.ts +2 -2
- package/src/models/DescribeBackupTasksResponseBody.ts +15 -11
- package/src/models/DescribeBackupsRequest.ts +30 -17
- package/src/models/DescribeBackupsResponseBody.ts +8 -6
- package/src/models/DescribeBinlogFilesRequest.ts +48 -0
- package/src/models/DescribeBinlogFilesResponseBody.ts +12 -0
- package/src/models/DescribeClusterBackupsRequest.ts +30 -19
- package/src/models/DescribeClusterBackupsResponseBody.ts +76 -50
- package/src/models/DescribeClusterRecoverTimeRequest.ts +25 -1
- package/src/models/DescribeClusterRecoverTimeResponseBody.ts +5 -6
- package/src/models/DescribeDbinstanceAttributeRequest.ts +8 -7
- package/src/models/DescribeDbinstanceAttributeResponseBody.ts +71 -1
- package/src/models/DescribeDbinstanceEncryptionKeyResponseBody.ts +3 -2
- package/src/models/DescribeDbinstancePerformanceRequest.ts +26 -15
- package/src/models/DescribeDbinstancePerformanceResponseBody.ts +2 -2
- package/src/models/DescribeDbinstanceSpecInfoRequest.ts +10 -0
- package/src/models/DescribeDbinstanceSpecInfoResponseBody.ts +16 -0
- package/src/models/DescribeDbinstanceSslresponseBody.ts +16 -4
- package/src/models/DescribeDbinstanceSwitchLogResponseBody.ts +12 -7
- package/src/models/DescribeDbinstanceTdeinfoResponseBody.ts +16 -15
- package/src/models/DescribeDbinstancesOverviewRequest.ts +39 -27
- package/src/models/DescribeDbinstancesOverviewResponseBody.ts +83 -59
- package/src/models/DescribeDbinstancesRequest.ts +78 -51
- package/src/models/DescribeDbinstancesResponseBody.ts +3 -3
- package/src/models/DescribeErrorLogRecordsRequest.ts +9 -7
- package/src/models/DescribeGlobalSecurityIpgroupRelationRequest.ts +1 -1
- package/src/models/DescribeGlobalSecurityIpgroupRelationResponseBody.ts +6 -6
- package/src/models/DescribeHistoryTasksRequest.ts +58 -30
- package/src/models/DescribeHistoryTasksResponseBody.ts +85 -53
- package/src/models/DescribeInstanceAutoRenewalAttributeRequest.ts +4 -3
- package/src/models/DescribeInstanceRecoverTimeRequest.ts +24 -0
- package/src/models/DescribeInstanceRecoverTimeResponseBody.ts +5 -6
- package/src/models/DescribeKernelReleaseNotesRequest.ts +1 -1
- package/src/models/DescribeMongoDblogConfigRequest.ts +1 -1
- package/src/models/DescribeMongoDblogConfigResponseBody.ts +39 -19
- package/src/models/DescribeParameterModificationHistoryRequest.ts +11 -8
- package/src/models/DescribeParameterTemplatesRequest.ts +22 -14
- package/src/models/DescribeParameterTemplatesResponseBody.ts +4 -4
- package/src/models/DescribeParametersRequest.ts +7 -5
- package/src/models/DescribePriceRequest.ts +37 -25
- package/src/models/DescribePriceResponseBody.ts +32 -25
- package/src/models/DescribeRdsVpcsRequest.ts +6 -0
- package/src/models/DescribeRdsVpcsResponseBody.ts +73 -2
- package/src/models/DescribeRdsVswitchsRequest.ts +9 -0
- package/src/models/DescribeRdsVswitchsResponseBody.ts +46 -1
- package/src/models/DescribeRegionsRequest.ts +4 -3
- package/src/models/DescribeRenewalPriceRequest.ts +8 -4
- package/src/models/DescribeRenewalPriceResponseBody.ts +22 -9
- package/src/models/DescribeReplicaSetRoleResponseBody.ts +11 -0
- package/src/models/DescribeRestoreDbinstanceListRequest.ts +2 -2
- package/src/models/DescribeRoleTagStatusRequest.ts +2 -0
- package/src/models/DescribeRoleTagStatusResponseBody.ts +19 -0
- package/src/models/DescribeRunningLogRecordsRequest.ts +19 -20
- package/src/models/DescribeRunningLogRecordsResponseBody.ts +4 -4
- package/src/models/DescribeShardingNetworkAddressRequest.ts +15 -2
- package/src/models/DescribeShardingNetworkAddressResponseBody.ts +7 -0
- package/src/models/DescribeSlowLogRecordsRequest.ts +9 -7
- package/src/models/DescribeTagsRequest.ts +1 -1
- package/src/models/DescribeTagsResponseBody.ts +5 -2
- package/src/models/DescribeUserEncryptionKeyListRequest.ts +13 -2
- package/src/models/DescribeUserEncryptionKeyListResponseBody.ts +1 -1
- package/src/models/DescribeVpcsForMongoDbrequest.ts +15 -0
- package/src/models/DescribeVpcsForMongoDbresponseBody.ts +80 -2
- package/src/models/EvaluateResourceRequest.ts +51 -37
- package/src/models/EvaluateResourceResponseBody.ts +7 -6
- package/src/models/ListTagResourcesRequest.ts +4 -4
- package/src/models/ListTagResourcesResponseBody.ts +1 -1
- package/src/models/MigrateAvailableZoneRequest.ts +6 -5
- package/src/models/MigrateToOtherZoneRequest.ts +8 -6
- package/src/models/ModifyAccountDescriptionRequest.ts +9 -6
- package/src/models/ModifyActiveOperationMaintenanceConfigRequest.ts +27 -0
- package/src/models/ModifyActiveOperationMaintenanceConfigResponseBody.ts +3 -0
- package/src/models/ModifyAuditLogFilterRequest.ts +16 -9
- package/src/models/ModifyAuditPolicyRequest.ts +24 -9
- package/src/models/ModifyBackupExpireTimeRequest.ts +13 -0
- package/src/models/ModifyBackupExpireTimeResponseBody.ts +15 -0
- package/src/models/ModifyBackupPolicyRequest.ts +130 -95
- package/src/models/ModifyDbinstanceAttributeRequest.ts +9 -0
- package/src/models/ModifyDbinstanceAttributeResponseBody.ts +3 -0
- package/src/models/ModifyDbinstanceConfigRequest.ts +6 -0
- package/src/models/ModifyDbinstanceConfigResponseBody.ts +3 -0
- package/src/models/ModifyDbinstanceConnectionStringRequest.ts +17 -9
- package/src/models/ModifyDbinstanceConnectionStringResponseBody.ts +1 -1
- package/src/models/ModifyDbinstanceDescriptionRequest.ts +6 -6
- package/src/models/ModifyDbinstanceDiskTypeRequest.ts +28 -16
- package/src/models/ModifyDbinstanceMaintainTimeRequest.ts +1 -1
- package/src/models/ModifyDbinstanceNetworkTypeRequest.ts +14 -20
- package/src/models/ModifyDbinstanceSpecRequest.ts +125 -42
- package/src/models/ModifyDbinstanceSpecResponseBody.ts +2 -2
- package/src/models/ModifyDbinstanceSslrequest.ts +39 -5
- package/src/models/ModifyDbinstanceSslresponseBody.ts +1 -1
- package/src/models/ModifyDbinstanceTderequest.ts +33 -7
- package/src/models/ModifyGlobalSecurityIpgroupNameRequest.ts +5 -3
- package/src/models/ModifyInstanceVpcAuthModeRequest.ts +2 -2
- package/src/models/ModifyNodeSpecBatchRequest.ts +114 -19
- package/src/models/ModifyNodeSpecRequest.ts +75 -22
- package/src/models/ModifyNodeSpecResponseBody.ts +2 -2
- package/src/models/ModifyParametersRequest.ts +23 -10
- package/src/models/ModifySecurityGroupConfigurationRequest.ts +3 -2
- package/src/models/ModifySecurityIpsRequest.ts +8 -5
- package/src/models/ModifySrvNetworkAddressRequest.ts +20 -0
- package/src/models/ModifySrvNetworkAddressResponseBody.ts +3 -0
- package/src/models/ReleaseNodePrivateNetworkAddressRequest.ts +17 -9
- package/src/models/ReleasePublicNetworkAddressRequest.ts +8 -6
- package/src/models/RenewDbinstanceRequest.ts +10 -7
- package/src/models/ResetAccountPasswordRequest.ts +6 -4
- package/src/models/RestartDbinstanceRequest.ts +16 -2
- package/src/models/RestartNodeRequest.ts +19 -5
- package/src/models/SwitchDbinstanceHarequest.ts +6 -5
- package/src/models/TagResourcesRequest.ts +4 -2
- package/src/models/TransformInstanceChargeTypeRequest.ts +17 -13
- package/src/models/TransformToPrePaidRequest.ts +9 -7
- package/src/models/UntagResourcesRequest.ts +9 -5
- package/src/models/UpgradeDbinstanceEngineVersionRequest.ts +4 -3
- package/src/models/model.ts +2 -0
package/dist/client.js
CHANGED
|
@@ -109,6 +109,21 @@ class Client extends openapi_core_1.default {
|
|
|
109
109
|
'cn-zhengzhou-nebula-1': "mongodb.aliyuncs.com",
|
|
110
110
|
'eu-west-1-oxs': "mongodb.aliyuncs.com",
|
|
111
111
|
'rus-west-1-pop': "mongodb.aliyuncs.com",
|
|
112
|
+
'us-southeast-1': "mongodb.us-southeast-1.aliyuncs.com",
|
|
113
|
+
'na-south-1': "mongodb.na-south-1.aliyuncs.com",
|
|
114
|
+
'me-central-1': "mongodb.me-central-1.aliyuncs.com",
|
|
115
|
+
'eu-west-2': "mongodb.eu-west-2.aliyuncs.com",
|
|
116
|
+
'cn-zhongwei': "mongodb.cn-zhongwei.aliyuncs.com",
|
|
117
|
+
'cn-zhengzhou-jva': "mongodb.cn-zhengzhou-jva.aliyuncs.com",
|
|
118
|
+
'cn-wulanchabu-gic-1': "mongodb.cn-wulanchabu-gic-1.aliyuncs.com",
|
|
119
|
+
'cn-wuhan-lr': "mongodb.cn-wuhan-lr.aliyuncs.com",
|
|
120
|
+
'cn-nanjing': "mongodb.cn-nanjing.aliyuncs.com",
|
|
121
|
+
'cn-heyuan-acdr-1': "mongodb.cn-heyuan-acdr-1.aliyuncs.com",
|
|
122
|
+
'cn-fuzhou': "mongodb.cn-fuzhou.aliyuncs.com",
|
|
123
|
+
'ap-southeast-8': "mongodb.ap-southeast-8.aliyuncs.com",
|
|
124
|
+
'ap-southeast-7': "mongodb.ap-southeast-7.aliyuncs.com",
|
|
125
|
+
'ap-southeast-6': "mongodb.ap-southeast-6.aliyuncs.com",
|
|
126
|
+
'ap-northeast-2': "mongodb.ap-northeast-2.aliyuncs.com",
|
|
112
127
|
};
|
|
113
128
|
this.checkConfig(config);
|
|
114
129
|
this._endpoint = this.getEndpoint("dds", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
|
|
@@ -123,7 +138,10 @@ class Client extends openapi_core_1.default {
|
|
|
123
138
|
return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
|
|
124
139
|
}
|
|
125
140
|
/**
|
|
126
|
-
* Applies for an SRV
|
|
141
|
+
* Applies for an SRV connection string for an ApsaraDB for MongoDB instance.
|
|
142
|
+
*
|
|
143
|
+
* @remarks
|
|
144
|
+
* Applicable only to cloud disk-based replica set and sharded cluster instances.
|
|
127
145
|
*
|
|
128
146
|
* @param request - AllocateDBInstanceSrvNetworkAddressRequest
|
|
129
147
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -170,7 +188,10 @@ class Client extends openapi_core_1.default {
|
|
|
170
188
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.AllocateDBInstanceSrvNetworkAddressResponse({}));
|
|
171
189
|
}
|
|
172
190
|
/**
|
|
173
|
-
* Applies for an SRV
|
|
191
|
+
* Applies for an SRV connection string for an ApsaraDB for MongoDB instance.
|
|
192
|
+
*
|
|
193
|
+
* @remarks
|
|
194
|
+
* Applicable only to cloud disk-based replica set and sharded cluster instances.
|
|
174
195
|
*
|
|
175
196
|
* @param request - AllocateDBInstanceSrvNetworkAddressRequest
|
|
176
197
|
* @returns AllocateDBInstanceSrvNetworkAddressResponse
|
|
@@ -184,7 +205,7 @@ class Client extends openapi_core_1.default {
|
|
|
184
205
|
*
|
|
185
206
|
* @remarks
|
|
186
207
|
* 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).
|
|
187
|
-
* >
|
|
208
|
+
* > 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.
|
|
188
209
|
*
|
|
189
210
|
* @param request - AllocateNodePrivateNetworkAddressRequest
|
|
190
211
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -241,7 +262,7 @@ class Client extends openapi_core_1.default {
|
|
|
241
262
|
*
|
|
242
263
|
* @remarks
|
|
243
264
|
* 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).
|
|
244
|
-
* >
|
|
265
|
+
* > 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.
|
|
245
266
|
*
|
|
246
267
|
* @param request - AllocateNodePrivateNetworkAddressRequest
|
|
247
268
|
* @returns AllocateNodePrivateNetworkAddressResponse
|
|
@@ -305,6 +326,14 @@ class Client extends openapi_core_1.default {
|
|
|
305
326
|
return await this.allocatePublicNetworkAddressWithOptions(request, runtime);
|
|
306
327
|
}
|
|
307
328
|
/**
|
|
329
|
+
* Cancels Operations and Maintenance (O&M) events in a batch.
|
|
330
|
+
*
|
|
331
|
+
* @remarks
|
|
332
|
+
* An O\\&M event cannot be canceled in the following scenarios:
|
|
333
|
+
* - The event is not cancelable if the value of the AllowCancel parameter is 0.
|
|
334
|
+
* - The scheduled start time of the O\\&M event has passed.
|
|
335
|
+
* - The status of the O\\&M event is not Pending if the value of the Status parameter is not 3.
|
|
336
|
+
*
|
|
308
337
|
* @param request - CancelActiveOperationTasksRequest
|
|
309
338
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
310
339
|
* @returns CancelActiveOperationTasksResponse
|
|
@@ -347,6 +376,14 @@ class Client extends openapi_core_1.default {
|
|
|
347
376
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CancelActiveOperationTasksResponse({}));
|
|
348
377
|
}
|
|
349
378
|
/**
|
|
379
|
+
* Cancels Operations and Maintenance (O&M) events in a batch.
|
|
380
|
+
*
|
|
381
|
+
* @remarks
|
|
382
|
+
* An O\\&M event cannot be canceled in the following scenarios:
|
|
383
|
+
* - The event is not cancelable if the value of the AllowCancel parameter is 0.
|
|
384
|
+
* - The scheduled start time of the O\\&M event has passed.
|
|
385
|
+
* - The status of the O\\&M event is not Pending if the value of the Status parameter is not 3.
|
|
386
|
+
*
|
|
350
387
|
* @param request - CancelActiveOperationTasksRequest
|
|
351
388
|
* @returns CancelActiveOperationTasksResponse
|
|
352
389
|
*/
|
|
@@ -552,8 +589,8 @@ class Client extends openapi_core_1.default {
|
|
|
552
589
|
* Creates an account that is granted read-only permissions for shard nodes in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
553
590
|
*
|
|
554
591
|
* @remarks
|
|
555
|
-
*
|
|
556
|
-
*
|
|
592
|
+
* - You can create an account for shard nodes only in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
593
|
+
* - The account is granted read-only permissions.
|
|
557
594
|
*
|
|
558
595
|
* @param request - CreateAccountRequest
|
|
559
596
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -606,8 +643,8 @@ class Client extends openapi_core_1.default {
|
|
|
606
643
|
* Creates an account that is granted read-only permissions for shard nodes in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
607
644
|
*
|
|
608
645
|
* @remarks
|
|
609
|
-
*
|
|
610
|
-
*
|
|
646
|
+
* - You can create an account for shard nodes only in an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
647
|
+
* - The account is granted read-only permissions.
|
|
611
648
|
*
|
|
612
649
|
* @param request - CreateAccountRequest
|
|
613
650
|
* @returns CreateAccountResponse
|
|
@@ -617,10 +654,10 @@ class Client extends openapi_core_1.default {
|
|
|
617
654
|
return await this.createAccountWithOptions(request, runtime);
|
|
618
655
|
}
|
|
619
656
|
/**
|
|
620
|
-
* Creates a backup
|
|
657
|
+
* Creates a backup for a MongoDB instance.
|
|
621
658
|
*
|
|
622
659
|
* @remarks
|
|
623
|
-
*
|
|
660
|
+
* The instance must be in the Running state.
|
|
624
661
|
*
|
|
625
662
|
* @param request - CreateBackupRequest
|
|
626
663
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -667,10 +704,10 @@ class Client extends openapi_core_1.default {
|
|
|
667
704
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateBackupResponse({}));
|
|
668
705
|
}
|
|
669
706
|
/**
|
|
670
|
-
* Creates a backup
|
|
707
|
+
* Creates a backup for a MongoDB instance.
|
|
671
708
|
*
|
|
672
709
|
* @remarks
|
|
673
|
-
*
|
|
710
|
+
* The instance must be in the Running state.
|
|
674
711
|
*
|
|
675
712
|
* @param request - CreateBackupRequest
|
|
676
713
|
* @returns CreateBackupResponse
|
|
@@ -683,9 +720,9 @@ class Client extends openapi_core_1.default {
|
|
|
683
720
|
* Creates or clones an ApsaraDB for MongoDB replica set instance.
|
|
684
721
|
*
|
|
685
722
|
* @remarks
|
|
686
|
-
*
|
|
687
|
-
* For more information about the instance types of ApsaraDB for MongoDB
|
|
688
|
-
* To create sharded cluster
|
|
723
|
+
* 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.
|
|
724
|
+
* For more information about the instance types of ApsaraDB for MongoDB, see [Instance types]().
|
|
725
|
+
* To create a sharded cluster instance, call the [CreateShardingDBInstance]() operation.
|
|
689
726
|
*
|
|
690
727
|
* @param request - CreateDBInstanceRequest
|
|
691
728
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -837,9 +874,9 @@ class Client extends openapi_core_1.default {
|
|
|
837
874
|
* Creates or clones an ApsaraDB for MongoDB replica set instance.
|
|
838
875
|
*
|
|
839
876
|
* @remarks
|
|
840
|
-
*
|
|
841
|
-
* For more information about the instance types of ApsaraDB for MongoDB
|
|
842
|
-
* To create sharded cluster
|
|
877
|
+
* 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.
|
|
878
|
+
* For more information about the instance types of ApsaraDB for MongoDB, see [Instance types]().
|
|
879
|
+
* To create a sharded cluster instance, call the [CreateShardingDBInstance]() operation.
|
|
843
880
|
*
|
|
844
881
|
* @param request - CreateDBInstanceRequest
|
|
845
882
|
* @returns CreateDBInstanceResponse
|
|
@@ -909,10 +946,10 @@ class Client extends openapi_core_1.default {
|
|
|
909
946
|
return await this.createGlobalSecurityIPGroupWithOptions(request, runtime);
|
|
910
947
|
}
|
|
911
948
|
/**
|
|
912
|
-
* Adds a shard or mongos node to an ApsaraDB for MongoDB instance.
|
|
949
|
+
* Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster instance.
|
|
913
950
|
*
|
|
914
951
|
* @remarks
|
|
915
|
-
* Before
|
|
952
|
+
* 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.
|
|
916
953
|
* This operation applies only to sharded cluster instances.
|
|
917
954
|
*
|
|
918
955
|
* @param request - CreateNodeRequest
|
|
@@ -967,6 +1004,15 @@ class Client extends openapi_core_1.default {
|
|
|
967
1004
|
if (!$dara.isNull(request.resourceOwnerId)) {
|
|
968
1005
|
query["ResourceOwnerId"] = request.resourceOwnerId;
|
|
969
1006
|
}
|
|
1007
|
+
if (!$dara.isNull(request.searchDBInstanceClass)) {
|
|
1008
|
+
query["SearchDBInstanceClass"] = request.searchDBInstanceClass;
|
|
1009
|
+
}
|
|
1010
|
+
if (!$dara.isNull(request.searchNodeCount)) {
|
|
1011
|
+
query["SearchNodeCount"] = request.searchNodeCount;
|
|
1012
|
+
}
|
|
1013
|
+
if (!$dara.isNull(request.searchStorage)) {
|
|
1014
|
+
query["SearchStorage"] = request.searchStorage;
|
|
1015
|
+
}
|
|
970
1016
|
if (!$dara.isNull(request.shardDirect)) {
|
|
971
1017
|
query["ShardDirect"] = request.shardDirect;
|
|
972
1018
|
}
|
|
@@ -987,10 +1033,10 @@ class Client extends openapi_core_1.default {
|
|
|
987
1033
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateNodeResponse({}));
|
|
988
1034
|
}
|
|
989
1035
|
/**
|
|
990
|
-
* Adds a shard or mongos node to an ApsaraDB for MongoDB instance.
|
|
1036
|
+
* Adds a shard node or a mongos node to an ApsaraDB for MongoDB sharded cluster instance.
|
|
991
1037
|
*
|
|
992
1038
|
* @remarks
|
|
993
|
-
* Before
|
|
1039
|
+
* 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.
|
|
994
1040
|
* This operation applies only to sharded cluster instances.
|
|
995
1041
|
*
|
|
996
1042
|
* @param request - CreateNodeRequest
|
|
@@ -1087,6 +1133,8 @@ class Client extends openapi_core_1.default {
|
|
|
1087
1133
|
return await this.createNodeBatchWithOptions(request, runtime);
|
|
1088
1134
|
}
|
|
1089
1135
|
/**
|
|
1136
|
+
* Creates a role tag for an instance node.
|
|
1137
|
+
*
|
|
1090
1138
|
* @param request - CreateNodeRoleTagRequest
|
|
1091
1139
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1092
1140
|
* @returns CreateNodeRoleTagResponse
|
|
@@ -1129,6 +1177,8 @@ class Client extends openapi_core_1.default {
|
|
|
1129
1177
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateNodeRoleTagResponse({}));
|
|
1130
1178
|
}
|
|
1131
1179
|
/**
|
|
1180
|
+
* Creates a role tag for an instance node.
|
|
1181
|
+
*
|
|
1132
1182
|
* @param request - CreateNodeRoleTagRequest
|
|
1133
1183
|
* @returns CreateNodeRoleTagResponse
|
|
1134
1184
|
*/
|
|
@@ -1137,12 +1187,12 @@ class Client extends openapi_core_1.default {
|
|
|
1137
1187
|
return await this.createNodeRoleTagWithOptions(request, runtime);
|
|
1138
1188
|
}
|
|
1139
1189
|
/**
|
|
1140
|
-
* Creates or clones
|
|
1190
|
+
* Creates or clones a MongoDB sharded cluster instance.
|
|
1141
1191
|
*
|
|
1142
1192
|
* @remarks
|
|
1143
|
-
*
|
|
1144
|
-
*
|
|
1145
|
-
*
|
|
1193
|
+
* - 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.
|
|
1194
|
+
* - For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
1195
|
+
* - To create a standalone or replica set instance, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
|
|
1146
1196
|
*
|
|
1147
1197
|
* @param request - CreateShardingDBInstanceRequest
|
|
1148
1198
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1282,12 +1332,12 @@ class Client extends openapi_core_1.default {
|
|
|
1282
1332
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.CreateShardingDBInstanceResponse({}));
|
|
1283
1333
|
}
|
|
1284
1334
|
/**
|
|
1285
|
-
* Creates or clones
|
|
1335
|
+
* Creates or clones a MongoDB sharded cluster instance.
|
|
1286
1336
|
*
|
|
1287
1337
|
* @remarks
|
|
1288
|
-
*
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1338
|
+
* - 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.
|
|
1339
|
+
* - For more information about the instance types of ApsaraDB for MongoDB, see [Instance types](https://help.aliyun.com/document_detail/57141.html).
|
|
1340
|
+
* - To create a standalone or replica set instance, you can call the [CreateDBInstance](https://help.aliyun.com/document_detail/61763.html) operation.
|
|
1291
1341
|
*
|
|
1292
1342
|
* @param request - CreateShardingDBInstanceRequest
|
|
1293
1343
|
* @returns CreateShardingDBInstanceResponse
|
|
@@ -1297,7 +1347,11 @@ class Client extends openapi_core_1.default {
|
|
|
1297
1347
|
return await this.createShardingDBInstanceWithOptions(request, runtime);
|
|
1298
1348
|
}
|
|
1299
1349
|
/**
|
|
1300
|
-
* Deletes
|
|
1350
|
+
* Deletes a MongoDB backup set.
|
|
1351
|
+
*
|
|
1352
|
+
* @remarks
|
|
1353
|
+
* You can delete only manual backups.
|
|
1354
|
+
* This operation supports only MongoDB instances that use cloud disks.
|
|
1301
1355
|
*
|
|
1302
1356
|
* @param request - DeleteBackupRequest
|
|
1303
1357
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1341,7 +1395,11 @@ class Client extends openapi_core_1.default {
|
|
|
1341
1395
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteBackupResponse({}));
|
|
1342
1396
|
}
|
|
1343
1397
|
/**
|
|
1344
|
-
* Deletes
|
|
1398
|
+
* Deletes a MongoDB backup set.
|
|
1399
|
+
*
|
|
1400
|
+
* @remarks
|
|
1401
|
+
* You can delete only manual backups.
|
|
1402
|
+
* This operation supports only MongoDB instances that use cloud disks.
|
|
1345
1403
|
*
|
|
1346
1404
|
* @param request - DeleteBackupRequest
|
|
1347
1405
|
* @returns DeleteBackupResponse
|
|
@@ -1351,13 +1409,13 @@ class Client extends openapi_core_1.default {
|
|
|
1351
1409
|
return await this.deleteBackupWithOptions(request, runtime);
|
|
1352
1410
|
}
|
|
1353
1411
|
/**
|
|
1354
|
-
* Releases
|
|
1412
|
+
* Releases a pay-as-you-go MongoDB instance.
|
|
1355
1413
|
*
|
|
1356
1414
|
* @remarks
|
|
1357
|
-
*
|
|
1358
|
-
*
|
|
1359
|
-
*
|
|
1360
|
-
* > After an instance is released,
|
|
1415
|
+
* The instance must meet the following conditions:
|
|
1416
|
+
* - The instance status is running.
|
|
1417
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
1418
|
+
* > After an instance is released, its data cannot be recovered. Proceed with caution.
|
|
1361
1419
|
*
|
|
1362
1420
|
* @param request - DeleteDBInstanceRequest
|
|
1363
1421
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1401,13 +1459,13 @@ class Client extends openapi_core_1.default {
|
|
|
1401
1459
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteDBInstanceResponse({}));
|
|
1402
1460
|
}
|
|
1403
1461
|
/**
|
|
1404
|
-
* Releases
|
|
1462
|
+
* Releases a pay-as-you-go MongoDB instance.
|
|
1405
1463
|
*
|
|
1406
1464
|
* @remarks
|
|
1407
|
-
*
|
|
1408
|
-
*
|
|
1409
|
-
*
|
|
1410
|
-
* > After an instance is released,
|
|
1465
|
+
* The instance must meet the following conditions:
|
|
1466
|
+
* - The instance status is running.
|
|
1467
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
1468
|
+
* > After an instance is released, its data cannot be recovered. Proceed with caution.
|
|
1411
1469
|
*
|
|
1412
1470
|
* @param request - DeleteDBInstanceRequest
|
|
1413
1471
|
* @returns DeleteDBInstanceResponse
|
|
@@ -1417,7 +1475,7 @@ class Client extends openapi_core_1.default {
|
|
|
1417
1475
|
return await this.deleteDBInstanceWithOptions(request, runtime);
|
|
1418
1476
|
}
|
|
1419
1477
|
/**
|
|
1420
|
-
* Deletes a global IP whitelist template.
|
|
1478
|
+
* Deletes a global IP address whitelist template.
|
|
1421
1479
|
*
|
|
1422
1480
|
* @param request - DeleteGlobalSecurityIPGroupRequest
|
|
1423
1481
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1467,7 +1525,7 @@ class Client extends openapi_core_1.default {
|
|
|
1467
1525
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteGlobalSecurityIPGroupResponse({}));
|
|
1468
1526
|
}
|
|
1469
1527
|
/**
|
|
1470
|
-
* Deletes a global IP whitelist template.
|
|
1528
|
+
* Deletes a global IP address whitelist template.
|
|
1471
1529
|
*
|
|
1472
1530
|
* @param request - DeleteGlobalSecurityIPGroupRequest
|
|
1473
1531
|
* @returns DeleteGlobalSecurityIPGroupResponse
|
|
@@ -1481,10 +1539,10 @@ class Client extends openapi_core_1.default {
|
|
|
1481
1539
|
*
|
|
1482
1540
|
* @remarks
|
|
1483
1541
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
1484
|
-
*
|
|
1485
|
-
*
|
|
1486
|
-
*
|
|
1487
|
-
*
|
|
1542
|
+
* - The instance is in the Running state.
|
|
1543
|
+
* - The instance is a sharded cluster instance.
|
|
1544
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
1545
|
+
* - The number of the shard or mongos nodes in the instance is greater than two.
|
|
1488
1546
|
*
|
|
1489
1547
|
* @param request - DeleteNodeRequest
|
|
1490
1548
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1535,10 +1593,10 @@ class Client extends openapi_core_1.default {
|
|
|
1535
1593
|
*
|
|
1536
1594
|
* @remarks
|
|
1537
1595
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
1538
|
-
*
|
|
1539
|
-
*
|
|
1540
|
-
*
|
|
1541
|
-
*
|
|
1596
|
+
* - The instance is in the Running state.
|
|
1597
|
+
* - The instance is a sharded cluster instance.
|
|
1598
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
1599
|
+
* - The number of the shard or mongos nodes in the instance is greater than two.
|
|
1542
1600
|
*
|
|
1543
1601
|
* @param request - DeleteNodeRequest
|
|
1544
1602
|
* @returns DeleteNodeResponse
|
|
@@ -1550,9 +1608,6 @@ class Client extends openapi_core_1.default {
|
|
|
1550
1608
|
/**
|
|
1551
1609
|
* Queries the database accounts of an ApsaraDB for MongoDB instance.
|
|
1552
1610
|
*
|
|
1553
|
-
* @remarks
|
|
1554
|
-
* > This operation can be used to query only the information of the root account.
|
|
1555
|
-
*
|
|
1556
1611
|
* @param request - DescribeAccountsRequest
|
|
1557
1612
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1558
1613
|
* @returns DescribeAccountsResponse
|
|
@@ -1597,9 +1652,6 @@ class Client extends openapi_core_1.default {
|
|
|
1597
1652
|
/**
|
|
1598
1653
|
* Queries the database accounts of an ApsaraDB for MongoDB instance.
|
|
1599
1654
|
*
|
|
1600
|
-
* @remarks
|
|
1601
|
-
* > This operation can be used to query only the information of the root account.
|
|
1602
|
-
*
|
|
1603
1655
|
* @param request - DescribeAccountsRequest
|
|
1604
1656
|
* @returns DescribeAccountsResponse
|
|
1605
1657
|
*/
|
|
@@ -1608,6 +1660,8 @@ class Client extends openapi_core_1.default {
|
|
|
1608
1660
|
return await this.describeAccountsWithOptions(request, runtime);
|
|
1609
1661
|
}
|
|
1610
1662
|
/**
|
|
1663
|
+
* Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
1664
|
+
*
|
|
1611
1665
|
* @param request - DescribeActiveOperationMaintenanceConfigRequest
|
|
1612
1666
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
1613
1667
|
* @returns DescribeActiveOperationMaintenanceConfigResponse
|
|
@@ -1644,6 +1698,8 @@ class Client extends openapi_core_1.default {
|
|
|
1644
1698
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeActiveOperationMaintenanceConfigResponse({}));
|
|
1645
1699
|
}
|
|
1646
1700
|
/**
|
|
1701
|
+
* Queries the Operation and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
1702
|
+
*
|
|
1647
1703
|
* @param request - DescribeActiveOperationMaintenanceConfigRequest
|
|
1648
1704
|
* @returns DescribeActiveOperationMaintenanceConfigResponse
|
|
1649
1705
|
*/
|
|
@@ -1652,7 +1708,7 @@ class Client extends openapi_core_1.default {
|
|
|
1652
1708
|
return await this.describeActiveOperationMaintenanceConfigWithOptions(request, runtime);
|
|
1653
1709
|
}
|
|
1654
1710
|
/**
|
|
1655
|
-
* Queries the detailed information about
|
|
1711
|
+
* Queries the detailed information about tasks of an ApsaraDB for MongoDB instance.
|
|
1656
1712
|
*
|
|
1657
1713
|
* @param request - DescribeActiveOperationTaskRequest
|
|
1658
1714
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1708,7 +1764,7 @@ class Client extends openapi_core_1.default {
|
|
|
1708
1764
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeActiveOperationTaskResponse({}));
|
|
1709
1765
|
}
|
|
1710
1766
|
/**
|
|
1711
|
-
* Queries the detailed information about
|
|
1767
|
+
* Queries the detailed information about tasks of an ApsaraDB for MongoDB instance.
|
|
1712
1768
|
*
|
|
1713
1769
|
* @param request - DescribeActiveOperationTaskRequest
|
|
1714
1770
|
* @returns DescribeActiveOperationTaskResponse
|
|
@@ -1769,7 +1825,7 @@ class Client extends openapi_core_1.default {
|
|
|
1769
1825
|
return await this.describeActiveOperationTaskCountWithOptions(request, runtime);
|
|
1770
1826
|
}
|
|
1771
1827
|
/**
|
|
1772
|
-
*
|
|
1828
|
+
* Queries the types and number of O&M tasks for a MongoDB instance.
|
|
1773
1829
|
*
|
|
1774
1830
|
* @param request - DescribeActiveOperationTaskRegionRequest
|
|
1775
1831
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1813,7 +1869,7 @@ class Client extends openapi_core_1.default {
|
|
|
1813
1869
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeActiveOperationTaskRegionResponse({}));
|
|
1814
1870
|
}
|
|
1815
1871
|
/**
|
|
1816
|
-
*
|
|
1872
|
+
* Queries the types and number of O&M tasks for a MongoDB instance.
|
|
1817
1873
|
*
|
|
1818
1874
|
* @param request - DescribeActiveOperationTaskRegionRequest
|
|
1819
1875
|
* @returns DescribeActiveOperationTaskRegionResponse
|
|
@@ -1883,7 +1939,7 @@ class Client extends openapi_core_1.default {
|
|
|
1883
1939
|
return await this.describeActiveOperationTaskTypeWithOptions(request, runtime);
|
|
1884
1940
|
}
|
|
1885
1941
|
/**
|
|
1886
|
-
* Queries
|
|
1942
|
+
* Queries O&M task details for MongoDB instances.
|
|
1887
1943
|
*
|
|
1888
1944
|
* @param request - DescribeActiveOperationTasksRequest
|
|
1889
1945
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1957,7 +2013,7 @@ class Client extends openapi_core_1.default {
|
|
|
1957
2013
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeActiveOperationTasksResponse({}));
|
|
1958
2014
|
}
|
|
1959
2015
|
/**
|
|
1960
|
-
* Queries
|
|
2016
|
+
* Queries O&M task details for MongoDB instances.
|
|
1961
2017
|
*
|
|
1962
2018
|
* @param request - DescribeActiveOperationTasksRequest
|
|
1963
2019
|
* @returns DescribeActiveOperationTasksResponse
|
|
@@ -1967,12 +2023,12 @@ class Client extends openapi_core_1.default {
|
|
|
1967
2023
|
return await this.describeActiveOperationTasksWithOptions(request, runtime);
|
|
1968
2024
|
}
|
|
1969
2025
|
/**
|
|
1970
|
-
* Queries the
|
|
2026
|
+
* Queries the audit log types collected for a MongoDB instance.
|
|
1971
2027
|
*
|
|
1972
2028
|
* @remarks
|
|
1973
|
-
*
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
2029
|
+
* - The instance must be in the running state when you call this operation.
|
|
2030
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
2031
|
+
* - 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).
|
|
1976
2032
|
*
|
|
1977
2033
|
* @param request - DescribeAuditLogFilterRequest
|
|
1978
2034
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2016,12 +2072,12 @@ class Client extends openapi_core_1.default {
|
|
|
2016
2072
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAuditLogFilterResponse({}));
|
|
2017
2073
|
}
|
|
2018
2074
|
/**
|
|
2019
|
-
* Queries the
|
|
2075
|
+
* Queries the audit log types collected for a MongoDB instance.
|
|
2020
2076
|
*
|
|
2021
2077
|
* @remarks
|
|
2022
|
-
*
|
|
2023
|
-
*
|
|
2024
|
-
*
|
|
2078
|
+
* - The instance must be in the running state when you call this operation.
|
|
2079
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
2080
|
+
* - 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).
|
|
2025
2081
|
*
|
|
2026
2082
|
* @param request - DescribeAuditLogFilterRequest
|
|
2027
2083
|
* @returns DescribeAuditLogFilterResponse
|
|
@@ -2031,12 +2087,12 @@ class Client extends openapi_core_1.default {
|
|
|
2031
2087
|
return await this.describeAuditLogFilterWithOptions(request, runtime);
|
|
2032
2088
|
}
|
|
2033
2089
|
/**
|
|
2034
|
-
*
|
|
2090
|
+
* Checks whether audit logging is enabled for a MongoDB instance.
|
|
2035
2091
|
*
|
|
2036
2092
|
* @remarks
|
|
2037
|
-
*
|
|
2038
|
-
*
|
|
2039
|
-
*
|
|
2093
|
+
* - The instance must be in the running state.
|
|
2094
|
+
* - This operation is available only for **General-purpose Local Disk Edition** and **Dedicated Local Disk Edition** instances.
|
|
2095
|
+
* - 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).
|
|
2040
2096
|
*
|
|
2041
2097
|
* @param request - DescribeAuditPolicyRequest
|
|
2042
2098
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2077,12 +2133,12 @@ class Client extends openapi_core_1.default {
|
|
|
2077
2133
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAuditPolicyResponse({}));
|
|
2078
2134
|
}
|
|
2079
2135
|
/**
|
|
2080
|
-
*
|
|
2136
|
+
* Checks whether audit logging is enabled for a MongoDB instance.
|
|
2081
2137
|
*
|
|
2082
2138
|
* @remarks
|
|
2083
|
-
*
|
|
2084
|
-
*
|
|
2085
|
-
*
|
|
2139
|
+
* - The instance must be in the running state.
|
|
2140
|
+
* - This operation is available only for **General-purpose Local Disk Edition** and **Dedicated Local Disk Edition** instances.
|
|
2141
|
+
* - 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).
|
|
2086
2142
|
*
|
|
2087
2143
|
* @param request - DescribeAuditPolicyRequest
|
|
2088
2144
|
* @returns DescribeAuditPolicyResponse
|
|
@@ -2092,12 +2148,12 @@ class Client extends openapi_core_1.default {
|
|
|
2092
2148
|
return await this.describeAuditPolicyWithOptions(request, runtime);
|
|
2093
2149
|
}
|
|
2094
2150
|
/**
|
|
2095
|
-
* Queries
|
|
2151
|
+
* Queries audit log entries for a MongoDB instance.
|
|
2096
2152
|
*
|
|
2097
2153
|
* @remarks
|
|
2098
|
-
*
|
|
2099
|
-
*
|
|
2100
|
-
*
|
|
2154
|
+
* - When you call this operation, ensure that the audit log feature of the instance is enabled. Otherwise, the operation returns an empty audit log.
|
|
2155
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
2156
|
+
* - 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).
|
|
2101
2157
|
*
|
|
2102
2158
|
* @param request - DescribeAuditRecordsRequest
|
|
2103
2159
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2171,12 +2227,12 @@ class Client extends openapi_core_1.default {
|
|
|
2171
2227
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeAuditRecordsResponse({}));
|
|
2172
2228
|
}
|
|
2173
2229
|
/**
|
|
2174
|
-
* Queries
|
|
2230
|
+
* Queries audit log entries for a MongoDB instance.
|
|
2175
2231
|
*
|
|
2176
2232
|
* @remarks
|
|
2177
|
-
*
|
|
2178
|
-
*
|
|
2179
|
-
*
|
|
2233
|
+
* - When you call this operation, ensure that the audit log feature of the instance is enabled. Otherwise, the operation returns an empty audit log.
|
|
2234
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
2235
|
+
* - 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).
|
|
2180
2236
|
*
|
|
2181
2237
|
* @param request - DescribeAuditRecordsRequest
|
|
2182
2238
|
* @returns DescribeAuditRecordsResponse
|
|
@@ -2416,11 +2472,11 @@ class Client extends openapi_core_1.default {
|
|
|
2416
2472
|
* @remarks
|
|
2417
2473
|
* 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).
|
|
2418
2474
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
2419
|
-
*
|
|
2420
|
-
*
|
|
2421
|
-
*
|
|
2422
|
-
*
|
|
2423
|
-
*
|
|
2475
|
+
* - The instance was created after March 26, 2019.
|
|
2476
|
+
* - 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.
|
|
2477
|
+
* - The instance is a replica set instance.
|
|
2478
|
+
* - The instance runs MongoDB 3.4, MongoDB 4.0, or MongoDB 4.2. In addition, the instance uses local disks to store data.
|
|
2479
|
+
* - The storage engine of the instance is WiredTiger.
|
|
2424
2480
|
*
|
|
2425
2481
|
* @param request - DescribeBackupDBsRequest
|
|
2426
2482
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2484,11 +2540,11 @@ class Client extends openapi_core_1.default {
|
|
|
2484
2540
|
* @remarks
|
|
2485
2541
|
* 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).
|
|
2486
2542
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
2487
|
-
*
|
|
2488
|
-
*
|
|
2489
|
-
*
|
|
2490
|
-
*
|
|
2491
|
-
*
|
|
2543
|
+
* - The instance was created after March 26, 2019.
|
|
2544
|
+
* - 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.
|
|
2545
|
+
* - The instance is a replica set instance.
|
|
2546
|
+
* - The instance runs MongoDB 3.4, MongoDB 4.0, or MongoDB 4.2. In addition, the instance uses local disks to store data.
|
|
2547
|
+
* - The storage engine of the instance is WiredTiger.
|
|
2492
2548
|
*
|
|
2493
2549
|
* @param request - DescribeBackupDBsRequest
|
|
2494
2550
|
* @returns DescribeBackupDBsResponse
|
|
@@ -2498,7 +2554,7 @@ class Client extends openapi_core_1.default {
|
|
|
2498
2554
|
return await this.describeBackupDBsWithOptions(request, runtime);
|
|
2499
2555
|
}
|
|
2500
2556
|
/**
|
|
2501
|
-
* Queries the backup policy of
|
|
2557
|
+
* Queries the backup policy of a MongoDB instance.
|
|
2502
2558
|
*
|
|
2503
2559
|
* @param request - DescribeBackupPolicyRequest
|
|
2504
2560
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2548,7 +2604,7 @@ class Client extends openapi_core_1.default {
|
|
|
2548
2604
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBackupPolicyResponse({}));
|
|
2549
2605
|
}
|
|
2550
2606
|
/**
|
|
2551
|
-
* Queries the backup policy of
|
|
2607
|
+
* Queries the backup policy of a MongoDB instance.
|
|
2552
2608
|
*
|
|
2553
2609
|
* @param request - DescribeBackupPolicyRequest
|
|
2554
2610
|
* @returns DescribeBackupPolicyResponse
|
|
@@ -2558,7 +2614,10 @@ class Client extends openapi_core_1.default {
|
|
|
2558
2614
|
return await this.describeBackupPolicyWithOptions(request, runtime);
|
|
2559
2615
|
}
|
|
2560
2616
|
/**
|
|
2561
|
-
* Queries the backup
|
|
2617
|
+
* Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks.
|
|
2618
|
+
*
|
|
2619
|
+
* @remarks
|
|
2620
|
+
* 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.
|
|
2562
2621
|
*
|
|
2563
2622
|
* @param request - DescribeBackupStorageRequest
|
|
2564
2623
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2605,7 +2664,10 @@ class Client extends openapi_core_1.default {
|
|
|
2605
2664
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBackupStorageResponse({}));
|
|
2606
2665
|
}
|
|
2607
2666
|
/**
|
|
2608
|
-
* Queries the backup
|
|
2667
|
+
* Queries the backup usage for a MongoDB replica set or sharded cluster instance that uses cloud disks.
|
|
2668
|
+
*
|
|
2669
|
+
* @remarks
|
|
2670
|
+
* 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.
|
|
2609
2671
|
*
|
|
2610
2672
|
* @param request - DescribeBackupStorageRequest
|
|
2611
2673
|
* @returns DescribeBackupStorageResponse
|
|
@@ -2615,7 +2677,7 @@ class Client extends openapi_core_1.default {
|
|
|
2615
2677
|
return await this.describeBackupStorageWithOptions(request, runtime);
|
|
2616
2678
|
}
|
|
2617
2679
|
/**
|
|
2618
|
-
* Queries backup
|
|
2680
|
+
* Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks.
|
|
2619
2681
|
*
|
|
2620
2682
|
* @param request - DescribeBackupTasksRequest
|
|
2621
2683
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2662,7 +2724,7 @@ class Client extends openapi_core_1.default {
|
|
|
2662
2724
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBackupTasksResponse({}));
|
|
2663
2725
|
}
|
|
2664
2726
|
/**
|
|
2665
|
-
* Queries backup
|
|
2727
|
+
* Queries ongoing backup jobs for MongoDB ReplicaSet or sharded cluster instances that use cloud disks.
|
|
2666
2728
|
*
|
|
2667
2729
|
* @param request - DescribeBackupTasksRequest
|
|
2668
2730
|
* @returns DescribeBackupTasksResponse
|
|
@@ -2672,7 +2734,7 @@ class Client extends openapi_core_1.default {
|
|
|
2672
2734
|
return await this.describeBackupTasksWithOptions(request, runtime);
|
|
2673
2735
|
}
|
|
2674
2736
|
/**
|
|
2675
|
-
* Queries the
|
|
2737
|
+
* Queries the backups of a MongoDB instance.
|
|
2676
2738
|
*
|
|
2677
2739
|
* @param request - DescribeBackupsRequest
|
|
2678
2740
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2743,7 +2805,7 @@ class Client extends openapi_core_1.default {
|
|
|
2743
2805
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBackupsResponse({}));
|
|
2744
2806
|
}
|
|
2745
2807
|
/**
|
|
2746
|
-
* Queries the
|
|
2808
|
+
* Queries the backups of a MongoDB instance.
|
|
2747
2809
|
*
|
|
2748
2810
|
* @param request - DescribeBackupsRequest
|
|
2749
2811
|
* @returns DescribeBackupsResponse
|
|
@@ -2753,7 +2815,7 @@ class Client extends openapi_core_1.default {
|
|
|
2753
2815
|
return await this.describeBackupsWithOptions(request, runtime);
|
|
2754
2816
|
}
|
|
2755
2817
|
/**
|
|
2756
|
-
*
|
|
2818
|
+
* Query log backup files for an ApsaraDB for MongoDB instance.
|
|
2757
2819
|
*
|
|
2758
2820
|
* @param request - DescribeBinlogFilesRequest
|
|
2759
2821
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2824,7 +2886,7 @@ class Client extends openapi_core_1.default {
|
|
|
2824
2886
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeBinlogFilesResponse({}));
|
|
2825
2887
|
}
|
|
2826
2888
|
/**
|
|
2827
|
-
*
|
|
2889
|
+
* Query log backup files for an ApsaraDB for MongoDB instance.
|
|
2828
2890
|
*
|
|
2829
2891
|
* @param request - DescribeBinlogFilesRequest
|
|
2830
2892
|
* @returns DescribeBinlogFilesResponse
|
|
@@ -2834,11 +2896,11 @@ class Client extends openapi_core_1.default {
|
|
|
2834
2896
|
return await this.describeBinlogFilesWithOptions(request, runtime);
|
|
2835
2897
|
}
|
|
2836
2898
|
/**
|
|
2837
|
-
* Queries the backup sets
|
|
2899
|
+
* Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
2838
2900
|
*
|
|
2839
2901
|
* @remarks
|
|
2840
|
-
* For
|
|
2841
|
-
*
|
|
2902
|
+
* 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.
|
|
2903
|
+
* Sharded cluster instances that use cloud disks and were created after October 19, 2023 use cluster backups by default.
|
|
2842
2904
|
*
|
|
2843
2905
|
* @param request - DescribeClusterBackupsRequest
|
|
2844
2906
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2909,11 +2971,11 @@ class Client extends openapi_core_1.default {
|
|
|
2909
2971
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeClusterBackupsResponse({}));
|
|
2910
2972
|
}
|
|
2911
2973
|
/**
|
|
2912
|
-
* Queries the backup sets
|
|
2974
|
+
* Queries the cluster backup sets for an ApsaraDB for MongoDB sharded cluster instance that uses cloud disks.
|
|
2913
2975
|
*
|
|
2914
2976
|
* @remarks
|
|
2915
|
-
* For
|
|
2916
|
-
*
|
|
2977
|
+
* 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.
|
|
2978
|
+
* Sharded cluster instances that use cloud disks and were created after October 19, 2023 use cluster backups by default.
|
|
2917
2979
|
*
|
|
2918
2980
|
* @param request - DescribeClusterBackupsRequest
|
|
2919
2981
|
* @returns DescribeClusterBackupsResponse
|
|
@@ -2923,11 +2985,11 @@ class Client extends openapi_core_1.default {
|
|
|
2923
2985
|
return await this.describeClusterBackupsWithOptions(request, runtime);
|
|
2924
2986
|
}
|
|
2925
2987
|
/**
|
|
2926
|
-
* Queries the time range
|
|
2988
|
+
* Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB.
|
|
2927
2989
|
*
|
|
2928
2990
|
* @remarks
|
|
2929
|
-
*
|
|
2930
|
-
*
|
|
2991
|
+
* - 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.
|
|
2992
|
+
* - 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.
|
|
2931
2993
|
*
|
|
2932
2994
|
* @param request - DescribeClusterRecoverTimeRequest
|
|
2933
2995
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2942,6 +3004,9 @@ class Client extends openapi_core_1.default {
|
|
|
2942
3004
|
if (!$dara.isNull(request.destRegion)) {
|
|
2943
3005
|
query["DestRegion"] = request.destRegion;
|
|
2944
3006
|
}
|
|
3007
|
+
if (!$dara.isNull(request.onlyDbTableRecovery)) {
|
|
3008
|
+
query["OnlyDbTableRecovery"] = request.onlyDbTableRecovery;
|
|
3009
|
+
}
|
|
2945
3010
|
if (!$dara.isNull(request.ownerAccount)) {
|
|
2946
3011
|
query["OwnerAccount"] = request.ownerAccount;
|
|
2947
3012
|
}
|
|
@@ -2977,11 +3042,11 @@ class Client extends openapi_core_1.default {
|
|
|
2977
3042
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeClusterRecoverTimeResponse({}));
|
|
2978
3043
|
}
|
|
2979
3044
|
/**
|
|
2980
|
-
* Queries the time range
|
|
3045
|
+
* Queries the restorable time range of a sharded cluster instance that uses cloud disks in ApsaraDB for MongoDB.
|
|
2981
3046
|
*
|
|
2982
3047
|
* @remarks
|
|
2983
|
-
*
|
|
2984
|
-
*
|
|
3048
|
+
* - 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.
|
|
3049
|
+
* - 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.
|
|
2985
3050
|
*
|
|
2986
3051
|
* @param request - DescribeClusterRecoverTimeRequest
|
|
2987
3052
|
* @returns DescribeClusterRecoverTimeResponse
|
|
@@ -2991,7 +3056,7 @@ class Client extends openapi_core_1.default {
|
|
|
2991
3056
|
return await this.describeClusterRecoverTimeWithOptions(request, runtime);
|
|
2992
3057
|
}
|
|
2993
3058
|
/**
|
|
2994
|
-
* Queries
|
|
3059
|
+
* Queries information about an ApsaraDB for MongoDB instance.
|
|
2995
3060
|
*
|
|
2996
3061
|
* @param request - DescribeDBInstanceAttributeRequest
|
|
2997
3062
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3044,7 +3109,7 @@ class Client extends openapi_core_1.default {
|
|
|
3044
3109
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBInstanceAttributeResponse({}));
|
|
3045
3110
|
}
|
|
3046
3111
|
/**
|
|
3047
|
-
* Queries
|
|
3112
|
+
* Queries information about an ApsaraDB for MongoDB instance.
|
|
3048
3113
|
*
|
|
3049
3114
|
* @param request - DescribeDBInstanceAttributeRequest
|
|
3050
3115
|
* @returns DescribeDBInstanceAttributeResponse
|
|
@@ -3054,7 +3119,7 @@ class Client extends openapi_core_1.default {
|
|
|
3054
3119
|
return await this.describeDBInstanceAttributeWithOptions(request, runtime);
|
|
3055
3120
|
}
|
|
3056
3121
|
/**
|
|
3057
|
-
* Queries the
|
|
3122
|
+
* Queries the encryption key of a MongoDB instance.
|
|
3058
3123
|
*
|
|
3059
3124
|
* @remarks
|
|
3060
3125
|
* 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.
|
|
@@ -3101,7 +3166,7 @@ class Client extends openapi_core_1.default {
|
|
|
3101
3166
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBInstanceEncryptionKeyResponse({}));
|
|
3102
3167
|
}
|
|
3103
3168
|
/**
|
|
3104
|
-
* Queries the
|
|
3169
|
+
* Queries the encryption key of a MongoDB instance.
|
|
3105
3170
|
*
|
|
3106
3171
|
* @remarks
|
|
3107
3172
|
* 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.
|
|
@@ -3165,7 +3230,7 @@ class Client extends openapi_core_1.default {
|
|
|
3165
3230
|
return await this.describeDBInstanceMonitorWithOptions(request, runtime);
|
|
3166
3231
|
}
|
|
3167
3232
|
/**
|
|
3168
|
-
* Queries the performance data of
|
|
3233
|
+
* Queries the performance data of a MongoDB instance.
|
|
3169
3234
|
*
|
|
3170
3235
|
* @param request - DescribeDBInstancePerformanceRequest
|
|
3171
3236
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3230,7 +3295,7 @@ class Client extends openapi_core_1.default {
|
|
|
3230
3295
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBInstancePerformanceResponse({}));
|
|
3231
3296
|
}
|
|
3232
3297
|
/**
|
|
3233
|
-
* Queries the performance data of
|
|
3298
|
+
* Queries the performance data of a MongoDB instance.
|
|
3234
3299
|
*
|
|
3235
3300
|
* @param request - DescribeDBInstancePerformanceRequest
|
|
3236
3301
|
* @returns DescribeDBInstancePerformanceResponse
|
|
@@ -3240,13 +3305,14 @@ class Client extends openapi_core_1.default {
|
|
|
3240
3305
|
return await this.describeDBInstancePerformanceWithOptions(request, runtime);
|
|
3241
3306
|
}
|
|
3242
3307
|
/**
|
|
3243
|
-
*
|
|
3308
|
+
* Query SSL configuration details for a MongoDB instance.
|
|
3244
3309
|
*
|
|
3245
3310
|
* @remarks
|
|
3246
|
-
*
|
|
3247
|
-
*
|
|
3248
|
-
*
|
|
3249
|
-
*
|
|
3311
|
+
* To use this operation, the instance must meet the following requirements:
|
|
3312
|
+
* - The instance status is Running.
|
|
3313
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
3314
|
+
* - The replica set instance must be version 3.4 or later.
|
|
3315
|
+
* - The sharded cluster instance must use Enhanced SSDs (ESSDs).
|
|
3250
3316
|
*
|
|
3251
3317
|
* @param request - DescribeDBInstanceSSLRequest
|
|
3252
3318
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3287,13 +3353,14 @@ class Client extends openapi_core_1.default {
|
|
|
3287
3353
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBInstanceSSLResponse({}));
|
|
3288
3354
|
}
|
|
3289
3355
|
/**
|
|
3290
|
-
*
|
|
3356
|
+
* Query SSL configuration details for a MongoDB instance.
|
|
3291
3357
|
*
|
|
3292
3358
|
* @remarks
|
|
3293
|
-
*
|
|
3294
|
-
*
|
|
3295
|
-
*
|
|
3296
|
-
*
|
|
3359
|
+
* To use this operation, the instance must meet the following requirements:
|
|
3360
|
+
* - The instance status is Running.
|
|
3361
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
3362
|
+
* - The replica set instance must be version 3.4 or later.
|
|
3363
|
+
* - The sharded cluster instance must use Enhanced SSDs (ESSDs).
|
|
3297
3364
|
*
|
|
3298
3365
|
* @param request - DescribeDBInstanceSSLRequest
|
|
3299
3366
|
* @returns DescribeDBInstanceSSLResponse
|
|
@@ -3303,7 +3370,7 @@ class Client extends openapi_core_1.default {
|
|
|
3303
3370
|
return await this.describeDBInstanceSSLWithOptions(request, runtime);
|
|
3304
3371
|
}
|
|
3305
3372
|
/**
|
|
3306
|
-
*
|
|
3373
|
+
* Gets instance type details.
|
|
3307
3374
|
*
|
|
3308
3375
|
* @param request - DescribeDBInstanceSpecInfoRequest
|
|
3309
3376
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3347,7 +3414,7 @@ class Client extends openapi_core_1.default {
|
|
|
3347
3414
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBInstanceSpecInfoResponse({}));
|
|
3348
3415
|
}
|
|
3349
3416
|
/**
|
|
3350
|
-
*
|
|
3417
|
+
* Gets instance type details.
|
|
3351
3418
|
*
|
|
3352
3419
|
* @param request - DescribeDBInstanceSpecInfoRequest
|
|
3353
3420
|
* @returns DescribeDBInstanceSpecInfoResponse
|
|
@@ -3361,8 +3428,8 @@ class Client extends openapi_core_1.default {
|
|
|
3361
3428
|
*
|
|
3362
3429
|
* @remarks
|
|
3363
3430
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
3364
|
-
*
|
|
3365
|
-
*
|
|
3431
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
3432
|
+
* - The instance uses local physical disks to store data.
|
|
3366
3433
|
*
|
|
3367
3434
|
* @param request - DescribeDBInstanceSwitchLogRequest
|
|
3368
3435
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3410,8 +3477,8 @@ class Client extends openapi_core_1.default {
|
|
|
3410
3477
|
*
|
|
3411
3478
|
* @remarks
|
|
3412
3479
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
3413
|
-
*
|
|
3414
|
-
*
|
|
3480
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
3481
|
+
* - The instance uses local physical disks to store data.
|
|
3415
3482
|
*
|
|
3416
3483
|
* @param request - DescribeDBInstanceSwitchLogRequest
|
|
3417
3484
|
* @returns DescribeDBInstanceSwitchLogResponse
|
|
@@ -3424,11 +3491,11 @@ class Client extends openapi_core_1.default {
|
|
|
3424
3491
|
* Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.
|
|
3425
3492
|
*
|
|
3426
3493
|
* @remarks
|
|
3427
|
-
* >
|
|
3428
|
-
*
|
|
3429
|
-
*
|
|
3430
|
-
*
|
|
3431
|
-
*
|
|
3494
|
+
* > For more information about this feature, see [Settings for transparent data encryption TDE](https://help.aliyun.com/document_detail/131048.html).
|
|
3495
|
+
* When you invoke this operation, the instance must meet the following conditions:
|
|
3496
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
3497
|
+
* - The storage DPI engine of the instance is WiredTiger.
|
|
3498
|
+
* - 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.
|
|
3432
3499
|
*
|
|
3433
3500
|
* @param request - DescribeDBInstanceTDEInfoRequest
|
|
3434
3501
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3472,11 +3539,11 @@ class Client extends openapi_core_1.default {
|
|
|
3472
3539
|
* Queries whether Transparent Data Encryption (TDE) is enabled for an ApsaraDB for MongoDB instance.
|
|
3473
3540
|
*
|
|
3474
3541
|
* @remarks
|
|
3475
|
-
* >
|
|
3476
|
-
*
|
|
3477
|
-
*
|
|
3478
|
-
*
|
|
3479
|
-
*
|
|
3542
|
+
* > For more information about this feature, see [Settings for transparent data encryption TDE](https://help.aliyun.com/document_detail/131048.html).
|
|
3543
|
+
* When you invoke this operation, the instance must meet the following conditions:
|
|
3544
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
3545
|
+
* - The storage DPI engine of the instance is WiredTiger.
|
|
3546
|
+
* - 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.
|
|
3480
3547
|
*
|
|
3481
3548
|
* @param request - DescribeDBInstanceTDEInfoRequest
|
|
3482
3549
|
* @returns DescribeDBInstanceTDEInfoResponse
|
|
@@ -3486,10 +3553,11 @@ class Client extends openapi_core_1.default {
|
|
|
3486
3553
|
return await this.describeDBInstanceTDEInfoWithOptions(request, runtime);
|
|
3487
3554
|
}
|
|
3488
3555
|
/**
|
|
3489
|
-
* Queries a list of
|
|
3556
|
+
* Queries a list of MongoDB instances.
|
|
3490
3557
|
*
|
|
3491
3558
|
* @remarks
|
|
3492
|
-
*
|
|
3559
|
+
* <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**.
|
|
3560
|
+
* <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**.
|
|
3493
3561
|
*
|
|
3494
3562
|
* @param request - DescribeDBInstancesRequest
|
|
3495
3563
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3593,10 +3661,11 @@ class Client extends openapi_core_1.default {
|
|
|
3593
3661
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBInstancesResponse({}));
|
|
3594
3662
|
}
|
|
3595
3663
|
/**
|
|
3596
|
-
* Queries a list of
|
|
3664
|
+
* Queries a list of MongoDB instances.
|
|
3597
3665
|
*
|
|
3598
3666
|
* @remarks
|
|
3599
|
-
*
|
|
3667
|
+
* <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**.
|
|
3668
|
+
* <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**.
|
|
3600
3669
|
*
|
|
3601
3670
|
* @param request - DescribeDBInstancesRequest
|
|
3602
3671
|
* @returns DescribeDBInstancesResponse
|
|
@@ -3606,11 +3675,11 @@ class Client extends openapi_core_1.default {
|
|
|
3606
3675
|
return await this.describeDBInstancesWithOptions(request, runtime);
|
|
3607
3676
|
}
|
|
3608
3677
|
/**
|
|
3609
|
-
* Queries the overview
|
|
3678
|
+
* Queries the overview of one or more ApsaraDB for MongoDB instances.
|
|
3610
3679
|
*
|
|
3611
3680
|
* @remarks
|
|
3612
|
-
*
|
|
3613
|
-
*
|
|
3681
|
+
* - 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.
|
|
3682
|
+
* - The results of this operation are not paginated.
|
|
3614
3683
|
*
|
|
3615
3684
|
* @param request - DescribeDBInstancesOverviewRequest
|
|
3616
3685
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3687,11 +3756,11 @@ class Client extends openapi_core_1.default {
|
|
|
3687
3756
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeDBInstancesOverviewResponse({}));
|
|
3688
3757
|
}
|
|
3689
3758
|
/**
|
|
3690
|
-
* Queries the overview
|
|
3759
|
+
* Queries the overview of one or more ApsaraDB for MongoDB instances.
|
|
3691
3760
|
*
|
|
3692
3761
|
* @remarks
|
|
3693
|
-
*
|
|
3694
|
-
*
|
|
3762
|
+
* - 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.
|
|
3763
|
+
* - The results of this operation are not paginated.
|
|
3695
3764
|
*
|
|
3696
3765
|
* @param request - DescribeDBInstancesOverviewRequest
|
|
3697
3766
|
* @returns DescribeDBInstancesOverviewResponse
|
|
@@ -3701,11 +3770,11 @@ class Client extends openapi_core_1.default {
|
|
|
3701
3770
|
return await this.describeDBInstancesOverviewWithOptions(request, runtime);
|
|
3702
3771
|
}
|
|
3703
3772
|
/**
|
|
3704
|
-
* Queries
|
|
3773
|
+
* Queries error log entries for a MongoDB instance.
|
|
3705
3774
|
*
|
|
3706
3775
|
* @remarks
|
|
3707
|
-
*
|
|
3708
|
-
*
|
|
3776
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
3777
|
+
* - 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).
|
|
3709
3778
|
*
|
|
3710
3779
|
* @param request - DescribeErrorLogRecordsRequest
|
|
3711
3780
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3776,11 +3845,11 @@ class Client extends openapi_core_1.default {
|
|
|
3776
3845
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeErrorLogRecordsResponse({}));
|
|
3777
3846
|
}
|
|
3778
3847
|
/**
|
|
3779
|
-
* Queries
|
|
3848
|
+
* Queries error log entries for a MongoDB instance.
|
|
3780
3849
|
*
|
|
3781
3850
|
* @remarks
|
|
3782
|
-
*
|
|
3783
|
-
*
|
|
3851
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
3852
|
+
* - 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).
|
|
3784
3853
|
*
|
|
3785
3854
|
* @param request - DescribeErrorLogRecordsRequest
|
|
3786
3855
|
* @returns DescribeErrorLogRecordsResponse
|
|
@@ -3826,7 +3895,7 @@ class Client extends openapi_core_1.default {
|
|
|
3826
3895
|
return await this.describeGlobalSecurityIPGroupWithOptions(request, runtime);
|
|
3827
3896
|
}
|
|
3828
3897
|
/**
|
|
3829
|
-
* Queries the
|
|
3898
|
+
* Queries the mapping between an instance and a global IP address whitelist template.
|
|
3830
3899
|
*
|
|
3831
3900
|
* @param request - DescribeGlobalSecurityIPGroupRelationRequest
|
|
3832
3901
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3870,7 +3939,7 @@ class Client extends openapi_core_1.default {
|
|
|
3870
3939
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeGlobalSecurityIPGroupRelationResponse({}));
|
|
3871
3940
|
}
|
|
3872
3941
|
/**
|
|
3873
|
-
* Queries the
|
|
3942
|
+
* Queries the mapping between an instance and a global IP address whitelist template.
|
|
3874
3943
|
*
|
|
3875
3944
|
* @param request - DescribeGlobalSecurityIPGroupRelationRequest
|
|
3876
3945
|
* @returns DescribeGlobalSecurityIPGroupRelationResponse
|
|
@@ -4033,7 +4102,7 @@ class Client extends openapi_core_1.default {
|
|
|
4033
4102
|
return await this.describeHistoryTasksStatWithOptions(request, runtime);
|
|
4034
4103
|
}
|
|
4035
4104
|
/**
|
|
4036
|
-
*
|
|
4105
|
+
* Queries the auto-renewal status of MongoDB instances.
|
|
4037
4106
|
*
|
|
4038
4107
|
* @remarks
|
|
4039
4108
|
* This operation is applicable to subscription instances.
|
|
@@ -4089,7 +4158,7 @@ class Client extends openapi_core_1.default {
|
|
|
4089
4158
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeInstanceAutoRenewalAttributeResponse({}));
|
|
4090
4159
|
}
|
|
4091
4160
|
/**
|
|
4092
|
-
*
|
|
4161
|
+
* Queries the auto-renewal status of MongoDB instances.
|
|
4093
4162
|
*
|
|
4094
4163
|
* @remarks
|
|
4095
4164
|
* This operation is applicable to subscription instances.
|
|
@@ -4102,7 +4171,7 @@ class Client extends openapi_core_1.default {
|
|
|
4102
4171
|
return await this.describeInstanceAutoRenewalAttributeWithOptions(request, runtime);
|
|
4103
4172
|
}
|
|
4104
4173
|
/**
|
|
4105
|
-
* Queries the time
|
|
4174
|
+
* Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks.
|
|
4106
4175
|
*
|
|
4107
4176
|
* @param request - DescribeInstanceRecoverTimeRequest
|
|
4108
4177
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4117,6 +4186,9 @@ class Client extends openapi_core_1.default {
|
|
|
4117
4186
|
if (!$dara.isNull(request.destRegion)) {
|
|
4118
4187
|
query["DestRegion"] = request.destRegion;
|
|
4119
4188
|
}
|
|
4189
|
+
if (!$dara.isNull(request.onlyDbTableRecovery)) {
|
|
4190
|
+
query["OnlyDbTableRecovery"] = request.onlyDbTableRecovery;
|
|
4191
|
+
}
|
|
4120
4192
|
if (!$dara.isNull(request.ownerAccount)) {
|
|
4121
4193
|
query["OwnerAccount"] = request.ownerAccount;
|
|
4122
4194
|
}
|
|
@@ -4155,7 +4227,7 @@ class Client extends openapi_core_1.default {
|
|
|
4155
4227
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeInstanceRecoverTimeResponse({}));
|
|
4156
4228
|
}
|
|
4157
4229
|
/**
|
|
4158
|
-
* Queries the time
|
|
4230
|
+
* Queries the restorable time ranges of an ApsaraDB for MongoDB replica set instance with cloud disks.
|
|
4159
4231
|
*
|
|
4160
4232
|
* @param request - DescribeInstanceRecoverTimeRequest
|
|
4161
4233
|
* @returns DescribeInstanceRecoverTimeResponse
|
|
@@ -4270,13 +4342,13 @@ class Client extends openapi_core_1.default {
|
|
|
4270
4342
|
return await this.describeKmsKeysWithOptions(request, runtime);
|
|
4271
4343
|
}
|
|
4272
4344
|
/**
|
|
4273
|
-
*
|
|
4345
|
+
* You can view the configuration of MongoDB Log Service.
|
|
4274
4346
|
*
|
|
4275
4347
|
* @remarks
|
|
4276
|
-
* This
|
|
4277
|
-
*
|
|
4278
|
-
*
|
|
4279
|
-
*
|
|
4348
|
+
* This API applies to General-purpose and Dedicated instances that use local disks.
|
|
4349
|
+
* 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).
|
|
4350
|
+
* - 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~~).
|
|
4351
|
+
* - 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).
|
|
4280
4352
|
*
|
|
4281
4353
|
* @param request - DescribeMongoDBLogConfigRequest
|
|
4282
4354
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4317,13 +4389,13 @@ class Client extends openapi_core_1.default {
|
|
|
4317
4389
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeMongoDBLogConfigResponse({}));
|
|
4318
4390
|
}
|
|
4319
4391
|
/**
|
|
4320
|
-
*
|
|
4392
|
+
* You can view the configuration of MongoDB Log Service.
|
|
4321
4393
|
*
|
|
4322
4394
|
* @remarks
|
|
4323
|
-
* This
|
|
4324
|
-
*
|
|
4325
|
-
*
|
|
4326
|
-
*
|
|
4395
|
+
* This API applies to General-purpose and Dedicated instances that use local disks.
|
|
4396
|
+
* 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).
|
|
4397
|
+
* - 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~~).
|
|
4398
|
+
* - 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).
|
|
4327
4399
|
*
|
|
4328
4400
|
* @param request - DescribeMongoDBLogConfigRequest
|
|
4329
4401
|
* @returns DescribeMongoDBLogConfigResponse
|
|
@@ -4396,7 +4468,7 @@ class Client extends openapi_core_1.default {
|
|
|
4396
4468
|
return await this.describeParameterModificationHistoryWithOptions(request, runtime);
|
|
4397
4469
|
}
|
|
4398
4470
|
/**
|
|
4399
|
-
* Queries the
|
|
4471
|
+
* Queries the default parameter templates for MongoDB instances.
|
|
4400
4472
|
*
|
|
4401
4473
|
* @param request - DescribeParameterTemplatesRequest
|
|
4402
4474
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4446,7 +4518,7 @@ class Client extends openapi_core_1.default {
|
|
|
4446
4518
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeParameterTemplatesResponse({}));
|
|
4447
4519
|
}
|
|
4448
4520
|
/**
|
|
4449
|
-
* Queries the
|
|
4521
|
+
* Queries the default parameter templates for MongoDB instances.
|
|
4450
4522
|
*
|
|
4451
4523
|
* @param request - DescribeParameterTemplatesRequest
|
|
4452
4524
|
* @returns DescribeParameterTemplatesResponse
|
|
@@ -4516,7 +4588,7 @@ class Client extends openapi_core_1.default {
|
|
|
4516
4588
|
return await this.describeParametersWithOptions(request, runtime);
|
|
4517
4589
|
}
|
|
4518
4590
|
/**
|
|
4519
|
-
*
|
|
4591
|
+
* Query prices.
|
|
4520
4592
|
*
|
|
4521
4593
|
* @param request - DescribePriceRequest
|
|
4522
4594
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4581,7 +4653,7 @@ class Client extends openapi_core_1.default {
|
|
|
4581
4653
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePriceResponse({}));
|
|
4582
4654
|
}
|
|
4583
4655
|
/**
|
|
4584
|
-
*
|
|
4656
|
+
* Query prices.
|
|
4585
4657
|
*
|
|
4586
4658
|
* @param request - DescribePriceRequest
|
|
4587
4659
|
* @returns DescribePriceResponse
|
|
@@ -4591,6 +4663,11 @@ class Client extends openapi_core_1.default {
|
|
|
4591
4663
|
return await this.describePriceWithOptions(request, runtime);
|
|
4592
4664
|
}
|
|
4593
4665
|
/**
|
|
4666
|
+
* Retrieves a list of vSwitches.
|
|
4667
|
+
*
|
|
4668
|
+
* @remarks
|
|
4669
|
+
* 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.
|
|
4670
|
+
*
|
|
4594
4671
|
* @param request - DescribeRdsVSwitchsRequest
|
|
4595
4672
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
4596
4673
|
* @returns DescribeRdsVSwitchsResponse
|
|
@@ -4636,6 +4713,11 @@ class Client extends openapi_core_1.default {
|
|
|
4636
4713
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeRdsVSwitchsResponse({}));
|
|
4637
4714
|
}
|
|
4638
4715
|
/**
|
|
4716
|
+
* Retrieves a list of vSwitches.
|
|
4717
|
+
*
|
|
4718
|
+
* @remarks
|
|
4719
|
+
* 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.
|
|
4720
|
+
*
|
|
4639
4721
|
* @param request - DescribeRdsVSwitchsRequest
|
|
4640
4722
|
* @returns DescribeRdsVSwitchsResponse
|
|
4641
4723
|
*/
|
|
@@ -4644,6 +4726,11 @@ class Client extends openapi_core_1.default {
|
|
|
4644
4726
|
return await this.describeRdsVSwitchsWithOptions(request, runtime);
|
|
4645
4727
|
}
|
|
4646
4728
|
/**
|
|
4729
|
+
* Retrieves a list of VPCs.
|
|
4730
|
+
*
|
|
4731
|
+
* @remarks
|
|
4732
|
+
* Queries available VPCs in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a VPC.
|
|
4733
|
+
*
|
|
4647
4734
|
* @param request - DescribeRdsVpcsRequest
|
|
4648
4735
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
4649
4736
|
* @returns DescribeRdsVpcsResponse
|
|
@@ -4686,6 +4773,11 @@ class Client extends openapi_core_1.default {
|
|
|
4686
4773
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeRdsVpcsResponse({}));
|
|
4687
4774
|
}
|
|
4688
4775
|
/**
|
|
4776
|
+
* Retrieves a list of VPCs.
|
|
4777
|
+
*
|
|
4778
|
+
* @remarks
|
|
4779
|
+
* Queries available VPCs in a specified region and zone. Use this before creating an ApsaraDB for MongoDB instance to select a VPC.
|
|
4780
|
+
*
|
|
4689
4781
|
* @param request - DescribeRdsVpcsRequest
|
|
4690
4782
|
* @returns DescribeRdsVpcsResponse
|
|
4691
4783
|
*/
|
|
@@ -4697,7 +4789,7 @@ class Client extends openapi_core_1.default {
|
|
|
4697
4789
|
* Queries all regions and zones supported for an ApsaraDB for MongoDB instance.
|
|
4698
4790
|
*
|
|
4699
4791
|
* @remarks
|
|
4700
|
-
* >
|
|
4792
|
+
* > 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.
|
|
4701
4793
|
*
|
|
4702
4794
|
* @param request - DescribeRegionsRequest
|
|
4703
4795
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4744,7 +4836,7 @@ class Client extends openapi_core_1.default {
|
|
|
4744
4836
|
* Queries all regions and zones supported for an ApsaraDB for MongoDB instance.
|
|
4745
4837
|
*
|
|
4746
4838
|
* @remarks
|
|
4747
|
-
* >
|
|
4839
|
+
* > 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.
|
|
4748
4840
|
*
|
|
4749
4841
|
* @param request - DescribeRegionsRequest
|
|
4750
4842
|
* @returns DescribeRegionsResponse
|
|
@@ -4754,10 +4846,10 @@ class Client extends openapi_core_1.default {
|
|
|
4754
4846
|
return await this.describeRegionsWithOptions(request, runtime);
|
|
4755
4847
|
}
|
|
4756
4848
|
/**
|
|
4757
|
-
*
|
|
4849
|
+
* Get the price to renew a specific MongoDB instance for one month.
|
|
4758
4850
|
*
|
|
4759
4851
|
* @remarks
|
|
4760
|
-
* This operation
|
|
4852
|
+
* This operation applies to subscription MongoDB instances.
|
|
4761
4853
|
*
|
|
4762
4854
|
* @param request - DescribeRenewalPriceRequest
|
|
4763
4855
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4804,10 +4896,10 @@ class Client extends openapi_core_1.default {
|
|
|
4804
4896
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeRenewalPriceResponse({}));
|
|
4805
4897
|
}
|
|
4806
4898
|
/**
|
|
4807
|
-
*
|
|
4899
|
+
* Get the price to renew a specific MongoDB instance for one month.
|
|
4808
4900
|
*
|
|
4809
4901
|
* @remarks
|
|
4810
|
-
* This operation
|
|
4902
|
+
* This operation applies to subscription MongoDB instances.
|
|
4811
4903
|
*
|
|
4812
4904
|
* @param request - DescribeRenewalPriceRequest
|
|
4813
4905
|
* @returns DescribeRenewalPriceResponse
|
|
@@ -4817,10 +4909,10 @@ class Client extends openapi_core_1.default {
|
|
|
4817
4909
|
return await this.describeRenewalPriceWithOptions(request, runtime);
|
|
4818
4910
|
}
|
|
4819
4911
|
/**
|
|
4820
|
-
*
|
|
4912
|
+
* Retrieves the role information and connection details for a MongoDB instance.
|
|
4821
4913
|
*
|
|
4822
4914
|
* @remarks
|
|
4823
|
-
* This operation
|
|
4915
|
+
* This operation applies to replica set instances and single-node instances. It does not apply to sharded cluster instances.
|
|
4824
4916
|
*
|
|
4825
4917
|
* @param request - DescribeReplicaSetRoleRequest
|
|
4826
4918
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4861,10 +4953,10 @@ class Client extends openapi_core_1.default {
|
|
|
4861
4953
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeReplicaSetRoleResponse({}));
|
|
4862
4954
|
}
|
|
4863
4955
|
/**
|
|
4864
|
-
*
|
|
4956
|
+
* Retrieves the role information and connection details for a MongoDB instance.
|
|
4865
4957
|
*
|
|
4866
4958
|
* @remarks
|
|
4867
|
-
* This operation
|
|
4959
|
+
* This operation applies to replica set instances and single-node instances. It does not apply to sharded cluster instances.
|
|
4868
4960
|
*
|
|
4869
4961
|
* @param request - DescribeReplicaSetRoleRequest
|
|
4870
4962
|
* @returns DescribeReplicaSetRoleResponse
|
|
@@ -4934,6 +5026,8 @@ class Client extends openapi_core_1.default {
|
|
|
4934
5026
|
return await this.describeRestoreDBInstanceListWithOptions(request, runtime);
|
|
4935
5027
|
}
|
|
4936
5028
|
/**
|
|
5029
|
+
* Describes the status of a tag for a node.
|
|
5030
|
+
*
|
|
4937
5031
|
* @param request - DescribeRoleTagStatusRequest
|
|
4938
5032
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
4939
5033
|
* @returns DescribeRoleTagStatusResponse
|
|
@@ -4973,6 +5067,8 @@ class Client extends openapi_core_1.default {
|
|
|
4973
5067
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeRoleTagStatusResponse({}));
|
|
4974
5068
|
}
|
|
4975
5069
|
/**
|
|
5070
|
+
* Describes the status of a tag for a node.
|
|
5071
|
+
*
|
|
4976
5072
|
* @param request - DescribeRoleTagStatusRequest
|
|
4977
5073
|
* @returns DescribeRoleTagStatusResponse
|
|
4978
5074
|
*/
|
|
@@ -5040,11 +5136,11 @@ class Client extends openapi_core_1.default {
|
|
|
5040
5136
|
return await this.describeRoleZoneInfoWithOptions(request, runtime);
|
|
5041
5137
|
}
|
|
5042
5138
|
/**
|
|
5043
|
-
*
|
|
5139
|
+
* View the running logs for a MongoDB instance.
|
|
5044
5140
|
*
|
|
5045
5141
|
* @remarks
|
|
5046
|
-
*
|
|
5047
|
-
*
|
|
5142
|
+
* - This API is for instances with the following specification types: **general-purpose local disk**, **dedicated local disk**, and **cloud disk**.
|
|
5143
|
+
* - 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).
|
|
5048
5144
|
*
|
|
5049
5145
|
* @param request - DescribeRunningLogRecordsRequest
|
|
5050
5146
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5121,11 +5217,11 @@ class Client extends openapi_core_1.default {
|
|
|
5121
5217
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeRunningLogRecordsResponse({}));
|
|
5122
5218
|
}
|
|
5123
5219
|
/**
|
|
5124
|
-
*
|
|
5220
|
+
* View the running logs for a MongoDB instance.
|
|
5125
5221
|
*
|
|
5126
5222
|
* @remarks
|
|
5127
|
-
*
|
|
5128
|
-
*
|
|
5223
|
+
* - This API is for instances with the following specification types: **general-purpose local disk**, **dedicated local disk**, and **cloud disk**.
|
|
5224
|
+
* - 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).
|
|
5129
5225
|
*
|
|
5130
5226
|
* @param request - DescribeRunningLogRecordsRequest
|
|
5131
5227
|
* @returns DescribeRunningLogRecordsResponse
|
|
@@ -5186,7 +5282,7 @@ class Client extends openapi_core_1.default {
|
|
|
5186
5282
|
return await this.describeSecurityGroupConfigurationWithOptions(request, runtime);
|
|
5187
5283
|
}
|
|
5188
5284
|
/**
|
|
5189
|
-
*
|
|
5285
|
+
* Retrieves the IP whitelists of an ApsaraDB for MongoDB instance.
|
|
5190
5286
|
*
|
|
5191
5287
|
* @param request - DescribeSecurityIpsRequest
|
|
5192
5288
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5230,7 +5326,7 @@ class Client extends openapi_core_1.default {
|
|
|
5230
5326
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeSecurityIpsResponse({}));
|
|
5231
5327
|
}
|
|
5232
5328
|
/**
|
|
5233
|
-
*
|
|
5329
|
+
* Retrieves the IP whitelists of an ApsaraDB for MongoDB instance.
|
|
5234
5330
|
*
|
|
5235
5331
|
* @param request - DescribeSecurityIpsRequest
|
|
5236
5332
|
* @returns DescribeSecurityIpsResponse
|
|
@@ -5240,10 +5336,10 @@ class Client extends openapi_core_1.default {
|
|
|
5240
5336
|
return await this.describeSecurityIpsWithOptions(request, runtime);
|
|
5241
5337
|
}
|
|
5242
5338
|
/**
|
|
5243
|
-
*
|
|
5339
|
+
* Retrieves the connection information for a MongoDB sharded cluster instance.
|
|
5244
5340
|
*
|
|
5245
5341
|
* @remarks
|
|
5246
|
-
* This
|
|
5342
|
+
* This API is for sharded cluster instances only.
|
|
5247
5343
|
*
|
|
5248
5344
|
* @param request - DescribeShardingNetworkAddressRequest
|
|
5249
5345
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5290,10 +5386,10 @@ class Client extends openapi_core_1.default {
|
|
|
5290
5386
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeShardingNetworkAddressResponse({}));
|
|
5291
5387
|
}
|
|
5292
5388
|
/**
|
|
5293
|
-
*
|
|
5389
|
+
* Retrieves the connection information for a MongoDB sharded cluster instance.
|
|
5294
5390
|
*
|
|
5295
5391
|
* @remarks
|
|
5296
|
-
* This
|
|
5392
|
+
* This API is for sharded cluster instances only.
|
|
5297
5393
|
*
|
|
5298
5394
|
* @param request - DescribeShardingNetworkAddressRequest
|
|
5299
5395
|
* @returns DescribeShardingNetworkAddressResponse
|
|
@@ -5303,11 +5399,11 @@ class Client extends openapi_core_1.default {
|
|
|
5303
5399
|
return await this.describeShardingNetworkAddressWithOptions(request, runtime);
|
|
5304
5400
|
}
|
|
5305
5401
|
/**
|
|
5306
|
-
* Queries
|
|
5402
|
+
* Queries slow query log entries for a MongoDB instance.
|
|
5307
5403
|
*
|
|
5308
5404
|
* @remarks
|
|
5309
|
-
*
|
|
5310
|
-
*
|
|
5405
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
5406
|
+
* - 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).
|
|
5311
5407
|
*
|
|
5312
5408
|
* @param request - DescribeSlowLogRecordsRequest
|
|
5313
5409
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5378,11 +5474,11 @@ class Client extends openapi_core_1.default {
|
|
|
5378
5474
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeSlowLogRecordsResponse({}));
|
|
5379
5475
|
}
|
|
5380
5476
|
/**
|
|
5381
|
-
* Queries
|
|
5477
|
+
* Queries slow query log entries for a MongoDB instance.
|
|
5382
5478
|
*
|
|
5383
5479
|
* @remarks
|
|
5384
|
-
*
|
|
5385
|
-
*
|
|
5480
|
+
* - This operation is applicable only to **general-purpose local-disk** and **dedicated local-disk** instances.
|
|
5481
|
+
* - 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).
|
|
5386
5482
|
*
|
|
5387
5483
|
* @param request - DescribeSlowLogRecordsRequest
|
|
5388
5484
|
* @returns DescribeSlowLogRecordsResponse
|
|
@@ -5452,10 +5548,10 @@ class Client extends openapi_core_1.default {
|
|
|
5452
5548
|
return await this.describeTagsWithOptions(request, runtime);
|
|
5453
5549
|
}
|
|
5454
5550
|
/**
|
|
5455
|
-
* Queries the
|
|
5551
|
+
* Queries the custom keys for an instance.
|
|
5456
5552
|
*
|
|
5457
5553
|
* @remarks
|
|
5458
|
-
* You can use the custom
|
|
5554
|
+
* 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).
|
|
5459
5555
|
*
|
|
5460
5556
|
* @param request - DescribeUserEncryptionKeyListRequest
|
|
5461
5557
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5502,10 +5598,10 @@ class Client extends openapi_core_1.default {
|
|
|
5502
5598
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeUserEncryptionKeyListResponse({}));
|
|
5503
5599
|
}
|
|
5504
5600
|
/**
|
|
5505
|
-
* Queries the
|
|
5601
|
+
* Queries the custom keys for an instance.
|
|
5506
5602
|
*
|
|
5507
5603
|
* @remarks
|
|
5508
|
-
* You can use the custom
|
|
5604
|
+
* 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).
|
|
5509
5605
|
*
|
|
5510
5606
|
* @param request - DescribeUserEncryptionKeyListRequest
|
|
5511
5607
|
* @returns DescribeUserEncryptionKeyListResponse
|
|
@@ -5515,6 +5611,8 @@ class Client extends openapi_core_1.default {
|
|
|
5515
5611
|
return await this.describeUserEncryptionKeyListWithOptions(request, runtime);
|
|
5516
5612
|
}
|
|
5517
5613
|
/**
|
|
5614
|
+
* Queries a paginated list of VPCs.
|
|
5615
|
+
*
|
|
5518
5616
|
* @param request - DescribeVpcsForMongoDBRequest
|
|
5519
5617
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
5520
5618
|
* @returns DescribeVpcsForMongoDBResponse
|
|
@@ -5566,6 +5664,8 @@ class Client extends openapi_core_1.default {
|
|
|
5566
5664
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeVpcsForMongoDBResponse({}));
|
|
5567
5665
|
}
|
|
5568
5666
|
/**
|
|
5667
|
+
* Queries a paginated list of VPCs.
|
|
5668
|
+
*
|
|
5569
5669
|
* @param request - DescribeVpcsForMongoDBRequest
|
|
5570
5670
|
* @returns DescribeVpcsForMongoDBResponse
|
|
5571
5671
|
*/
|
|
@@ -5650,11 +5750,11 @@ class Client extends openapi_core_1.default {
|
|
|
5650
5750
|
return await this.destroyInstanceWithOptions(request, runtime);
|
|
5651
5751
|
}
|
|
5652
5752
|
/**
|
|
5653
|
-
*
|
|
5753
|
+
* Evaluate resource availability before purchasing a new instance or changing the configuration of an existing instance.
|
|
5654
5754
|
*
|
|
5655
5755
|
* @remarks
|
|
5656
|
-
*
|
|
5657
|
-
* > You can call this operation
|
|
5756
|
+
* 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.
|
|
5757
|
+
* > You can call this operation up to 200 times per minute. Calls that exceed this limit are subject to traffic throttling.
|
|
5658
5758
|
*
|
|
5659
5759
|
* @param request - EvaluateResourceRequest
|
|
5660
5760
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5722,11 +5822,11 @@ class Client extends openapi_core_1.default {
|
|
|
5722
5822
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.EvaluateResourceResponse({}));
|
|
5723
5823
|
}
|
|
5724
5824
|
/**
|
|
5725
|
-
*
|
|
5825
|
+
* Evaluate resource availability before purchasing a new instance or changing the configuration of an existing instance.
|
|
5726
5826
|
*
|
|
5727
5827
|
* @remarks
|
|
5728
|
-
*
|
|
5729
|
-
* > You can call this operation
|
|
5828
|
+
* 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.
|
|
5829
|
+
* > You can call this operation up to 200 times per minute. Calls that exceed this limit are subject to traffic throttling.
|
|
5730
5830
|
*
|
|
5731
5831
|
* @param request - EvaluateResourceRequest
|
|
5732
5832
|
* @returns EvaluateResourceResponse
|
|
@@ -5802,11 +5902,11 @@ class Client extends openapi_core_1.default {
|
|
|
5802
5902
|
* Migrates an ApsaraDB for MongoDB instance to a specific zone.
|
|
5803
5903
|
*
|
|
5804
5904
|
* @remarks
|
|
5805
|
-
*
|
|
5806
|
-
*
|
|
5807
|
-
*
|
|
5808
|
-
*
|
|
5809
|
-
*
|
|
5905
|
+
* - This operation is available only for replica set instances that run MongoDB 4.2 or earlier and sharded cluster instances.
|
|
5906
|
+
* - 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.
|
|
5907
|
+
* - Transparent data encryption (TDE) is disabled for the ApsaraDB for MongoDB instance.
|
|
5908
|
+
* - The source zone and the destination zone belong to the same region.
|
|
5909
|
+
* - 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).
|
|
5810
5910
|
*
|
|
5811
5911
|
* @param request - MigrateAvailableZoneRequest
|
|
5812
5912
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5865,11 +5965,11 @@ class Client extends openapi_core_1.default {
|
|
|
5865
5965
|
* Migrates an ApsaraDB for MongoDB instance to a specific zone.
|
|
5866
5966
|
*
|
|
5867
5967
|
* @remarks
|
|
5868
|
-
*
|
|
5869
|
-
*
|
|
5870
|
-
*
|
|
5871
|
-
*
|
|
5872
|
-
*
|
|
5968
|
+
* - This operation is available only for replica set instances that run MongoDB 4.2 or earlier and sharded cluster instances.
|
|
5969
|
+
* - 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.
|
|
5970
|
+
* - Transparent data encryption (TDE) is disabled for the ApsaraDB for MongoDB instance.
|
|
5971
|
+
* - The source zone and the destination zone belong to the same region.
|
|
5972
|
+
* - 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).
|
|
5873
5973
|
*
|
|
5874
5974
|
* @param request - MigrateAvailableZoneRequest
|
|
5875
5975
|
* @returns MigrateAvailableZoneResponse
|
|
@@ -5879,11 +5979,11 @@ class Client extends openapi_core_1.default {
|
|
|
5879
5979
|
return await this.migrateAvailableZoneWithOptions(request, runtime);
|
|
5880
5980
|
}
|
|
5881
5981
|
/**
|
|
5882
|
-
*
|
|
5982
|
+
* Migrates an ApsaraDB for MongoDB instance to another zone.
|
|
5883
5983
|
*
|
|
5884
5984
|
* @remarks
|
|
5885
5985
|
* This operation is applicable only to replica set instances, but not to standalone instances or sharded cluster instances.
|
|
5886
|
-
* >
|
|
5986
|
+
* > 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.
|
|
5887
5987
|
*
|
|
5888
5988
|
* @param request - MigrateToOtherZoneRequest
|
|
5889
5989
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5933,11 +6033,11 @@ class Client extends openapi_core_1.default {
|
|
|
5933
6033
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.MigrateToOtherZoneResponse({}));
|
|
5934
6034
|
}
|
|
5935
6035
|
/**
|
|
5936
|
-
*
|
|
6036
|
+
* Migrates an ApsaraDB for MongoDB instance to another zone.
|
|
5937
6037
|
*
|
|
5938
6038
|
* @remarks
|
|
5939
6039
|
* This operation is applicable only to replica set instances, but not to standalone instances or sharded cluster instances.
|
|
5940
|
-
* >
|
|
6040
|
+
* > 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.
|
|
5941
6041
|
*
|
|
5942
6042
|
* @param request - MigrateToOtherZoneRequest
|
|
5943
6043
|
* @returns MigrateToOtherZoneResponse
|
|
@@ -5949,6 +6049,9 @@ class Client extends openapi_core_1.default {
|
|
|
5949
6049
|
/**
|
|
5950
6050
|
* Modifies the description of the root account in an ApsaraDB for MongoDB instance.
|
|
5951
6051
|
*
|
|
6052
|
+
* @remarks
|
|
6053
|
+
* This operation is not supported for sharded cluster instances.
|
|
6054
|
+
*
|
|
5952
6055
|
* @param request - ModifyAccountDescriptionRequest
|
|
5953
6056
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
5954
6057
|
* @returns ModifyAccountDescriptionResponse
|
|
@@ -5999,6 +6102,9 @@ class Client extends openapi_core_1.default {
|
|
|
5999
6102
|
/**
|
|
6000
6103
|
* Modifies the description of the root account in an ApsaraDB for MongoDB instance.
|
|
6001
6104
|
*
|
|
6105
|
+
* @remarks
|
|
6106
|
+
* This operation is not supported for sharded cluster instances.
|
|
6107
|
+
*
|
|
6002
6108
|
* @param request - ModifyAccountDescriptionRequest
|
|
6003
6109
|
* @returns ModifyAccountDescriptionResponse
|
|
6004
6110
|
*/
|
|
@@ -6007,7 +6113,7 @@ class Client extends openapi_core_1.default {
|
|
|
6007
6113
|
return await this.modifyAccountDescriptionWithOptions(request, runtime);
|
|
6008
6114
|
}
|
|
6009
6115
|
/**
|
|
6010
|
-
* Modifies the O
|
|
6116
|
+
* Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
6011
6117
|
*
|
|
6012
6118
|
* @param request - ModifyActiveOperationMaintenanceConfigRequest
|
|
6013
6119
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6060,7 +6166,7 @@ class Client extends openapi_core_1.default {
|
|
|
6060
6166
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyActiveOperationMaintenanceConfigResponse({}));
|
|
6061
6167
|
}
|
|
6062
6168
|
/**
|
|
6063
|
-
* Modifies the O
|
|
6169
|
+
* Modifies the Operations and Maintenance (O&M) task configuration for a MongoDB instance.
|
|
6064
6170
|
*
|
|
6065
6171
|
* @param request - ModifyActiveOperationMaintenanceConfigRequest
|
|
6066
6172
|
* @returns ModifyActiveOperationMaintenanceConfigResponse
|
|
@@ -6130,12 +6236,12 @@ class Client extends openapi_core_1.default {
|
|
|
6130
6236
|
return await this.modifyActiveOperationTasksWithOptions(request, runtime);
|
|
6131
6237
|
}
|
|
6132
6238
|
/**
|
|
6133
|
-
*
|
|
6239
|
+
* Modifies the audit log types collected for a MongoDB instance.
|
|
6134
6240
|
*
|
|
6135
6241
|
* @remarks
|
|
6136
|
-
*
|
|
6137
|
-
*
|
|
6138
|
-
*
|
|
6242
|
+
* - The instance must be in the running state when you call this operation.
|
|
6243
|
+
* - This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
|
|
6244
|
+
* - 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).
|
|
6139
6245
|
*
|
|
6140
6246
|
* @param request - ModifyAuditLogFilterRequest
|
|
6141
6247
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6182,12 +6288,12 @@ class Client extends openapi_core_1.default {
|
|
|
6182
6288
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyAuditLogFilterResponse({}));
|
|
6183
6289
|
}
|
|
6184
6290
|
/**
|
|
6185
|
-
*
|
|
6291
|
+
* Modifies the audit log types collected for a MongoDB instance.
|
|
6186
6292
|
*
|
|
6187
6293
|
* @remarks
|
|
6188
|
-
*
|
|
6189
|
-
*
|
|
6190
|
-
*
|
|
6294
|
+
* - The instance must be in the running state when you call this operation.
|
|
6295
|
+
* - This operation is applicable only to **general-purpose local-disk** or **dedicated local-disk** instances.
|
|
6296
|
+
* - 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).
|
|
6191
6297
|
*
|
|
6192
6298
|
* @param request - ModifyAuditLogFilterRequest
|
|
6193
6299
|
* @returns ModifyAuditLogFilterResponse
|
|
@@ -6197,11 +6303,10 @@ class Client extends openapi_core_1.default {
|
|
|
6197
6303
|
return await this.modifyAuditLogFilterWithOptions(request, runtime);
|
|
6198
6304
|
}
|
|
6199
6305
|
/**
|
|
6200
|
-
* Enables or disables the audit log
|
|
6306
|
+
* Enables or disables the audit log for a MongoDB instance, or modifies the log retention period.
|
|
6201
6307
|
*
|
|
6202
6308
|
* @remarks
|
|
6203
|
-
*
|
|
6204
|
-
* * 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).
|
|
6309
|
+
* - 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).
|
|
6205
6310
|
*
|
|
6206
6311
|
* @param request - ModifyAuditPolicyRequest
|
|
6207
6312
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6257,11 +6362,10 @@ class Client extends openapi_core_1.default {
|
|
|
6257
6362
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyAuditPolicyResponse({}));
|
|
6258
6363
|
}
|
|
6259
6364
|
/**
|
|
6260
|
-
* Enables or disables the audit log
|
|
6365
|
+
* Enables or disables the audit log for a MongoDB instance, or modifies the log retention period.
|
|
6261
6366
|
*
|
|
6262
6367
|
* @remarks
|
|
6263
|
-
*
|
|
6264
|
-
* * 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).
|
|
6368
|
+
* - 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).
|
|
6265
6369
|
*
|
|
6266
6370
|
* @param request - ModifyAuditPolicyRequest
|
|
6267
6371
|
* @returns ModifyAuditPolicyResponse
|
|
@@ -6271,7 +6375,11 @@ class Client extends openapi_core_1.default {
|
|
|
6271
6375
|
return await this.modifyAuditPolicyWithOptions(request, runtime);
|
|
6272
6376
|
}
|
|
6273
6377
|
/**
|
|
6274
|
-
* Modifies the
|
|
6378
|
+
* Modifies the time-to-live (TTL) of a MongoDB backup set.
|
|
6379
|
+
*
|
|
6380
|
+
* @remarks
|
|
6381
|
+
* You can modify the TTL only for manual backups.
|
|
6382
|
+
* This operation is applicable only to MongoDB instances that use cloud disks.
|
|
6275
6383
|
*
|
|
6276
6384
|
* @param request - ModifyBackupExpireTimeRequest
|
|
6277
6385
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6318,7 +6426,11 @@ class Client extends openapi_core_1.default {
|
|
|
6318
6426
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyBackupExpireTimeResponse({}));
|
|
6319
6427
|
}
|
|
6320
6428
|
/**
|
|
6321
|
-
* Modifies the
|
|
6429
|
+
* Modifies the time-to-live (TTL) of a MongoDB backup set.
|
|
6430
|
+
*
|
|
6431
|
+
* @remarks
|
|
6432
|
+
* You can modify the TTL only for manual backups.
|
|
6433
|
+
* This operation is applicable only to MongoDB instances that use cloud disks.
|
|
6322
6434
|
*
|
|
6323
6435
|
* @param request - ModifyBackupExpireTimeRequest
|
|
6324
6436
|
* @returns ModifyBackupExpireTimeResponse
|
|
@@ -6328,10 +6440,10 @@ class Client extends openapi_core_1.default {
|
|
|
6328
6440
|
return await this.modifyBackupExpireTimeWithOptions(request, runtime);
|
|
6329
6441
|
}
|
|
6330
6442
|
/**
|
|
6331
|
-
* Modifies
|
|
6443
|
+
* Modifies the backup policy of a MongoDB instance.
|
|
6332
6444
|
*
|
|
6333
6445
|
* @remarks
|
|
6334
|
-
*
|
|
6446
|
+
* Geo-redundancy is available only for replica set instances and sharded cluster instances that use cloud disks.
|
|
6335
6447
|
*
|
|
6336
6448
|
* @param request - ModifyBackupPolicyRequest
|
|
6337
6449
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6432,10 +6544,10 @@ class Client extends openapi_core_1.default {
|
|
|
6432
6544
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyBackupPolicyResponse({}));
|
|
6433
6545
|
}
|
|
6434
6546
|
/**
|
|
6435
|
-
* Modifies
|
|
6547
|
+
* Modifies the backup policy of a MongoDB instance.
|
|
6436
6548
|
*
|
|
6437
6549
|
* @remarks
|
|
6438
|
-
*
|
|
6550
|
+
* Geo-redundancy is available only for replica set instances and sharded cluster instances that use cloud disks.
|
|
6439
6551
|
*
|
|
6440
6552
|
* @param request - ModifyBackupPolicyRequest
|
|
6441
6553
|
* @returns ModifyBackupPolicyResponse
|
|
@@ -6445,7 +6557,10 @@ class Client extends openapi_core_1.default {
|
|
|
6445
6557
|
return await this.modifyBackupPolicyWithOptions(request, runtime);
|
|
6446
6558
|
}
|
|
6447
6559
|
/**
|
|
6448
|
-
* Modifies
|
|
6560
|
+
* Modifies instance release protection configuration.
|
|
6561
|
+
*
|
|
6562
|
+
* @remarks
|
|
6563
|
+
* This operation is applicable only to pay-as-you-go instances.
|
|
6449
6564
|
*
|
|
6450
6565
|
* @param request - ModifyDBInstanceAttributeRequest
|
|
6451
6566
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6489,7 +6604,10 @@ class Client extends openapi_core_1.default {
|
|
|
6489
6604
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceAttributeResponse({}));
|
|
6490
6605
|
}
|
|
6491
6606
|
/**
|
|
6492
|
-
* Modifies
|
|
6607
|
+
* Modifies instance release protection configuration.
|
|
6608
|
+
*
|
|
6609
|
+
* @remarks
|
|
6610
|
+
* This operation is applicable only to pay-as-you-go instances.
|
|
6493
6611
|
*
|
|
6494
6612
|
* @param request - ModifyDBInstanceAttributeRequest
|
|
6495
6613
|
* @returns ModifyDBInstanceAttributeResponse
|
|
@@ -6499,7 +6617,7 @@ class Client extends openapi_core_1.default {
|
|
|
6499
6617
|
return await this.modifyDBInstanceAttributeWithOptions(request, runtime);
|
|
6500
6618
|
}
|
|
6501
6619
|
/**
|
|
6502
|
-
* Modifies
|
|
6620
|
+
* Modifies instance configuration
|
|
6503
6621
|
*
|
|
6504
6622
|
* @param request - ModifyDBInstanceConfigRequest
|
|
6505
6623
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6546,7 +6664,7 @@ class Client extends openapi_core_1.default {
|
|
|
6546
6664
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceConfigResponse({}));
|
|
6547
6665
|
}
|
|
6548
6666
|
/**
|
|
6549
|
-
* Modifies
|
|
6667
|
+
* Modifies instance configuration
|
|
6550
6668
|
*
|
|
6551
6669
|
* @param request - ModifyDBInstanceConfigRequest
|
|
6552
6670
|
* @returns ModifyDBInstanceConfigResponse
|
|
@@ -6556,12 +6674,12 @@ class Client extends openapi_core_1.default {
|
|
|
6556
6674
|
return await this.modifyDBInstanceConfigWithOptions(request, runtime);
|
|
6557
6675
|
}
|
|
6558
6676
|
/**
|
|
6559
|
-
* Modifies the
|
|
6677
|
+
* Modifies the connection address and port of a MongoDB instance.
|
|
6560
6678
|
*
|
|
6561
6679
|
* @remarks
|
|
6562
|
-
* You can modify the connection
|
|
6563
|
-
*
|
|
6564
|
-
*
|
|
6680
|
+
* You can modify the connection address and port for the following instance types:
|
|
6681
|
+
* - You can modify the connection address and port for instances that use local disks or cloud disks.
|
|
6682
|
+
* - For sharded cluster instances, you can modify only the connection address of Mongos nodes.
|
|
6565
6683
|
*
|
|
6566
6684
|
* @param request - ModifyDBInstanceConnectionStringRequest
|
|
6567
6685
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6623,12 +6741,12 @@ class Client extends openapi_core_1.default {
|
|
|
6623
6741
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceConnectionStringResponse({}));
|
|
6624
6742
|
}
|
|
6625
6743
|
/**
|
|
6626
|
-
* Modifies the
|
|
6744
|
+
* Modifies the connection address and port of a MongoDB instance.
|
|
6627
6745
|
*
|
|
6628
6746
|
* @remarks
|
|
6629
|
-
* You can modify the connection
|
|
6630
|
-
*
|
|
6631
|
-
*
|
|
6747
|
+
* You can modify the connection address and port for the following instance types:
|
|
6748
|
+
* - You can modify the connection address and port for instances that use local disks or cloud disks.
|
|
6749
|
+
* - For sharded cluster instances, you can modify only the connection address of Mongos nodes.
|
|
6632
6750
|
*
|
|
6633
6751
|
* @param request - ModifyDBInstanceConnectionStringRequest
|
|
6634
6752
|
* @returns ModifyDBInstanceConnectionStringResponse
|
|
@@ -6697,6 +6815,11 @@ class Client extends openapi_core_1.default {
|
|
|
6697
6815
|
/**
|
|
6698
6816
|
* Modifies the disk type of an ApsaraDB for MongoDB instance.
|
|
6699
6817
|
*
|
|
6818
|
+
* @remarks
|
|
6819
|
+
* - This feature is not supported for instances with less than 40 GB of disk space.
|
|
6820
|
+
* - You can change the disk type only to an ESSD AutoPL disk (cloud_auto).
|
|
6821
|
+
* - 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).
|
|
6822
|
+
*
|
|
6700
6823
|
* @param request - ModifyDBInstanceDiskTypeRequest
|
|
6701
6824
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
6702
6825
|
* @returns ModifyDBInstanceDiskTypeResponse
|
|
@@ -6753,6 +6876,11 @@ class Client extends openapi_core_1.default {
|
|
|
6753
6876
|
/**
|
|
6754
6877
|
* Modifies the disk type of an ApsaraDB for MongoDB instance.
|
|
6755
6878
|
*
|
|
6879
|
+
* @remarks
|
|
6880
|
+
* - This feature is not supported for instances with less than 40 GB of disk space.
|
|
6881
|
+
* - You can change the disk type only to an ESSD AutoPL disk (cloud_auto).
|
|
6882
|
+
* - 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).
|
|
6883
|
+
*
|
|
6756
6884
|
* @param request - ModifyDBInstanceDiskTypeRequest
|
|
6757
6885
|
* @returns ModifyDBInstanceDiskTypeResponse
|
|
6758
6886
|
*/
|
|
@@ -6818,13 +6946,13 @@ class Client extends openapi_core_1.default {
|
|
|
6818
6946
|
return await this.modifyDBInstanceMaintainTimeWithOptions(request, runtime);
|
|
6819
6947
|
}
|
|
6820
6948
|
/**
|
|
6821
|
-
*
|
|
6949
|
+
* Set the monitoring collection granularity for a MongoDB instance.
|
|
6822
6950
|
*
|
|
6823
6951
|
* @remarks
|
|
6824
|
-
* >
|
|
6825
|
-
*
|
|
6826
|
-
*
|
|
6827
|
-
*
|
|
6952
|
+
* > Due to changes in the monitoring collection granularity adjustment feature, this operation is only applicable to the previous version of the MongoDB console.
|
|
6953
|
+
* To use this operation, the instance must meet the following requirements:
|
|
6954
|
+
* - A replica set or sharded cluster instance is used.
|
|
6955
|
+
* - MongoDB 3.4 (the latest minor version) or MongoDB 4.0 is selected.
|
|
6828
6956
|
*
|
|
6829
6957
|
* @param request - ModifyDBInstanceMonitorRequest
|
|
6830
6958
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6868,13 +6996,13 @@ class Client extends openapi_core_1.default {
|
|
|
6868
6996
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceMonitorResponse({}));
|
|
6869
6997
|
}
|
|
6870
6998
|
/**
|
|
6871
|
-
*
|
|
6999
|
+
* Set the monitoring collection granularity for a MongoDB instance.
|
|
6872
7000
|
*
|
|
6873
7001
|
* @remarks
|
|
6874
|
-
* >
|
|
6875
|
-
*
|
|
6876
|
-
*
|
|
6877
|
-
*
|
|
7002
|
+
* > Due to changes in the monitoring collection granularity adjustment feature, this operation is only applicable to the previous version of the MongoDB console.
|
|
7003
|
+
* To use this operation, the instance must meet the following requirements:
|
|
7004
|
+
* - A replica set or sharded cluster instance is used.
|
|
7005
|
+
* - MongoDB 3.4 (the latest minor version) or MongoDB 4.0 is selected.
|
|
6878
7006
|
*
|
|
6879
7007
|
* @param request - ModifyDBInstanceMonitorRequest
|
|
6880
7008
|
* @returns ModifyDBInstanceMonitorResponse
|
|
@@ -6888,9 +7016,9 @@ class Client extends openapi_core_1.default {
|
|
|
6888
7016
|
*
|
|
6889
7017
|
* @remarks
|
|
6890
7018
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
6891
|
-
*
|
|
6892
|
-
*
|
|
6893
|
-
* >
|
|
7019
|
+
* - The instance is in the Running state.
|
|
7020
|
+
* - The network of the instance is in hybrid access mode.
|
|
7021
|
+
* > This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
|
|
6894
7022
|
*
|
|
6895
7023
|
* @param request - ModifyDBInstanceNetExpireTimeRequest
|
|
6896
7024
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6941,9 +7069,9 @@ class Client extends openapi_core_1.default {
|
|
|
6941
7069
|
*
|
|
6942
7070
|
* @remarks
|
|
6943
7071
|
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
6944
|
-
*
|
|
6945
|
-
*
|
|
6946
|
-
* >
|
|
7072
|
+
* - The instance is in the Running state.
|
|
7073
|
+
* - The network of the instance is in hybrid access mode.
|
|
7074
|
+
* > This operation is supported by replica set instances and sharded cluster instances. This operation is not supported by standalone instances.
|
|
6947
7075
|
*
|
|
6948
7076
|
* @param request - ModifyDBInstanceNetExpireTimeRequest
|
|
6949
7077
|
* @returns ModifyDBInstanceNetExpireTimeResponse
|
|
@@ -6953,10 +7081,11 @@ class Client extends openapi_core_1.default {
|
|
|
6953
7081
|
return await this.modifyDBInstanceNetExpireTimeWithOptions(request, runtime);
|
|
6954
7082
|
}
|
|
6955
7083
|
/**
|
|
6956
|
-
*
|
|
7084
|
+
* Switches the network type of a MongoDB instance.
|
|
6957
7085
|
*
|
|
6958
7086
|
* @remarks
|
|
6959
|
-
* This operation
|
|
7087
|
+
* - 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.
|
|
7088
|
+
* - This operation supports only instances that run MongoDB 4.2 or earlier and use local disks.
|
|
6960
7089
|
*
|
|
6961
7090
|
* @param request - ModifyDBInstanceNetworkTypeRequest
|
|
6962
7091
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7015,10 +7144,11 @@ class Client extends openapi_core_1.default {
|
|
|
7015
7144
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceNetworkTypeResponse({}));
|
|
7016
7145
|
}
|
|
7017
7146
|
/**
|
|
7018
|
-
*
|
|
7147
|
+
* Switches the network type of a MongoDB instance.
|
|
7019
7148
|
*
|
|
7020
7149
|
* @remarks
|
|
7021
|
-
* This operation
|
|
7150
|
+
* - 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.
|
|
7151
|
+
* - This operation supports only instances that run MongoDB 4.2 or earlier and use local disks.
|
|
7022
7152
|
*
|
|
7023
7153
|
* @param request - ModifyDBInstanceNetworkTypeRequest
|
|
7024
7154
|
* @returns ModifyDBInstanceNetworkTypeResponse
|
|
@@ -7028,15 +7158,15 @@ class Client extends openapi_core_1.default {
|
|
|
7028
7158
|
return await this.modifyDBInstanceNetworkTypeWithOptions(request, runtime);
|
|
7029
7159
|
}
|
|
7030
7160
|
/**
|
|
7031
|
-
* Modifies the SSL
|
|
7161
|
+
* Modifies the SSL configuration of a MongoDB instance.
|
|
7032
7162
|
*
|
|
7033
7163
|
* @remarks
|
|
7034
|
-
*
|
|
7035
|
-
*
|
|
7036
|
-
*
|
|
7037
|
-
*
|
|
7038
|
-
*
|
|
7039
|
-
* >
|
|
7164
|
+
* Before you call the ModifyDBInstanceSSL operation, make sure that the instance meets the following requirements:
|
|
7165
|
+
* - The instance is in the running state.
|
|
7166
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
7167
|
+
* - The replica set instance is version 3.4 or later.
|
|
7168
|
+
* - The sharded cluster instance uses enhanced solid-state drives (ESSDs).
|
|
7169
|
+
* > Enabling, updating, or disabling SSL restarts the instance. We recommend that you perform these operations during off-peak hours.
|
|
7040
7170
|
*
|
|
7041
7171
|
* @param request - ModifyDBInstanceSSLRequest
|
|
7042
7172
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7086,15 +7216,15 @@ class Client extends openapi_core_1.default {
|
|
|
7086
7216
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceSSLResponse({}));
|
|
7087
7217
|
}
|
|
7088
7218
|
/**
|
|
7089
|
-
* Modifies the SSL
|
|
7219
|
+
* Modifies the SSL configuration of a MongoDB instance.
|
|
7090
7220
|
*
|
|
7091
7221
|
* @remarks
|
|
7092
|
-
*
|
|
7093
|
-
*
|
|
7094
|
-
*
|
|
7095
|
-
*
|
|
7096
|
-
*
|
|
7097
|
-
* >
|
|
7222
|
+
* Before you call the ModifyDBInstanceSSL operation, make sure that the instance meets the following requirements:
|
|
7223
|
+
* - The instance is in the running state.
|
|
7224
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
7225
|
+
* - The replica set instance is version 3.4 or later.
|
|
7226
|
+
* - The sharded cluster instance uses enhanced solid-state drives (ESSDs).
|
|
7227
|
+
* > Enabling, updating, or disabling SSL restarts the instance. We recommend that you perform these operations during off-peak hours.
|
|
7098
7228
|
*
|
|
7099
7229
|
* @param request - ModifyDBInstanceSSLRequest
|
|
7100
7230
|
* @returns ModifyDBInstanceSSLResponse
|
|
@@ -7104,11 +7234,11 @@ class Client extends openapi_core_1.default {
|
|
|
7104
7234
|
return await this.modifyDBInstanceSSLWithOptions(request, runtime);
|
|
7105
7235
|
}
|
|
7106
7236
|
/**
|
|
7107
|
-
*
|
|
7237
|
+
* 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.
|
|
7108
7238
|
*
|
|
7109
7239
|
* @remarks
|
|
7110
|
-
* Before
|
|
7111
|
-
* This operation applies only to standalone and replica set instances. To
|
|
7240
|
+
* 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.
|
|
7241
|
+
* 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.
|
|
7112
7242
|
*
|
|
7113
7243
|
* @param request - ModifyDBInstanceSpecRequest
|
|
7114
7244
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7200,11 +7330,11 @@ class Client extends openapi_core_1.default {
|
|
|
7200
7330
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceSpecResponse({}));
|
|
7201
7331
|
}
|
|
7202
7332
|
/**
|
|
7203
|
-
*
|
|
7333
|
+
* 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.
|
|
7204
7334
|
*
|
|
7205
7335
|
* @remarks
|
|
7206
|
-
* Before
|
|
7207
|
-
* This operation applies only to standalone and replica set instances. To
|
|
7336
|
+
* 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.
|
|
7337
|
+
* 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.
|
|
7208
7338
|
*
|
|
7209
7339
|
* @param request - ModifyDBInstanceSpecRequest
|
|
7210
7340
|
* @returns ModifyDBInstanceSpecResponse
|
|
@@ -7214,16 +7344,16 @@ class Client extends openapi_core_1.default {
|
|
|
7214
7344
|
return await this.modifyDBInstanceSpecWithOptions(request, runtime);
|
|
7215
7345
|
}
|
|
7216
7346
|
/**
|
|
7217
|
-
* Modifies the
|
|
7347
|
+
* Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance.
|
|
7218
7348
|
*
|
|
7219
7349
|
* @remarks
|
|
7220
|
-
*
|
|
7221
|
-
* >
|
|
7222
|
-
* Before you call this operation, make sure that the
|
|
7223
|
-
*
|
|
7224
|
-
*
|
|
7225
|
-
*
|
|
7226
|
-
*
|
|
7350
|
+
* 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).
|
|
7351
|
+
* > You cannot disable TDE after it is enabled.
|
|
7352
|
+
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
7353
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
7354
|
+
* - The instance uses the WiredTiger storage engine.
|
|
7355
|
+
* - The instance uses local disks.
|
|
7356
|
+
* - 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.
|
|
7227
7357
|
*
|
|
7228
7358
|
* @param request - ModifyDBInstanceTDERequest
|
|
7229
7359
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7279,16 +7409,16 @@ class Client extends openapi_core_1.default {
|
|
|
7279
7409
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyDBInstanceTDEResponse({}));
|
|
7280
7410
|
}
|
|
7281
7411
|
/**
|
|
7282
|
-
* Modifies the
|
|
7412
|
+
* Modifies the Transparent Data Encryption (TDE) status of a MongoDB instance.
|
|
7283
7413
|
*
|
|
7284
7414
|
* @remarks
|
|
7285
|
-
*
|
|
7286
|
-
* >
|
|
7287
|
-
* Before you call this operation, make sure that the
|
|
7288
|
-
*
|
|
7289
|
-
*
|
|
7290
|
-
*
|
|
7291
|
-
*
|
|
7415
|
+
* 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).
|
|
7416
|
+
* > You cannot disable TDE after it is enabled.
|
|
7417
|
+
* Before you call this operation, make sure that the instance meets the following requirements:
|
|
7418
|
+
* - The instance is a replica set instance or a sharded cluster instance.
|
|
7419
|
+
* - The instance uses the WiredTiger storage engine.
|
|
7420
|
+
* - The instance uses local disks.
|
|
7421
|
+
* - 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.
|
|
7292
7422
|
*
|
|
7293
7423
|
* @param request - ModifyDBInstanceTDERequest
|
|
7294
7424
|
* @returns ModifyDBInstanceTDEResponse
|
|
@@ -7546,10 +7676,10 @@ class Client extends openapi_core_1.default {
|
|
|
7546
7676
|
*
|
|
7547
7677
|
* @remarks
|
|
7548
7678
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
7549
|
-
*
|
|
7550
|
-
*
|
|
7551
|
-
*
|
|
7552
|
-
*
|
|
7679
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
7680
|
+
* - 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.
|
|
7681
|
+
* - 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.
|
|
7682
|
+
* - You can only disable but not enable password-free access over VPC.
|
|
7553
7683
|
*
|
|
7554
7684
|
* @param request - ModifyInstanceVpcAuthModeRequest
|
|
7555
7685
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7600,10 +7730,10 @@ class Client extends openapi_core_1.default {
|
|
|
7600
7730
|
*
|
|
7601
7731
|
* @remarks
|
|
7602
7732
|
* Before you call this operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
7603
|
-
*
|
|
7604
|
-
*
|
|
7605
|
-
*
|
|
7606
|
-
*
|
|
7733
|
+
* - The instance is a replica set or sharded cluster instance.
|
|
7734
|
+
* - 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.
|
|
7735
|
+
* - 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.
|
|
7736
|
+
* - You can only disable but not enable password-free access over VPC.
|
|
7607
7737
|
*
|
|
7608
7738
|
* @param request - ModifyInstanceVpcAuthModeRequest
|
|
7609
7739
|
* @returns ModifyInstanceVpcAuthModeResponse
|
|
@@ -7613,10 +7743,10 @@ class Client extends openapi_core_1.default {
|
|
|
7613
7743
|
return await this.modifyInstanceVpcAuthModeWithOptions(request, runtime);
|
|
7614
7744
|
}
|
|
7615
7745
|
/**
|
|
7616
|
-
* Changes the
|
|
7746
|
+
* Changes the instance type and storage space of a node in a MongoDB sharded cluster instance.
|
|
7617
7747
|
*
|
|
7618
7748
|
* @remarks
|
|
7619
|
-
* 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
|
|
7749
|
+
* 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.
|
|
7620
7750
|
* > This operation is applicable only to sharded cluster instances.
|
|
7621
7751
|
*
|
|
7622
7752
|
* @param request - ModifyNodeSpecRequest
|
|
@@ -7706,10 +7836,10 @@ class Client extends openapi_core_1.default {
|
|
|
7706
7836
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyNodeSpecResponse({}));
|
|
7707
7837
|
}
|
|
7708
7838
|
/**
|
|
7709
|
-
* Changes the
|
|
7839
|
+
* Changes the instance type and storage space of a node in a MongoDB sharded cluster instance.
|
|
7710
7840
|
*
|
|
7711
7841
|
* @remarks
|
|
7712
|
-
* 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
|
|
7842
|
+
* 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.
|
|
7713
7843
|
* > This operation is applicable only to sharded cluster instances.
|
|
7714
7844
|
*
|
|
7715
7845
|
* @param request - ModifyNodeSpecRequest
|
|
@@ -7720,12 +7850,12 @@ class Client extends openapi_core_1.default {
|
|
|
7720
7850
|
return await this.modifyNodeSpecWithOptions(request, runtime);
|
|
7721
7851
|
}
|
|
7722
7852
|
/**
|
|
7723
|
-
* Changes the
|
|
7853
|
+
* Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.
|
|
7724
7854
|
*
|
|
7725
7855
|
* @remarks
|
|
7726
|
-
*
|
|
7727
|
-
* This operation
|
|
7728
|
-
* When you upgrade or downgrade
|
|
7856
|
+
* 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.
|
|
7857
|
+
* This operation applies only to ApsaraDB for MongoDB sharded cluster instances.
|
|
7858
|
+
* 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.
|
|
7729
7859
|
*
|
|
7730
7860
|
* @param request - ModifyNodeSpecBatchRequest
|
|
7731
7861
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7802,12 +7932,12 @@ class Client extends openapi_core_1.default {
|
|
|
7802
7932
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifyNodeSpecBatchResponse({}));
|
|
7803
7933
|
}
|
|
7804
7934
|
/**
|
|
7805
|
-
* Changes the
|
|
7935
|
+
* Changes the configuration of one or more Mongos or shard nodes in an ApsaraDB for MongoDB sharded cluster instance.
|
|
7806
7936
|
*
|
|
7807
7937
|
* @remarks
|
|
7808
|
-
*
|
|
7809
|
-
* This operation
|
|
7810
|
-
* When you upgrade or downgrade
|
|
7938
|
+
* 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.
|
|
7939
|
+
* This operation applies only to ApsaraDB for MongoDB sharded cluster instances.
|
|
7940
|
+
* 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.
|
|
7811
7941
|
*
|
|
7812
7942
|
* @param request - ModifyNodeSpecBatchRequest
|
|
7813
7943
|
* @returns ModifyNodeSpecBatchResponse
|
|
@@ -7820,8 +7950,8 @@ class Client extends openapi_core_1.default {
|
|
|
7820
7950
|
* Modifies the parameters of an ApsaraDB for MongoDB instance.
|
|
7821
7951
|
*
|
|
7822
7952
|
* @remarks
|
|
7823
|
-
*
|
|
7824
|
-
*
|
|
7953
|
+
* - When you call this operation, the instance status must be running.
|
|
7954
|
+
* - 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.
|
|
7825
7955
|
*
|
|
7826
7956
|
* @param request - ModifyParametersRequest
|
|
7827
7957
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7880,8 +8010,8 @@ class Client extends openapi_core_1.default {
|
|
|
7880
8010
|
* Modifies the parameters of an ApsaraDB for MongoDB instance.
|
|
7881
8011
|
*
|
|
7882
8012
|
* @remarks
|
|
7883
|
-
*
|
|
7884
|
-
*
|
|
8013
|
+
* - When you call this operation, the instance status must be running.
|
|
8014
|
+
* - 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.
|
|
7885
8015
|
*
|
|
7886
8016
|
* @param request - ModifyParametersRequest
|
|
7887
8017
|
* @returns ModifyParametersResponse
|
|
@@ -7954,10 +8084,10 @@ class Client extends openapi_core_1.default {
|
|
|
7954
8084
|
return await this.modifyResourceGroupWithOptions(request, runtime);
|
|
7955
8085
|
}
|
|
7956
8086
|
/**
|
|
7957
|
-
*
|
|
8087
|
+
* Modifies the ECS security group bound to an ApsaraDB for MongoDB instance.
|
|
7958
8088
|
*
|
|
7959
8089
|
* @remarks
|
|
7960
|
-
* >
|
|
8090
|
+
* > For a sharded cluster instance, the bound ECS security group takes effect only for mongos nodes.
|
|
7961
8091
|
*
|
|
7962
8092
|
* @param request - ModifySecurityGroupConfigurationRequest
|
|
7963
8093
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8001,10 +8131,10 @@ class Client extends openapi_core_1.default {
|
|
|
8001
8131
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifySecurityGroupConfigurationResponse({}));
|
|
8002
8132
|
}
|
|
8003
8133
|
/**
|
|
8004
|
-
*
|
|
8134
|
+
* Modifies the ECS security group bound to an ApsaraDB for MongoDB instance.
|
|
8005
8135
|
*
|
|
8006
8136
|
* @remarks
|
|
8007
|
-
* >
|
|
8137
|
+
* > For a sharded cluster instance, the bound ECS security group takes effect only for mongos nodes.
|
|
8008
8138
|
*
|
|
8009
8139
|
* @param request - ModifySecurityGroupConfigurationRequest
|
|
8010
8140
|
* @returns ModifySecurityGroupConfigurationResponse
|
|
@@ -8077,7 +8207,10 @@ class Client extends openapi_core_1.default {
|
|
|
8077
8207
|
return await this.modifySecurityIpsWithOptions(request, runtime);
|
|
8078
8208
|
}
|
|
8079
8209
|
/**
|
|
8080
|
-
* Modifies the SRV connection
|
|
8210
|
+
* Modifies the SRV connection address of a MongoDB instance.
|
|
8211
|
+
*
|
|
8212
|
+
* @remarks
|
|
8213
|
+
* This operation applies only to replica set instances and sharded cluster instances that use disks.
|
|
8081
8214
|
*
|
|
8082
8215
|
* @param request - ModifySrvNetworkAddressRequest
|
|
8083
8216
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8124,7 +8257,10 @@ class Client extends openapi_core_1.default {
|
|
|
8124
8257
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ModifySrvNetworkAddressResponse({}));
|
|
8125
8258
|
}
|
|
8126
8259
|
/**
|
|
8127
|
-
* Modifies the SRV connection
|
|
8260
|
+
* Modifies the SRV connection address of a MongoDB instance.
|
|
8261
|
+
*
|
|
8262
|
+
* @remarks
|
|
8263
|
+
* This operation applies only to replica set instances and sharded cluster instances that use disks.
|
|
8128
8264
|
*
|
|
8129
8265
|
* @param request - ModifySrvNetworkAddressRequest
|
|
8130
8266
|
* @returns ModifySrvNetworkAddressResponse
|
|
@@ -8197,11 +8333,11 @@ class Client extends openapi_core_1.default {
|
|
|
8197
8333
|
return await this.modifyTaskInfoWithOptions(request, runtime);
|
|
8198
8334
|
}
|
|
8199
8335
|
/**
|
|
8200
|
-
* Releases the internal endpoint of a shard or Configserver node
|
|
8336
|
+
* Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance.
|
|
8201
8337
|
*
|
|
8202
8338
|
* @remarks
|
|
8203
|
-
*
|
|
8204
|
-
*
|
|
8339
|
+
* - 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).
|
|
8340
|
+
* - 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.
|
|
8205
8341
|
*
|
|
8206
8342
|
* @param request - ReleaseNodePrivateNetworkAddressRequest
|
|
8207
8343
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8251,11 +8387,11 @@ class Client extends openapi_core_1.default {
|
|
|
8251
8387
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.ReleaseNodePrivateNetworkAddressResponse({}));
|
|
8252
8388
|
}
|
|
8253
8389
|
/**
|
|
8254
|
-
* Releases the internal endpoint of a shard or Configserver node
|
|
8390
|
+
* Releases the internal endpoint of a shard or Configserver node for a sharded cluster instance.
|
|
8255
8391
|
*
|
|
8256
8392
|
* @remarks
|
|
8257
|
-
*
|
|
8258
|
-
*
|
|
8393
|
+
* - 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).
|
|
8394
|
+
* - 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.
|
|
8259
8395
|
*
|
|
8260
8396
|
* @param request - ReleaseNodePrivateNetworkAddressRequest
|
|
8261
8397
|
* @returns ReleaseNodePrivateNetworkAddressResponse
|
|
@@ -8401,9 +8537,6 @@ class Client extends openapi_core_1.default {
|
|
|
8401
8537
|
/**
|
|
8402
8538
|
* Resets the password of the root account in an ApsaraDB for MongoDB instance.
|
|
8403
8539
|
*
|
|
8404
|
-
* @remarks
|
|
8405
|
-
* > This operation can be used to reset only the password of the root account of an instance.
|
|
8406
|
-
*
|
|
8407
8540
|
* @param request - ResetAccountPasswordRequest
|
|
8408
8541
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
8409
8542
|
* @returns ResetAccountPasswordResponse
|
|
@@ -8454,9 +8587,6 @@ class Client extends openapi_core_1.default {
|
|
|
8454
8587
|
/**
|
|
8455
8588
|
* Resets the password of the root account in an ApsaraDB for MongoDB instance.
|
|
8456
8589
|
*
|
|
8457
|
-
* @remarks
|
|
8458
|
-
* > This operation can be used to reset only the password of the root account of an instance.
|
|
8459
|
-
*
|
|
8460
8590
|
* @param request - ResetAccountPasswordRequest
|
|
8461
8591
|
* @returns ResetAccountPasswordResponse
|
|
8462
8592
|
*/
|
|
@@ -8468,7 +8598,7 @@ class Client extends openapi_core_1.default {
|
|
|
8468
8598
|
* Restarts an ApsaraDB for MongoDB instance.
|
|
8469
8599
|
*
|
|
8470
8600
|
* @remarks
|
|
8471
|
-
*
|
|
8601
|
+
* You can call this operation to restart an instance. You can also restart a shard or Mongos node in a sharded cluster instance.
|
|
8472
8602
|
*
|
|
8473
8603
|
* @param request - RestartDBInstanceRequest
|
|
8474
8604
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8483,6 +8613,9 @@ class Client extends openapi_core_1.default {
|
|
|
8483
8613
|
if (!$dara.isNull(request.nodeId)) {
|
|
8484
8614
|
query["NodeId"] = request.nodeId;
|
|
8485
8615
|
}
|
|
8616
|
+
if (!$dara.isNull(request.nodeType)) {
|
|
8617
|
+
query["NodeType"] = request.nodeType;
|
|
8618
|
+
}
|
|
8486
8619
|
if (!$dara.isNull(request.ownerAccount)) {
|
|
8487
8620
|
query["OwnerAccount"] = request.ownerAccount;
|
|
8488
8621
|
}
|
|
@@ -8518,7 +8651,7 @@ class Client extends openapi_core_1.default {
|
|
|
8518
8651
|
* Restarts an ApsaraDB for MongoDB instance.
|
|
8519
8652
|
*
|
|
8520
8653
|
* @remarks
|
|
8521
|
-
*
|
|
8654
|
+
* You can call this operation to restart an instance. You can also restart a shard or Mongos node in a sharded cluster instance.
|
|
8522
8655
|
*
|
|
8523
8656
|
* @param request - RestartDBInstanceRequest
|
|
8524
8657
|
* @returns RestartDBInstanceResponse
|
|
@@ -8528,13 +8661,12 @@ class Client extends openapi_core_1.default {
|
|
|
8528
8661
|
return await this.restartDBInstanceWithOptions(request, runtime);
|
|
8529
8662
|
}
|
|
8530
8663
|
/**
|
|
8531
|
-
* Restarts a node
|
|
8664
|
+
* Restarts a single node of a MongoDB instance.
|
|
8532
8665
|
*
|
|
8533
8666
|
* @remarks
|
|
8534
|
-
*
|
|
8535
|
-
*
|
|
8536
|
-
*
|
|
8537
|
-
* * The instance is a replica set or sharded cluster instance of the standard edition.
|
|
8667
|
+
* Limitations:
|
|
8668
|
+
* - The instance must be in the Running state.
|
|
8669
|
+
* - The instance must be a standard replica set instance or a sharded cluster instance.
|
|
8538
8670
|
*
|
|
8539
8671
|
* @param request - RestartNodeRequest
|
|
8540
8672
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8584,13 +8716,12 @@ class Client extends openapi_core_1.default {
|
|
|
8584
8716
|
return $dara.cast(await this.callApi(params, req, runtime), new $_model.RestartNodeResponse({}));
|
|
8585
8717
|
}
|
|
8586
8718
|
/**
|
|
8587
|
-
* Restarts a node
|
|
8719
|
+
* Restarts a single node of a MongoDB instance.
|
|
8588
8720
|
*
|
|
8589
8721
|
* @remarks
|
|
8590
|
-
*
|
|
8591
|
-
*
|
|
8592
|
-
*
|
|
8593
|
-
* * The instance is a replica set or sharded cluster instance of the standard edition.
|
|
8722
|
+
* Limitations:
|
|
8723
|
+
* - The instance must be in the Running state.
|
|
8724
|
+
* - The instance must be a standard replica set instance or a sharded cluster instance.
|
|
8594
8725
|
*
|
|
8595
8726
|
* @param request - RestartNodeRequest
|
|
8596
8727
|
* @returns RestartNodeResponse
|
|
@@ -8605,8 +8736,8 @@ class Client extends openapi_core_1.default {
|
|
|
8605
8736
|
* @remarks
|
|
8606
8737
|
* The instance must be running when you call this operation.
|
|
8607
8738
|
* >
|
|
8608
|
-
*
|
|
8609
|
-
*
|
|
8739
|
+
* - This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.
|
|
8740
|
+
* - On replica set instances, the switch is performed between instances. On sharded cluster instances, the switch is performed between shards.
|
|
8610
8741
|
*
|
|
8611
8742
|
* @param request - SwitchDBInstanceHARequest
|
|
8612
8743
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8661,8 +8792,8 @@ class Client extends openapi_core_1.default {
|
|
|
8661
8792
|
* @remarks
|
|
8662
8793
|
* The instance must be running when you call this operation.
|
|
8663
8794
|
* >
|
|
8664
|
-
*
|
|
8665
|
-
*
|
|
8795
|
+
* - This operation is applicable to replica set instances and sharded cluster instances, but cannot be performed on standalone instances.
|
|
8796
|
+
* - On replica set instances, the switch is performed between instances. On sharded cluster instances, the switch is performed between shards.
|
|
8666
8797
|
*
|
|
8667
8798
|
* @param request - SwitchDBInstanceHARequest
|
|
8668
8799
|
* @returns SwitchDBInstanceHAResponse
|
|
@@ -8676,11 +8807,11 @@ class Client extends openapi_core_1.default {
|
|
|
8676
8807
|
*
|
|
8677
8808
|
* @remarks
|
|
8678
8809
|
* 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.
|
|
8679
|
-
*
|
|
8680
|
-
*
|
|
8681
|
-
*
|
|
8682
|
-
*
|
|
8683
|
-
*
|
|
8810
|
+
* - 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.
|
|
8811
|
+
* - If the tag that you specify does not exist, this tag is automatically created and bound to the specified instance.
|
|
8812
|
+
* - If a tag that has the same key is already bound to the instance, the new tag overwrites the existing tag.
|
|
8813
|
+
* - You can bind up to 20 tags to each instance.
|
|
8814
|
+
* - You can bind tags to up to 50 instances each time you call the operation.
|
|
8684
8815
|
*
|
|
8685
8816
|
* @param request - TagResourcesRequest
|
|
8686
8817
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8737,11 +8868,11 @@ class Client extends openapi_core_1.default {
|
|
|
8737
8868
|
*
|
|
8738
8869
|
* @remarks
|
|
8739
8870
|
* 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.
|
|
8740
|
-
*
|
|
8741
|
-
*
|
|
8742
|
-
*
|
|
8743
|
-
*
|
|
8744
|
-
*
|
|
8871
|
+
* - 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.
|
|
8872
|
+
* - If the tag that you specify does not exist, this tag is automatically created and bound to the specified instance.
|
|
8873
|
+
* - If a tag that has the same key is already bound to the instance, the new tag overwrites the existing tag.
|
|
8874
|
+
* - You can bind up to 20 tags to each instance.
|
|
8875
|
+
* - You can bind tags to up to 50 instances each time you call the operation.
|
|
8745
8876
|
*
|
|
8746
8877
|
* @param request - TagResourcesRequest
|
|
8747
8878
|
* @returns TagResourcesResponse
|
|
@@ -8754,8 +8885,8 @@ class Client extends openapi_core_1.default {
|
|
|
8754
8885
|
* 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.
|
|
8755
8886
|
*
|
|
8756
8887
|
* @remarks
|
|
8757
|
-
*
|
|
8758
|
-
*
|
|
8888
|
+
* - 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.
|
|
8889
|
+
* - 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.
|
|
8759
8890
|
*
|
|
8760
8891
|
* @param request - TransferClusterBackupRequest
|
|
8761
8892
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8799,8 +8930,8 @@ class Client extends openapi_core_1.default {
|
|
|
8799
8930
|
* 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.
|
|
8800
8931
|
*
|
|
8801
8932
|
* @remarks
|
|
8802
|
-
*
|
|
8803
|
-
*
|
|
8933
|
+
* - 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.
|
|
8934
|
+
* - 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.
|
|
8804
8935
|
*
|
|
8805
8936
|
* @param request - TransferClusterBackupRequest
|
|
8806
8937
|
* @returns TransferClusterBackupResponse
|
|
@@ -8815,9 +8946,9 @@ class Client extends openapi_core_1.default {
|
|
|
8815
8946
|
* @remarks
|
|
8816
8947
|
* 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
|
|
8817
8948
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8818
|
-
*
|
|
8819
|
-
*
|
|
8820
|
-
*
|
|
8949
|
+
* - The instance is in the Running state.
|
|
8950
|
+
* - Your instance has no unpaid billing method change orders.
|
|
8951
|
+
* - 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).
|
|
8821
8952
|
* > 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.
|
|
8822
8953
|
*
|
|
8823
8954
|
* @param request - TransformInstanceChargeTypeRequest
|
|
@@ -8885,9 +9016,9 @@ class Client extends openapi_core_1.default {
|
|
|
8885
9016
|
* @remarks
|
|
8886
9017
|
* 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
|
|
8887
9018
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8888
|
-
*
|
|
8889
|
-
*
|
|
8890
|
-
*
|
|
9019
|
+
* - The instance is in the Running state.
|
|
9020
|
+
* - Your instance has no unpaid billing method change orders.
|
|
9021
|
+
* - 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).
|
|
8891
9022
|
* > 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.
|
|
8892
9023
|
*
|
|
8893
9024
|
* @param request - TransformInstanceChargeTypeRequest
|
|
@@ -8904,11 +9035,11 @@ class Client extends openapi_core_1.default {
|
|
|
8904
9035
|
* 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).
|
|
8905
9036
|
* A subscription instance cannot be changed to a pay-as-you-go instance. To avoid wasting resources, proceed with caution.
|
|
8906
9037
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8907
|
-
*
|
|
8908
|
-
*
|
|
8909
|
-
*
|
|
8910
|
-
*
|
|
8911
|
-
* >
|
|
9038
|
+
* - The instance is in the running state.
|
|
9039
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
9040
|
+
* - The instance has no unpaid subscription orders.
|
|
9041
|
+
* - 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).
|
|
9042
|
+
* > 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.
|
|
8912
9043
|
*
|
|
8913
9044
|
* @param request - TransformToPrePaidRequest
|
|
8914
9045
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -8970,11 +9101,11 @@ class Client extends openapi_core_1.default {
|
|
|
8970
9101
|
* 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).
|
|
8971
9102
|
* A subscription instance cannot be changed to a pay-as-you-go instance. To avoid wasting resources, proceed with caution.
|
|
8972
9103
|
* Before you call this API operation, make sure that the ApsaraDB for MongoDB instance meets the following requirements:
|
|
8973
|
-
*
|
|
8974
|
-
*
|
|
8975
|
-
*
|
|
8976
|
-
*
|
|
8977
|
-
* >
|
|
9104
|
+
* - The instance is in the running state.
|
|
9105
|
+
* - The billing method of the instance is pay-as-you-go.
|
|
9106
|
+
* - The instance has no unpaid subscription orders.
|
|
9107
|
+
* - 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).
|
|
9108
|
+
* > 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.
|
|
8978
9109
|
*
|
|
8979
9110
|
* @param request - TransformToPrePaidRequest
|
|
8980
9111
|
* @returns TransformToPrePaidResponse
|
|
@@ -8988,8 +9119,8 @@ class Client extends openapi_core_1.default {
|
|
|
8988
9119
|
*
|
|
8989
9120
|
* @remarks
|
|
8990
9121
|
* >
|
|
8991
|
-
*
|
|
8992
|
-
*
|
|
9122
|
+
* - You can remove up to 20 tags at a time.
|
|
9123
|
+
* - If you remove a tag from all instances, the tag is automatically deleted.
|
|
8993
9124
|
*
|
|
8994
9125
|
* @param request - UntagResourcesRequest
|
|
8995
9126
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9049,8 +9180,8 @@ class Client extends openapi_core_1.default {
|
|
|
9049
9180
|
*
|
|
9050
9181
|
* @remarks
|
|
9051
9182
|
* >
|
|
9052
|
-
*
|
|
9053
|
-
*
|
|
9183
|
+
* - You can remove up to 20 tags at a time.
|
|
9184
|
+
* - If you remove a tag from all instances, the tag is automatically deleted.
|
|
9054
9185
|
*
|
|
9055
9186
|
* @param request - UntagResourcesRequest
|
|
9056
9187
|
* @returns UntagResourcesResponse
|
|
@@ -9064,9 +9195,11 @@ class Client extends openapi_core_1.default {
|
|
|
9064
9195
|
*
|
|
9065
9196
|
* @remarks
|
|
9066
9197
|
* The instance must be in the running state when you call this operation.
|
|
9067
|
-
* >
|
|
9068
|
-
* >
|
|
9069
|
-
* >
|
|
9198
|
+
* > - 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.
|
|
9199
|
+
* >
|
|
9200
|
+
* > - You cannot downgrade the MongoDB version of an instance after you upgrade it.
|
|
9201
|
+
* >
|
|
9202
|
+
* > - 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.
|
|
9070
9203
|
*
|
|
9071
9204
|
* @param request - UpgradeDBInstanceEngineVersionRequest
|
|
9072
9205
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -9117,9 +9250,11 @@ class Client extends openapi_core_1.default {
|
|
|
9117
9250
|
*
|
|
9118
9251
|
* @remarks
|
|
9119
9252
|
* The instance must be in the running state when you call this operation.
|
|
9120
|
-
* >
|
|
9121
|
-
* >
|
|
9122
|
-
* >
|
|
9253
|
+
* > - 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.
|
|
9254
|
+
* >
|
|
9255
|
+
* > - You cannot downgrade the MongoDB version of an instance after you upgrade it.
|
|
9256
|
+
* >
|
|
9257
|
+
* > - 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.
|
|
9123
9258
|
*
|
|
9124
9259
|
* @param request - UpgradeDBInstanceEngineVersionRequest
|
|
9125
9260
|
* @returns UpgradeDBInstanceEngineVersionResponse
|