MongodbClient (tencentcloud-sdk-java 3.0.106 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)` 构造client
`MongodbClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssignProjectResponse`	`AssignProject(AssignProjectRequest req)` 本接口(AssignProject)用于指定云数据库实例的所属项目。
`CreateDBInstanceResponse`	`CreateDBInstance(CreateDBInstanceRequest req)` 本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
`CreateDBInstanceHourResponse`	`CreateDBInstanceHour(CreateDBInstanceHourRequest req)` 本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。
`DescribeBackupAccessResponse`	`DescribeBackupAccess(DescribeBackupAccessRequest req)` 本接口（DescribeBackupAccess）用于获取备份文件的下载授权，具体的备份文件信息可通过查询实例备份列表（DescribeDBBackups）接口获取
`DescribeClientConnectionsResponse`	`DescribeClientConnections(DescribeClientConnectionsRequest req)` 本接口(DescribeClientConnections)用于查询实例客户端连接信息，包括连接IP和连接数量。目前只支持3.2版本的MongoDB实例。
`DescribeDBBackupsResponse`	`DescribeDBBackups(DescribeDBBackupsRequest req)` 本接口（DescribeDBBackups）用于查询实例备份列表，目前只支持7天内的备份查询。
`DescribeDBInstancesResponse`	`DescribeDBInstances(DescribeDBInstancesRequest req)` 本接口(DescribeDBInstances)用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。
`DescribeSpecInfoResponse`	`DescribeSpecInfo(DescribeSpecInfoRequest req)` 本接口(DescribeSpecInfo)用于查询实例的售卖规格。
`IsolateDBInstanceResponse`	`IsolateDBInstance(IsolateDBInstanceRequest req)` 本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中，不能再写入数据。隔离一定时间后，实例会彻底删除，回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复，请谨慎操作。
`ModifyDBInstanceSpecResponse`	`ModifyDBInstanceSpec(ModifyDBInstanceSpecRequest req)` 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
`OfflineIsolatedDBInstanceResponse`	`OfflineIsolatedDBInstance(OfflineIsolatedDBInstanceRequest req)` 本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态。
`RenameInstanceResponse`	`RenameInstance(RenameInstanceRequest req)` 本接口(RenameInstance)用于修改云数据库实例的名称。

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)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
  - MongodbClient
```
public MongodbClient(Credential credential,
                     String region,
                     ClientProfile profile)
```
    构造client
    
    Parameters:
    
    credential - 认证信息实例
    
    region - 产品地域
    
    profile - 配置实例
- Method Detail
  - AssignProject
```
public AssignProjectResponse AssignProject(AssignProjectRequest req)
                                    throws TencentCloudSDKException
```
    本接口(AssignProject)用于指定云数据库实例的所属项目。
    
    Parameters:
    
    req - AssignProjectRequest
    
    Returns:
    
    AssignProjectResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDBInstance
```
public CreateDBInstanceResponse CreateDBInstance(CreateDBInstanceRequest req)
                                          throws TencentCloudSDKException
```
    本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
    
    Parameters:
    
    req - CreateDBInstanceRequest
    
    Returns:
    
    CreateDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateDBInstanceHour
```
public CreateDBInstanceHourResponse CreateDBInstanceHour(CreateDBInstanceHourRequest req)
                                                  throws TencentCloudSDKException
```
    本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。
    
    Parameters:
    
    req - CreateDBInstanceHourRequest
    
    Returns:
    
    CreateDBInstanceHourResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeBackupAccess
```
public DescribeBackupAccessResponse DescribeBackupAccess(DescribeBackupAccessRequest req)
                                                  throws TencentCloudSDKException
```
    本接口（DescribeBackupAccess）用于获取备份文件的下载授权，具体的备份文件信息可通过查询实例备份列表（DescribeDBBackups）接口获取
    
    Parameters:
    
    req - DescribeBackupAccessRequest
    
    Returns:
    
    DescribeBackupAccessResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClientConnections
```
public DescribeClientConnectionsResponse DescribeClientConnections(DescribeClientConnectionsRequest req)
                                                            throws TencentCloudSDKException
```
    本接口(DescribeClientConnections)用于查询实例客户端连接信息，包括连接IP和连接数量。目前只支持3.2版本的MongoDB实例。
    
    Parameters:
    
    req - DescribeClientConnectionsRequest
    
    Returns:
    
    DescribeClientConnectionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBBackups
```
public DescribeDBBackupsResponse DescribeDBBackups(DescribeDBBackupsRequest req)
                                            throws TencentCloudSDKException
```
    本接口（DescribeDBBackups）用于查询实例备份列表，目前只支持7天内的备份查询。
    
    Parameters:
    
    req - DescribeDBBackupsRequest
    
    Returns:
    
    DescribeDBBackupsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBInstances
```
public DescribeDBInstancesResponse DescribeDBInstances(DescribeDBInstancesRequest req)
                                                throws TencentCloudSDKException
```
    本接口(DescribeDBInstances)用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。
    
    Parameters:
    
    req - DescribeDBInstancesRequest
    
    Returns:
    
    DescribeDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSpecInfo
```
public DescribeSpecInfoResponse DescribeSpecInfo(DescribeSpecInfoRequest req)
                                          throws TencentCloudSDKException
```
    本接口(DescribeSpecInfo)用于查询实例的售卖规格。
    
    Parameters:
    
    req - DescribeSpecInfoRequest
    
    Returns:
    
    DescribeSpecInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - IsolateDBInstance
```
public IsolateDBInstanceResponse IsolateDBInstance(IsolateDBInstanceRequest req)
                                            throws TencentCloudSDKException
```
    本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中，不能再写入数据。隔离一定时间后，实例会彻底删除，回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复，请谨慎操作。
    
    Parameters:
    
    req - IsolateDBInstanceRequest
    
    Returns:
    
    IsolateDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyDBInstanceSpec
```
public ModifyDBInstanceSpecResponse ModifyDBInstanceSpec(ModifyDBInstanceSpecRequest req)
                                                  throws TencentCloudSDKException
```
    本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
    
    Parameters:
    
    req - ModifyDBInstanceSpecRequest
    
    Returns:
    
    ModifyDBInstanceSpecResponse
    
    Throws:
    
    TencentCloudSDKException
  - OfflineIsolatedDBInstance
```
public OfflineIsolatedDBInstanceResponse OfflineIsolatedDBInstance(OfflineIsolatedDBInstanceRequest req)
                                                            throws TencentCloudSDKException
```
    本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态。
    
    Parameters:
    
    req - OfflineIsolatedDBInstanceRequest
    
    Returns:
    
    OfflineIsolatedDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - RenameInstance
```
public RenameInstanceResponse RenameInstance(RenameInstanceRequest req)
                                      throws TencentCloudSDKException
```
    本接口(RenameInstance)用于修改云数据库实例的名称。
    
    Parameters:
    
    req - RenameInstanceRequest
    
    Returns:
    
    RenameInstanceResponse
    
    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

CreateDBInstance

CreateDBInstanceHour

DescribeBackupAccess

DescribeClientConnections

DescribeDBBackups

DescribeDBInstances

DescribeSpecInfo

IsolateDBInstance

ModifyDBInstanceSpec

OfflineIsolatedDBInstance

RenameInstance