MongodbClient (tencentcloud-sdk-java 3.1.314 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)` 本接口(AssignProject)用于指定云数据库实例的所属项目。
`CreateBackupDBInstanceResponse`	`CreateBackupDBInstance(CreateBackupDBInstanceRequest req)` 备份实例接口
`CreateBackupDownloadTaskResponse`	`CreateBackupDownloadTask(CreateBackupDownloadTaskRequest req)` 本接口用来创建某个备份文件的下载任务
`CreateDBInstanceResponse`	`CreateDBInstance(CreateDBInstanceRequest req)` 本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
`CreateDBInstanceHourResponse`	`CreateDBInstanceHour(CreateDBInstanceHourRequest req)` 本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。
`DescribeAsyncRequestInfoResponse`	`DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)` 查询异步任务状态接口
`DescribeBackupAccessResponse`	`DescribeBackupAccess(DescribeBackupAccessRequest req)` 备份下载功能已调整，此接口即将下线本接口（DescribeBackupAccess）用于获取备份文件的下载授权，具体的备份文件信息可通过查询实例备份列表（DescribeDBBackups）接口获取
`DescribeBackupDownloadTaskResponse`	`DescribeBackupDownloadTask(DescribeBackupDownloadTaskRequest req)` 查询备份下载任务信息
`DescribeClientConnectionsResponse`	`DescribeClientConnections(DescribeClientConnectionsRequest req)` 本接口(DescribeClientConnections)用于查询实例客户端连接信息，包括连接IP和连接数量。
`DescribeCurrentOpResponse`	`DescribeCurrentOp(DescribeCurrentOpRequest req)` 本接口(DescribeCurrentOp)用于查询MongoDB云数据库实例的当前正在执行的操作。
`DescribeDBBackupsResponse`	`DescribeDBBackups(DescribeDBBackupsRequest req)` 本接口（DescribeDBBackups）用于查询实例备份列表，目前只支持查询7天内的备份记录。
`DescribeDBInstanceDealResponse`	`DescribeDBInstanceDeal(DescribeDBInstanceDealRequest req)` 本接口（DescribeDBInstanceDeal）用于获取MongoDB购买、续费及变配订单详细。
`DescribeDBInstancesResponse`	`DescribeDBInstances(DescribeDBInstancesRequest req)` 本接口(DescribeDBInstances)用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。
`DescribeSecurityGroupResponse`	`DescribeSecurityGroup(DescribeSecurityGroupRequest req)` 查询实例绑定的安全组
`DescribeSlowLogPatternsResponse`	`DescribeSlowLogPatterns(DescribeSlowLogPatternsRequest req)` 本接口（DescribeSlowLogPatterns）用于获取数据库实例慢日志的统计信息。
`DescribeSlowLogsResponse`	`DescribeSlowLogs(DescribeSlowLogsRequest req)` 本接口（DescribeSlowLogs）用于获取云数据库慢日志信息。接口只支持查询最近7天内慢日志。
`DescribeSpecInfoResponse`	`DescribeSpecInfo(DescribeSpecInfoRequest req)` 本接口(DescribeSpecInfo)用于查询实例的售卖规格。
`FlushInstanceRouterConfigResponse`	`FlushInstanceRouterConfig(FlushInstanceRouterConfigRequest req)` 在所有mongos上执行FlushRouterConfig命令
`InquirePriceCreateDBInstancesResponse`	`InquirePriceCreateDBInstances(InquirePriceCreateDBInstancesRequest req)` 本接口用于创建数据库实例询价。本接口参数中必须传入region参数，否则无法通过校验。本接口仅允许针对购买限制范围内的实例配置进行询价。
`InquirePriceModifyDBInstanceSpecResponse`	`InquirePriceModifyDBInstanceSpec(InquirePriceModifyDBInstanceSpecRequest req)` 本接口 (InquirePriceModifyDBInstanceSpec) 用于调整实例的配置询价。
`InquirePriceRenewDBInstancesResponse`	`InquirePriceRenewDBInstances(InquirePriceRenewDBInstancesRequest req)` 本接口 (InquiryPriceRenewDBInstances) 用于续费包年包月实例询价。
`IsolateDBInstanceResponse`	`IsolateDBInstance(IsolateDBInstanceRequest req)` 本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中，不能再写入数据。隔离一定时间后，实例会彻底删除，回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复，请谨慎操作。
`KillOpsResponse`	`KillOps(KillOpsRequest req)` 本接口(KillOps)用于终止MongoDB云数据库实例上执行的特定操作。
`ModifyDBInstanceSpecResponse`	`ModifyDBInstanceSpec(ModifyDBInstanceSpecRequest req)` 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格，可从查询云数据库的售卖规格（DescribeSpecInfo）获取。
`OfflineIsolatedDBInstanceResponse`	`OfflineIsolatedDBInstance(OfflineIsolatedDBInstanceRequest req)` 本接口(OfflineIsolatedDBInstance)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态。
`RenameInstanceResponse`	`RenameInstance(RenameInstanceRequest req)` 本接口(RenameInstance)用于修改云数据库实例的名称。
`RenewDBInstancesResponse`	`RenewDBInstances(RenewDBInstancesRequest req)` 本接口(RenewDBInstance)用于续费云数据库实例，仅支持付费模式为包年包月的实例。按量计费实例不需要续费。
`ResetDBInstancePasswordResponse`	`ResetDBInstancePassword(ResetDBInstancePasswordRequest req)` 修改实例用户的密码

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, getClientProfile, getCredential, getRegion, internalRequest, retry, 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
```
    本接口(AssignProject)用于指定云数据库实例的所属项目。
    
    Parameters:
    
    req - AssignProjectRequest
    
    Returns:
    
    AssignProjectResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateBackupDBInstance
