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