MongodbClient (tencentcloud-sdk-java-intl-en 3.0.1247 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.mongodb.v20190725.MongodbClient

public class MongodbClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`MongodbClient(Credential credential, String region)`
`MongodbClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssignProjectResponse`	`AssignProject(AssignProjectRequest req)` This API is used to specify the project of a TencentDB for MongoDB instance.
`CreateBackupDBInstanceResponse`	`CreateBackupDBInstance(CreateBackupDBInstanceRequest req)` This API is used to back up an instance.
`CreateBackupDownloadTaskResponse`	`CreateBackupDownloadTask(CreateBackupDownloadTaskRequest req)` This API is used to create a backup download task.
`CreateDBInstanceResponse`	`CreateDBInstance(CreateDBInstanceRequest req)` This API is used to create a yearly/monthly subscription TencentDB for MongoDB instance.
`CreateDBInstanceHourResponse`	`CreateDBInstanceHour(CreateDBInstanceHourRequest req)` This API is used to create a pay-as-you-go TencentDB for MongoDB instance.
`DescribeAsyncRequestInfoResponse`	`DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)` This API is used to query the asynchronous task status.
`DescribeBackupDownloadTaskResponse`	`DescribeBackupDownloadTask(DescribeBackupDownloadTaskRequest req)` This API is used to query information about the backup download task.
`DescribeClientConnectionsResponse`	`DescribeClientConnections(DescribeClientConnectionsRequest req)` This API is used to query the client connection information on an instance, including the IP address for connection and the number of connections.
`DescribeDBBackupsResponse`	`DescribeDBBackups(DescribeDBBackupsRequest req)` This API is used to query the list of instance backups.
`DescribeDBInstanceDealResponse`	`DescribeDBInstanceDeal(DescribeDBInstanceDealRequest req)` This API is used to get order details of purchase, renewal, and specification adjustment of a MongoDB instance.
`DescribeDBInstanceNamespaceResponse`	`DescribeDBInstanceNamespace(DescribeDBInstanceNamespaceRequest req)` This API is used to query the table information on a database.
`DescribeDBInstanceNodePropertyResponse`	`DescribeDBInstanceNodeProperty(DescribeDBInstanceNodePropertyRequest req)` This API is used to query node attributes, such as the AZ, node name, address, role, status, delay between primary and secondary nodes, priority, voting right, and tags.
`DescribeDBInstancesResponse`	`DescribeDBInstances(DescribeDBInstancesRequest req)` This API is used to query the list of TencentDB for MongoDB instances.
`DescribeDetailedSlowLogsResponse`	`DescribeDetailedSlowLogs(DescribeDetailedSlowLogsRequest req)` This API is used to query slow log details of the instance.
`DescribeInstanceParamsResponse`	`DescribeInstanceParams(DescribeInstanceParamsRequest req)` This API is used to query the list of parameters that can be modified for the current instance.
`DescribeSecurityGroupResponse`	`DescribeSecurityGroup(DescribeSecurityGroupRequest req)` This API is used to query security groups bound to an instance.
`DescribeSlowLogPatternsResponse`	`DescribeSlowLogPatterns(DescribeSlowLogPatternsRequest req)` This API is used to get the slow log statistics of a database instance.
`DescribeSlowLogsResponse`	`DescribeSlowLogs(DescribeSlowLogsRequest req)` This API is used to get the slow log information of a TencentDB instance.
`DescribeSpecInfoResponse`	`DescribeSpecInfo(DescribeSpecInfoRequest req)` This API is used to query the sales specification of an instance.
`FlushInstanceRouterConfigResponse`	`FlushInstanceRouterConfig(FlushInstanceRouterConfigRequest req)` This API is used to run the `FlushRouterConfig` command on all mongos instances.
`InquirePriceCreateDBInstancesResponse`	`InquirePriceCreateDBInstances(InquirePriceCreateDBInstancesRequest req)` This API is used to query price of instance creation.
`InquirePriceModifyDBInstanceSpecResponse`	`InquirePriceModifyDBInstanceSpec(InquirePriceModifyDBInstanceSpecRequest req)` This API is used to query the price of instance specification adjustment.
`InquirePriceRenewDBInstancesResponse`	`InquirePriceRenewDBInstances(InquirePriceRenewDBInstancesRequest req)` This API is used to query the renewal price of a monthly subscription instance.
`IsolateDBInstanceResponse`	`IsolateDBInstance(IsolateDBInstanceRequest req)` This API is used to isolate a pay-as-you-go TencentDB for MongoDB instance.
`ModifyDBInstanceNetworkAddressResponse`	`ModifyDBInstanceNetworkAddress(ModifyDBInstanceNetworkAddressRequest req)` This API is used to modify the network information on a TencentDB for MongoDB instance.
`ModifyDBInstanceSecurityGroupResponse`	`ModifyDBInstanceSecurityGroup(ModifyDBInstanceSecurityGroupRequest req)` This API is used to modify security groups bound to an instance.
`ModifyDBInstanceSpecResponse`	`ModifyDBInstanceSpec(ModifyDBInstanceSpecRequest req)` This API is used to adjust the TencentDB for MongoDB instance configuration.
`OfflineIsolatedDBInstanceResponse`	`OfflineIsolatedDBInstance(OfflineIsolatedDBInstanceRequest req)` This API is used to deactivate isolated TencentDB instances immediately.
`RenameInstanceResponse`	`RenameInstance(RenameInstanceRequest req)` This API is used to rename a TencentDB instance.
`RenewDBInstancesResponse`	`RenewDBInstances(RenewDBInstancesRequest req)` This API is used to renew a monthly subscription TencentDB instance.
`ResetDBInstancePasswordResponse`	`ResetDBInstancePassword(ResetDBInstancePasswordRequest req)` This API is used to reset the instance access password.
`SetDBInstanceDeletionProtectionResponse`	`SetDBInstanceDeletionProtection(SetDBInstanceDeletionProtectionRequest req)` This API is used to set instance termination protection.
`TerminateDBInstancesResponse`	`TerminateDBInstances(TerminateDBInstancesRequest req)` This API is used to terminate monthly subscription billing instances.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MongodbClient
```
public MongodbClient(Credential credential,
                     String region)
```
  - MongodbClient
```
public MongodbClient(Credential credential,
                     String region,
                     ClientProfile profile)
```
- Method Detail
  - AssignProject
```
public AssignProjectResponse AssignProject(AssignProjectRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to specify the project of a TencentDB for MongoDB instance.
    
    Parameters:
    
    req - AssignProjectRequest
    
    Returns:
    
    AssignProjectResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateBackupDBInstance
```
public CreateBackupDBInstanceResponse CreateBackupDBInstance(CreateBackupDBInstanceRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to back up an instance.
    
    Parameters:
    
    req - CreateBackupDBInstanceRequest
    
    Returns:
    
    CreateBackupDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateBackupDownloadTask
```
public CreateBackupDownloadTaskResponse CreateBackupDownloadTask(CreateBackupDownloadTaskRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to create a backup download task.
    
    Parameters:
    
    req - CreateBackupDownloadTaskRequest
    
    Returns:
    
    CreateBackupDownloadTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDBInstance
```
public CreateDBInstanceResponse CreateDBInstance(CreateDBInstanceRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to create a yearly/monthly subscription TencentDB for MongoDB instance. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/35767?from_cn_redirect=1) API can be called to query and obtain the supported sales specifications.
    
    Parameters:
    
    req - CreateDBInstanceRequest
    
    Returns:
    
    CreateDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDBInstanceHour
```
public CreateDBInstanceHourResponse CreateDBInstanceHour(CreateDBInstanceHourRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to create a pay-as-you-go TencentDB for MongoDB instance.
    
    Parameters:
    
    req - CreateDBInstanceHourRequest
    
    Returns:
    
    CreateDBInstanceHourResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAsyncRequestInfo
```
public DescribeAsyncRequestInfoResponse DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to query the asynchronous task status.
    
    Parameters:
    
    req - DescribeAsyncRequestInfoRequest
    
    Returns:
    
    DescribeAsyncRequestInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeBackupDownloadTask
```
public DescribeBackupDownloadTaskResponse DescribeBackupDownloadTask(DescribeBackupDownloadTaskRequest req)
                                                              throws TencentCloudSDKException
```
    This API is used to query information about the backup download task.
    
    Parameters:
    
    req - DescribeBackupDownloadTaskRequest
    
    Returns:
    
    DescribeBackupDownloadTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClientConnections
```
public DescribeClientConnectionsResponse DescribeClientConnections(DescribeClientConnectionsRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to query the client connection information on an instance, including the IP address for connection and the number of connections.
    
    Parameters:
    
    req - DescribeClientConnectionsRequest
    
    Returns:
    
    DescribeClientConnectionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBBackups
```
public DescribeDBBackupsResponse DescribeDBBackups(DescribeDBBackupsRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to query the list of instance backups. Currently, only backups created in the last seven days can be queried.
    
    Parameters:
    
    req - DescribeDBBackupsRequest
    
    Returns:
    
    DescribeDBBackupsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBInstanceDeal
```
public DescribeDBInstanceDealResponse DescribeDBInstanceDeal(DescribeDBInstanceDealRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to get order details of purchase, renewal, and specification adjustment of a MongoDB instance.
    
    Parameters:
    
    req - DescribeDBInstanceDealRequest
    
    Returns:
    
    DescribeDBInstanceDealResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBInstanceNamespace
```
public DescribeDBInstanceNamespaceResponse DescribeDBInstanceNamespace(DescribeDBInstanceNamespaceRequest req)
                                                                throws TencentCloudSDKException
```
    This API is used to query the table information on a database.
    
    Parameters:
    
    req - DescribeDBInstanceNamespaceRequest
    
    Returns:
    
    DescribeDBInstanceNamespaceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBInstanceNodeProperty
```
public DescribeDBInstanceNodePropertyResponse DescribeDBInstanceNodeProperty(DescribeDBInstanceNodePropertyRequest req)
                                                                      throws TencentCloudSDKException
```
    This API is used to query node attributes, such as the AZ, node name, address, role, status, delay between primary and secondary nodes, priority, voting right, and tags.
    
    Parameters:
    
    req - DescribeDBInstanceNodePropertyRequest
    
    Returns:
    
    DescribeDBInstanceNodePropertyResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBInstances
```
public DescribeDBInstancesResponse DescribeDBInstances(DescribeDBInstancesRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to query the list of TencentDB for MongoDB instances. It supports filtering primary instances, disaster recovery instances, and read-only instances by project ID, instance ID, instance status, and other conditions.
    
    Parameters:
    
    req - DescribeDBInstancesRequest
    
    Returns:
    
    DescribeDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDetailedSlowLogs
```
public DescribeDetailedSlowLogsResponse DescribeDetailedSlowLogs(DescribeDetailedSlowLogsRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to query slow log details of the instance.
    
    Parameters:
    
    req - DescribeDetailedSlowLogsRequest
    
    Returns:
    
    DescribeDetailedSlowLogsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeInstanceParams
```
public DescribeInstanceParamsResponse DescribeInstanceParams(DescribeInstanceParamsRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to query the list of parameters that can be modified for the current instance.
    
    Parameters:
    
    req - DescribeInstanceParamsRequest
    
    Returns:
    
    DescribeInstanceParamsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSecurityGroup
```
public DescribeSecurityGroupResponse DescribeSecurityGroup(DescribeSecurityGroupRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to query security groups bound to an instance.
    
    Parameters:
    
    req - DescribeSecurityGroupRequest
    
    Returns:
    
    DescribeSecurityGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSlowLogPatterns
```
public DescribeSlowLogPatternsResponse DescribeSlowLogPatterns(DescribeSlowLogPatternsRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to get the slow log statistics of a database instance.
    
    Parameters:
    
    req - DescribeSlowLogPatternsRequest
    
    Returns:
    
    DescribeSlowLogPatternsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSlowLogs
```
public DescribeSlowLogsResponse DescribeSlowLogs(DescribeSlowLogsRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to get the slow log information of a TencentDB instance. Only slow logs for the last 7 days can be queried.
    
    Parameters:
    
    req - DescribeSlowLogsRequest
    
    Returns:
    
    DescribeSlowLogsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSpecInfo
```
public DescribeSpecInfoResponse DescribeSpecInfo(DescribeSpecInfoRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to query the sales specification of an instance.
    
    Parameters:
    
    req - DescribeSpecInfoRequest
    
    Returns:
    
    DescribeSpecInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - FlushInstanceRouterConfig
```
public FlushInstanceRouterConfigResponse FlushInstanceRouterConfig(FlushInstanceRouterConfigRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to run the `FlushRouterConfig` command on all mongos instances.
    
    Parameters:
    
    req - FlushInstanceRouterConfigRequest
    
    Returns:
    
    FlushInstanceRouterConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquirePriceCreateDBInstances
```
public InquirePriceCreateDBInstancesResponse InquirePriceCreateDBInstances(InquirePriceCreateDBInstancesRequest req)
                                                                    throws TencentCloudSDKException
```
    This API is used to query price of instance creation. The `region` parameter must be passed in this API, otherwise verification will fail. This API allows queries only for purchasable instance specifications.
    
    Parameters:
    
    req - InquirePriceCreateDBInstancesRequest
    
    Returns:
    
    InquirePriceCreateDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquirePriceModifyDBInstanceSpec
```
public InquirePriceModifyDBInstanceSpecResponse InquirePriceModifyDBInstanceSpec(InquirePriceModifyDBInstanceSpecRequest req)
                                                                          throws TencentCloudSDKException
```
    This API is used to query the price of instance specification adjustment.
    
    Parameters:
    
    req - InquirePriceModifyDBInstanceSpecRequest
    
    Returns:
    
    InquirePriceModifyDBInstanceSpecResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquirePriceRenewDBInstances
```
public InquirePriceRenewDBInstancesResponse InquirePriceRenewDBInstances(InquirePriceRenewDBInstancesRequest req)
                                                                  throws TencentCloudSDKException
```
    This API is used to query the renewal price of a monthly subscription instance.
    
    Parameters:
    
    req - InquirePriceRenewDBInstancesRequest
    
    Returns:
    
    InquirePriceRenewDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - IsolateDBInstance
```
public IsolateDBInstanceResponse IsolateDBInstance(IsolateDBInstanceRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to isolate a pay-as-you-go TencentDB for MongoDB instance. After isolation, the instance is retained in the recycle bin, and data cannot be written into it. After a certain period of isolation, the instance is deleted permanently. For the retention time in the recycle bin, see the pay-as-you-go service terms. The deleted pay-as-you-go instance cannot be recovered. Proceed with caution.
    
    Parameters:
    
    req - IsolateDBInstanceRequest
    
    Returns:
    
    IsolateDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDBInstanceNetworkAddress
```
public ModifyDBInstanceNetworkAddressResponse ModifyDBInstanceNetworkAddress(ModifyDBInstanceNetworkAddressRequest req)
                                                                      throws TencentCloudSDKException
```
    This API is used to modify the network information on a TencentDB for MongoDB instance. It supports switching from a basic network to a VPC network or from one VPC network to another VPC network.
    
    Parameters:
    
    req - ModifyDBInstanceNetworkAddressRequest
    
    Returns:
    
    ModifyDBInstanceNetworkAddressResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDBInstanceSecurityGroup
```
public ModifyDBInstanceSecurityGroupResponse ModifyDBInstanceSecurityGroup(ModifyDBInstanceSecurityGroupRequest req)
                                                                    throws TencentCloudSDKException
```
    This API is used to modify security groups bound to an instance.
    
    Parameters:
    
    req - ModifyDBInstanceSecurityGroupRequest
    
    Returns:
    
    ModifyDBInstanceSecurityGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDBInstanceSpec
```
public ModifyDBInstanceSpecResponse ModifyDBInstanceSpec(ModifyDBInstanceSpecRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to adjust the TencentDB for MongoDB instance configuration. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to query and obtain the supported sales specifications.
    
    Parameters:
    
    req - ModifyDBInstanceSpecRequest
    
    Returns:
    
    ModifyDBInstanceSpecResponse
    
    Throws:
    
    TencentCloudSDKException
  - OfflineIsolatedDBInstance
```
public OfflineIsolatedDBInstanceResponse OfflineIsolatedDBInstance(OfflineIsolatedDBInstanceRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to deactivate isolated TencentDB instances immediately. The instances must be in isolated status.
    
    Parameters:
    
    req - OfflineIsolatedDBInstanceRequest
    
    Returns:
    
    OfflineIsolatedDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - RenameInstance
```
public RenameInstanceResponse RenameInstance(RenameInstanceRequest req)
                                      throws TencentCloudSDKException
```
    This API is used to rename a TencentDB instance.
    
    Parameters:
    
    req - RenameInstanceRequest
    
    Returns:
    
    RenameInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - RenewDBInstances
```
public RenewDBInstancesResponse RenewDBInstances(RenewDBInstancesRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to renew a monthly subscription TencentDB instance. Only monthly subscription instances are supported, while pay-as-you-go instances do not need to be renewed.
    
    Parameters:
    
    req - RenewDBInstancesRequest
    
    Returns:
    
    RenewDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResetDBInstancePassword
```
public ResetDBInstancePasswordResponse ResetDBInstancePassword(ResetDBInstancePasswordRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to reset the instance access password.
    
    Parameters:
    
    req - ResetDBInstancePasswordRequest
    
    Returns:
    
    ResetDBInstancePasswordResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetDBInstanceDeletionProtection
```
public SetDBInstanceDeletionProtectionResponse SetDBInstanceDeletionProtection(SetDBInstanceDeletionProtectionRequest req)
                                                                        throws TencentCloudSDKException
```
    This API is used to set instance termination protection.
    
    Parameters:
    
    req - SetDBInstanceDeletionProtectionRequest
    
    Returns:
    
    SetDBInstanceDeletionProtectionResponse
    
    Throws:
    
    TencentCloudSDKException
  - TerminateDBInstances
```
public TerminateDBInstancesResponse TerminateDBInstances(TerminateDBInstancesRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to terminate monthly subscription billing instances.
    
    Parameters:
    
    req - TerminateDBInstancesRequest
    
    Returns:
    
    TerminateDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException

Class MongodbClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

MongodbClient

MongodbClient

Method Detail

AssignProject

CreateBackupDBInstance

CreateBackupDownloadTask

CreateDBInstance

CreateDBInstanceHour

DescribeAsyncRequestInfo

DescribeBackupDownloadTask

DescribeClientConnections

DescribeDBBackups

DescribeDBInstanceDeal

DescribeDBInstanceNamespace

DescribeDBInstanceNodeProperty

DescribeDBInstances

DescribeDetailedSlowLogs

DescribeInstanceParams

DescribeSecurityGroup

DescribeSlowLogPatterns

DescribeSlowLogs

DescribeSpecInfo

FlushInstanceRouterConfig

InquirePriceCreateDBInstances

InquirePriceModifyDBInstanceSpec

InquirePriceRenewDBInstances

IsolateDBInstance

ModifyDBInstanceNetworkAddress

ModifyDBInstanceSecurityGroup

ModifyDBInstanceSpec

OfflineIsolatedDBInstance

RenameInstance

RenewDBInstances

ResetDBInstancePassword

SetDBInstanceDeletionProtection

TerminateDBInstances