```
public CreateBackupDBInstanceResponse CreateBackupDBInstance(CreateBackupDBInstanceRequest req)
                                                      throws TencentCloudSDKException
```
    备份实例接口
    
    Parameters:
    
    req - CreateBackupDBInstanceRequest
    
    Returns:
    
    CreateBackupDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateBackupDownloadTask
```
public CreateBackupDownloadTaskResponse CreateBackupDownloadTask(CreateBackupDownloadTaskRequest req)
                                                          throws TencentCloudSDKException
```
    本接口用来创建某个备份文件的下载任务
    
    Parameters:
    
    req - CreateBackupDownloadTaskRequest
    
    Returns:
    
    CreateBackupDownloadTaskResponse
    
    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
  - DescribeAsyncRequestInfo
```
public DescribeAsyncRequestInfoResponse DescribeAsyncRequestInfo(DescribeAsyncRequestInfoRequest req)
                                                          throws TencentCloudSDKException
```
    查询异步任务状态接口
    
    Parameters:
    
    req - DescribeAsyncRequestInfoRequest
    
    Returns:
    
    DescribeAsyncRequestInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeBackupAccess
```
public DescribeBackupAccessResponse DescribeBackupAccess(DescribeBackupAccessRequest req)
                                                  throws TencentCloudSDKException
```
    备份下载功能已调整，此接口即将下线本接口（DescribeBackupAccess）用于获取备份文件的下载授权，具体的备份文件信息可通过查询实例备份列表（DescribeDBBackups）接口获取
    
    Parameters:
    
    req - DescribeBackupAccessRequest
    
    Returns:
    
    DescribeBackupAccessResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeBackupDownloadTask
```
public DescribeBackupDownloadTaskResponse DescribeBackupDownloadTask(DescribeBackupDownloadTaskRequest req)
                                                              throws TencentCloudSDKException
```
    查询备份下载任务信息
    
    Parameters:
    
    req - DescribeBackupDownloadTaskRequest
    
    Returns:
    
    DescribeBackupDownloadTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeClientConnections
```
public DescribeClientConnectionsResponse DescribeClientConnections(DescribeClientConnectionsRequest req)
                                                            throws TencentCloudSDKException
```
    本接口(DescribeClientConnections)用于查询实例客户端连接信息，包括连接IP和连接数量。
    
    Parameters:
    
    req - DescribeClientConnectionsRequest
    
    Returns:
    
    DescribeClientConnectionsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeCurrentOp
