com.tencentcloudapi.mongodb.v20190725

Class MongodbClient

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

Modifier and Type	Method and Description
AssignProjectResponse	AssignProject(AssignProjectRequest req) This API is used to specify the project to which a TencentDB instance belongs.
CreateBackupDBInstanceResponse	CreateBackupDBInstance(CreateBackupDBInstanceRequest req) This API is used to create instance backups.
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 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 async task status.
DescribeBackupAccessResponse	DescribeBackupAccess(DescribeBackupAccessRequest req) 备份下载功能已调整，此接口即将下线 TencentDB will soon stop supporting this API as the backup download feature has been modified.
DescribeBackupDownloadTaskResponse	DescribeBackupDownloadTask(DescribeBackupDownloadTaskRequest req) This API is used to query backup download task information.
DescribeClientConnectionsResponse	DescribeClientConnections(DescribeClientConnectionsRequest req) This API is used to query the client connection information of an instance, including the IP and 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 details of purchase, renewal, and specification adjustment orders of a MongoDB instance.
DescribeDBInstancesResponse	DescribeDBInstances(DescribeDBInstancesRequest req) This API is used to query the list of TencentDB instances (which can be primary, disaster recovery, or read-only instances).
DescribeInstanceParamsResponse	DescribeInstanceParams(DescribeInstanceParamsRequest req) This API is used to query the modifiable parameter list of an instance.
DescribeSecurityGroupResponse	DescribeSecurityGroup(DescribeSecurityGroupRequest req) This API is used to query the security groups associated with 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 purchasable instance specifications.
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 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 settings of a TencentDB instance, such as switching its network type from classic network to VPC or between VPCs.
ModifyDBInstanceSecurityGroupResponse	ModifyDBInstanceSecurityGroup(ModifyDBInstanceSecurityGroupRequest req) This API is used to modify the security groups associated with an instance.
ModifyDBInstanceSpecResponse	ModifyDBInstanceSpec(ModifyDBInstanceSpecRequest req) This API is used to adjust the specification configuration of a TencentDB for MongoDB.
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 modify instance password.

Methods inherited from class com.tencentcloudapi.common.AbstractClient

call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

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 to which a TencentDB instance belongs.

Parameters:

req - AssignProjectRequest

Returns:

AssignProjectResponse

Throws:

TencentCloudSDKException

CreateBackupDBInstance

public CreateBackupDBInstanceResponse CreateBackupDBInstance(CreateBackupDBInstanceRequest req)
                                                      throws TencentCloudSDKException

This API is used to create instance backups.

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 monthly subscription TencentDB for MongoDB instance. The purchasable specifications supported by this API can be obtained through the `DescribeSpecInfo` API.

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 async task status.

Parameters:

req - DescribeAsyncRequestInfoRequest

Returns:

DescribeAsyncRequestInfoResponse

Throws:

TencentCloudSDKException

DescribeBackupAccess

public DescribeBackupAccessResponse DescribeBackupAccess(DescribeBackupAccessRequest req)
                                                  throws TencentCloudSDKException

备份下载功能已调整，此接口即将下线 TencentDB will soon stop supporting this API as the backup download feature has been modified. This API is used to get the permission to download a backup file. The detailed backup file information can be obtained through the `DescribeDBBackups` API.

Parameters:

req - DescribeBackupAccessRequest

Returns:

DescribeBackupAccessResponse

Throws:

TencentCloudSDKException

DescribeBackupDownloadTask

public DescribeBackupDownloadTaskResponse DescribeBackupDownloadTask(DescribeBackupDownloadTaskRequest req)
                                                              throws TencentCloudSDKException

This API is used to query backup download task information.

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 of an instance, including the IP and number of connections. Currently, only instances of MongoDB 3.2 are supported.

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 details of purchase, renewal, and specification adjustment orders of a MongoDB instance.

Parameters:

req - DescribeDBInstanceDealRequest

Returns:

DescribeDBInstanceDealResponse

Throws:

TencentCloudSDKException

DescribeDBInstances

public DescribeDBInstancesResponse DescribeDBInstances(DescribeDBInstancesRequest req)
                                                throws TencentCloudSDKException

This API is used to query the list of TencentDB instances (which can be primary, disaster recovery, or read-only instances). It supports filtering instances by project ID, instance ID, and instance status.

Parameters:

req - DescribeDBInstancesRequest

Returns:

DescribeDBInstancesResponse

Throws:

TencentCloudSDKException

DescribeInstanceParams

public DescribeInstanceParamsResponse DescribeInstanceParams(DescribeInstanceParamsRequest req)
                                                      throws TencentCloudSDKException

This API is used to query the modifiable parameter list of an instance.

Parameters:

req - DescribeInstanceParamsRequest

Returns:

DescribeInstanceParamsResponse

Throws:

TencentCloudSDKException

DescribeSecurityGroup

public DescribeSecurityGroupResponse DescribeSecurityGroup(DescribeSecurityGroupRequest req)
                                                    throws TencentCloudSDKException

This API is used to query the security groups associated with 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 purchasable instance specifications.

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 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. An isolated instance is retained in the recycle bin and data can no longer be written to it. After it is isolated for a certain period of time, it will be completely deleted. For the retention period in the recycle bin, please see the terms of service for pay-as-you-go billing. Isolated pay-as-you-go instances cannot be recovered, so please 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 settings of a TencentDB instance, such as switching its network type from classic network to VPC or between VPCs.

Parameters:

req - ModifyDBInstanceNetworkAddressRequest

Returns:

ModifyDBInstanceNetworkAddressResponse

Throws:

TencentCloudSDKException

ModifyDBInstanceSecurityGroup

public ModifyDBInstanceSecurityGroupResponse ModifyDBInstanceSecurityGroup(ModifyDBInstanceSecurityGroupRequest req)
                                                                    throws TencentCloudSDKException

This API is used to modify the security groups associated with an instance.

Parameters:

req - ModifyDBInstanceSecurityGroupRequest

Returns:

ModifyDBInstanceSecurityGroupResponse

Throws:

TencentCloudSDKException

ModifyDBInstanceSpec

public ModifyDBInstanceSpecResponse ModifyDBInstanceSpec(ModifyDBInstanceSpecRequest req)
                                                  throws TencentCloudSDKException

This API is used to adjust the specification configuration of a TencentDB for MongoDB. The purchasable specifications supported by the API can be obtained through the DescribeSpecInfo API.

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 modify instance password.

Parameters:

req - ResetDBInstancePasswordRequest

Returns:

ResetDBInstancePasswordResponse

Throws:

TencentCloudSDKException