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.
CreateDBInstanceHourResponse	CreateDBInstanceHour(CreateDBInstanceHourRequest req) This API is used to create a pay-as-you-go TencentDB for MongoDB instance.
DescribeBackupAccessResponse	DescribeBackupAccess(DescribeBackupAccessRequest req) This API is used to get the permission to download a backup file.
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.
DescribeDBInstancesResponse	DescribeDBInstances(DescribeDBInstancesRequest req) This API is used to query the list of TencentDB instances (which can be master, disaster recovery, or read-only instances).
DescribeSpecInfoResponse	DescribeSpecInfo(DescribeSpecInfoRequest req) This API is used to query the purchasable instance specifications.
IsolateDBInstanceResponse	IsolateDBInstance(IsolateDBInstanceRequest req) This API is used to isolate a pay-as-you-go TencentDB for MongoDB 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.

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

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

DescribeBackupAccess

public DescribeBackupAccessResponse DescribeBackupAccess(DescribeBackupAccessRequest req)
                                                  throws TencentCloudSDKException

This API is used to get the permission to download a backup file. The specific backup file information can be obtained through the DescribeDBBackups API.

Parameters:

req - DescribeBackupAccessRequest

Returns:

DescribeBackupAccessResponse

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 in the last 7 days can be queried.

Parameters:

req - DescribeDBBackupsRequest

Returns:

DescribeDBBackupsResponse

Throws:

TencentCloudSDKException

DescribeDBInstances

public DescribeDBInstancesResponse DescribeDBInstances(DescribeDBInstancesRequest req)
                                                throws TencentCloudSDKException

This API is used to query the list of TencentDB instances (which can be master, 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

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

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

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