```
public DescribeCurrentOpResponse DescribeCurrentOp(DescribeCurrentOpRequest req)
                                            throws TencentCloudSDKException
```
    本接口(DescribeCurrentOp)用于查询MongoDB云数据库实例的当前正在执行的操作。
    
    Parameters:
    
    req - DescribeCurrentOpRequest
    
    Returns:
    
    DescribeCurrentOpResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBBackups
```
public DescribeDBBackupsResponse DescribeDBBackups(DescribeDBBackupsRequest req)
                                            throws TencentCloudSDKException
```
    本接口（DescribeDBBackups）用于查询实例备份列表，目前只支持查询7天内的备份记录。
    
    Parameters:
    
    req - DescribeDBBackupsRequest
    
    Returns:
    
    DescribeDBBackupsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBInstanceDeal
```
public DescribeDBInstanceDealResponse DescribeDBInstanceDeal(DescribeDBInstanceDealRequest req)
                                                      throws TencentCloudSDKException
```
    本接口（DescribeDBInstanceDeal）用于获取MongoDB购买、续费及变配订单详细。
    
    Parameters:
    
    req - DescribeDBInstanceDealRequest
    
    Returns:
    
    DescribeDBInstanceDealResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeDBInstances
```
public DescribeDBInstancesResponse DescribeDBInstances(DescribeDBInstancesRequest req)
                                                throws TencentCloudSDKException
```
    本接口(DescribeDBInstances)用于查询云数据库实例列表，支持通过项目ID、实例ID、实例状态等过滤条件来筛选实例。支持查询主实例、灾备实例和只读实例信息列表。
    
    Parameters:
    
    req - DescribeDBInstancesRequest
    
    Returns:
    
    DescribeDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSecurityGroup
```
public DescribeSecurityGroupResponse DescribeSecurityGroup(DescribeSecurityGroupRequest req)
                                                    throws TencentCloudSDKException
```
    查询实例绑定的安全组
    
    Parameters:
    
    req - DescribeSecurityGroupRequest
    
    Returns:
    
    DescribeSecurityGroupResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSlowLogPatterns
```
public DescribeSlowLogPatternsResponse DescribeSlowLogPatterns(DescribeSlowLogPatternsRequest req)
                                                        throws TencentCloudSDKException
```
    本接口（DescribeSlowLogPatterns）用于获取数据库实例慢日志的统计信息。
    
    Parameters:
    
    req - DescribeSlowLogPatternsRequest
    
    Returns:
    
    DescribeSlowLogPatternsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSlowLogs
```
public DescribeSlowLogsResponse DescribeSlowLogs(DescribeSlowLogsRequest req)
                                          throws TencentCloudSDKException
```
    本接口（DescribeSlowLogs）用于获取云数据库慢日志信息。接口只支持查询最近7天内慢日志。
    
    Parameters:
    
    req - DescribeSlowLogsRequest
    
    Returns:
    
    DescribeSlowLogsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSpecInfo
```
public DescribeSpecInfoResponse DescribeSpecInfo(DescribeSpecInfoRequest req)
                                          throws TencentCloudSDKException
```
    本接口(DescribeSpecInfo)用于查询实例的售卖规格。
    
    Parameters:
    
    req - DescribeSpecInfoRequest
    
    Returns:
    
    DescribeSpecInfoResponse
    
    Throws:
    
    TencentCloudSDKException
  - FlushInstanceRouterConfig
```
public FlushInstanceRouterConfigResponse FlushInstanceRouterConfig(FlushInstanceRouterConfigRequest req)
                                                            throws TencentCloudSDKException
```
    在所有mongos上执行FlushRouterConfig命令
    
    Parameters:
    
    req - FlushInstanceRouterConfigRequest
    
    Returns:
    
    FlushInstanceRouterConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquirePriceCreateDBInstances
