MongodbClient (tencentcloud-sdk-java 3.0.120 API)

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

public class MongodbClient
extends AbstractClient

字段概要
- 从类继承的字段 com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

构造器概要

构造器
构造器和说明
`MongodbClient(Credential credential, String region)`
`MongodbClient(Credential credential, String region, ClientProfile profile)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`AssignProjectResponse`	`AssignProject(AssignProjectRequest req)` 本接口(AssignProject)用于指定云数据库实例的所属项目。
`CreateDBInstanceResponse`	`CreateDBInstance(CreateDBInstanceRequest req)` 本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。
`CreateDBInstanceHourResponse`	`CreateDBInstanceHour(CreateDBInstanceHourRequest req)` 本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。
`DescribeBackupAccessResponse`	`DescribeBackupAccess(DescribeBackupAccessRequest req)` 本接口（DescribeBackupAccess）用于获取备份文件的下载授权，具体的备份文件信息可通过查询实例备份列表（DescribeDBBackups）接口获取
`DescribeClientConnectionsResponse`	`DescribeClientConnections(DescribeClientConnectionsRequest req)` 本接口(DescribeClientConnections)用于查询实例客户端连接信息，包括连接IP和连接数量。
`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云数据库实例配置。
`OfflineIsolatedDBInstanceResponse`	`OfflineIsolatedDBInstance(OfflineIsolatedDBInstanceRequest req)` 本接口(OfflineIsolatedInstances)用于立即下线隔离状态的云数据库实例。
`RenameInstanceResponse`	`RenameInstance(RenameInstanceRequest req)` 本接口(RenameInstance)用于修改云数据库实例的名称。

从类继承的方法 com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, setClientProfile, setCredential, setRegion

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

类 MongodbClient

字段概要

从类继承的字段 com.tencentcloudapi.common.AbstractClient

构造器概要

方法概要

从类继承的方法 com.tencentcloudapi.common.AbstractClient

从类继承的方法 java.lang.Object

构造器详细资料

MongodbClient

MongodbClient

方法详细资料

AssignProject

CreateDBInstance

CreateDBInstanceHour

DescribeBackupAccess

DescribeClientConnections

DescribeDBBackups

DescribeDBInstances

DescribeSpecInfo

IsolateDBInstance

ModifyDBInstanceSpec

OfflineIsolatedDBInstance

RenameInstance