```
public InquirePriceCreateDBInstancesResponse InquirePriceCreateDBInstances(InquirePriceCreateDBInstancesRequest req)
                                                                    throws TencentCloudSDKException
```
    本接口用于创建数据库实例询价。本接口参数中必须传入region参数，否则无法通过校验。本接口仅允许针对购买限制范围内的实例配置进行询价。
    
    Parameters:
    
    req - InquirePriceCreateDBInstancesRequest
    
    Returns:
    
    InquirePriceCreateDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquirePriceModifyDBInstanceSpec
```
public InquirePriceModifyDBInstanceSpecResponse InquirePriceModifyDBInstanceSpec(InquirePriceModifyDBInstanceSpecRequest req)
                                                                          throws TencentCloudSDKException
```
    本接口 (InquirePriceModifyDBInstanceSpec) 用于调整实例的配置询价。
    
    Parameters:
    
    req - InquirePriceModifyDBInstanceSpecRequest
    
    Returns:
    
    InquirePriceModifyDBInstanceSpecResponse
    
    Throws:
    
    TencentCloudSDKException
  - InquirePriceRenewDBInstances
```
public InquirePriceRenewDBInstancesResponse InquirePriceRenewDBInstances(InquirePriceRenewDBInstancesRequest req)
                                                                  throws TencentCloudSDKException
```
    本接口 (InquiryPriceRenewDBInstances) 用于续费包年包月实例询价。
    
    Parameters:
    
    req - InquirePriceRenewDBInstancesRequest
    
    Returns:
    
    InquirePriceRenewDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - IsolateDBInstance
```
public IsolateDBInstanceResponse IsolateDBInstance(IsolateDBInstanceRequest req)
                                            throws TencentCloudSDKException
```
    本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中，不能再写入数据。隔离一定时间后，实例会彻底删除，回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复，请谨慎操作。
    
    Parameters:
    
    req - IsolateDBInstanceRequest
    
    Returns:
    
    IsolateDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - KillOps
```
public KillOpsResponse KillOps(KillOpsRequest req)
                        throws TencentCloudSDKException
```
    本接口(KillOps)用于终止MongoDB云数据库实例上执行的特定操作。
    
    Parameters:
    
    req - KillOpsRequest
    
    Returns:
    
    KillOpsResponse
    
    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
```
    本接口(OfflineIsolatedDBInstance)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态。
    
    Parameters:
    
    req - OfflineIsolatedDBInstanceRequest
    
    Returns:
    
    OfflineIsolatedDBInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - RenameInstance
```
public RenameInstanceResponse RenameInstance(RenameInstanceRequest req)
                                      throws TencentCloudSDKException
```
    本接口(RenameInstance)用于修改云数据库实例的名称。
    
    Parameters:
    
    req - RenameInstanceRequest
    
    Returns:
    
    RenameInstanceResponse
    
    Throws:
    
    TencentCloudSDKException
  - RenewDBInstances
```
public RenewDBInstancesResponse RenewDBInstances(RenewDBInstancesRequest req)
                                          throws TencentCloudSDKException
```
    本接口(RenewDBInstance)用于续费云数据库实例，仅支持付费模式为包年包月的实例。按量计费实例不需要续费。
    
    Parameters:
    
    req - RenewDBInstancesRequest
    
    Returns:
    
    RenewDBInstancesResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResetDBInstancePassword
```
public ResetDBInstancePasswordResponse ResetDBInstancePassword(ResetDBInstancePasswordRequest req)
                                                        throws TencentCloudSDKException
```
    修改实例用户的密码
    
    Parameters:
    
    req - ResetDBInstancePasswordRequest
    
    Returns:
    
    ResetDBInstancePasswordResponse
    
    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

DescribeBackupAccess

DescribeBackupDownloadTask

DescribeClientConnections

DescribeCurrentOp

DescribeDBBackups

DescribeDBInstanceDeal

DescribeDBInstances

DescribeSecurityGroup

DescribeSlowLogPatterns

DescribeSlowLogs

DescribeSpecInfo

FlushInstanceRouterConfig

InquirePriceCreateDBInstances

InquirePriceModifyDBInstanceSpec

InquirePriceRenewDBInstances

IsolateDBInstance

KillOps

ModifyDBInstanceSpec

OfflineIsolatedDBInstance

RenameInstance

RenewDBInstances

ResetDBInstancePassword