RedisClient (tencentcloud-sdk-java 3.0.75 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.redis.v20180412.RedisClient

public class RedisClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`RedisClient(Credential credential, String region)` 构造client
`RedisClient(Credential credential, String region, ClientProfile profile)` 构造client

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CleanUpInstanceResponse`	`CleanUpInstance(CleanUpInstanceRequest req)` 回收站实例立即下线
`ClearInstanceResponse`	`ClearInstance(ClearInstanceRequest req)` 清空Redis实例的实例数据。
`CreateInstancesResponse`	`CreateInstances(CreateInstancesRequest req)` 创建redis实例
`DescribeAutoBackupConfigResponse`	`DescribeAutoBackupConfig(DescribeAutoBackupConfigRequest req)` 获取备份配置
`DescribeBackupUrlResponse`	`DescribeBackupUrl(DescribeBackupUrlRequest req)` 查询备份Rdb下载地址
`DescribeInstanceBackupsResponse`	`DescribeInstanceBackups(DescribeInstanceBackupsRequest req)` 查询 CRS 实例备份列表
`DescribeInstanceDealDetailResponse`	`DescribeInstanceDealDetail(DescribeInstanceDealDetailRequest req)` 查询订单信息
`DescribeInstanceParamRecordsResponse`	`DescribeInstanceParamRecords(DescribeInstanceParamRecordsRequest req)` 查询参数修改历史列表
`DescribeInstanceParamsResponse`	`DescribeInstanceParams(DescribeInstanceParamsRequest req)` 查询实例参数列表
`DescribeInstancesResponse`	`DescribeInstances(DescribeInstancesRequest req)` 查询Redis实例列表
`DescribeInstanceSecurityGroupResponse`	`DescribeInstanceSecurityGroup(DescribeInstanceSecurityGroupRequest req)` 查询实例安全组信息
`DescribeInstanceShardsResponse`	`DescribeInstanceShards(DescribeInstanceShardsRequest req)` 获取集群版实例分片信息
`DescribeProductInfoResponse`	`DescribeProductInfo(DescribeProductInfoRequest req)` 本接口查询指定可用区和实例类型下 Redis 的售卖规格，如果用户不在购买白名单中，将不能查询该可用区或该类型的售卖规格详情。申请购买某地域白名单可以提交工单
`DescribeProjectSecurityGroupResponse`	`DescribeProjectSecurityGroup(DescribeProjectSecurityGroupRequest req)` 查询项目安全组信息
`DescribeTaskInfoResponse`	`DescribeTaskInfo(DescribeTaskInfoRequest req)` 用于查询任务结果
`DestroyPostpaidInstanceResponse`	`DestroyPostpaidInstance(DestroyPostpaidInstanceRequest req)` 按量计费实例销毁
`DestroyPrepaidInstanceResponse`	`DestroyPrepaidInstance(DestroyPrepaidInstanceRequest req)` 包年包月实例退还
`DisableReplicaReadonlyResponse`	`DisableReplicaReadonly(DisableReplicaReadonlyRequest req)` 禁用读写分离
`EnableReplicaReadonlyResponse`	`EnableReplicaReadonly(EnableReplicaReadonlyRequest req)` 启用读写分离
`ManualBackupInstanceResponse`	`ManualBackupInstance(ManualBackupInstanceRequest req)` 手动备份Redis实例
`ModfiyInstancePasswordResponse`	`ModfiyInstancePassword(ModfiyInstancePasswordRequest req)` 修改redis密码
`ModifyAutoBackupConfigResponse`	`ModifyAutoBackupConfig(ModifyAutoBackupConfigRequest req)` 设置自动备份时间
`ModifyInstanceResponse`	`ModifyInstance(ModifyInstanceRequest req)` 修改实例相关信息（目前支持：实例重命名）
`ModifyInstanceParamsResponse`	`ModifyInstanceParams(ModifyInstanceParamsRequest req)` 修改实例参数
`ModifyNetworkConfigResponse`	`ModifyNetworkConfig(ModifyNetworkConfigRequest req)` 修改实例网络配置
`RenewInstanceResponse`	`RenewInstance(RenewInstanceRequest req)` 续费实例
`ResetPasswordResponse`	`ResetPassword(ResetPasswordRequest req)` 重置密码
`RestoreInstanceResponse`	`RestoreInstance(RestoreInstanceRequest req)` 恢复 CRS 实例
`UpgradeInstanceResponse`	`UpgradeInstance(UpgradeInstanceRequest req)` 升级实例

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

RedisClient

public RedisClient(Credential credential,
                   String region)

构造client

Parameters:: credential - 认证信息实例; region - 产品地域

RedisClient

public RedisClient(Credential credential,
                   String region,
                   ClientProfile profile)

构造client

Parameters:: credential - 认证信息实例; region - 产品地域; profile - 配置实例

Method Detail

CleanUpInstance

public CleanUpInstanceResponse CleanUpInstance(CleanUpInstanceRequest req)
                                        throws TencentCloudSDKException

回收站实例立即下线

Parameters:: req - CleanUpInstanceRequest
Returns:: CleanUpInstanceResponse
Throws:: TencentCloudSDKException

ClearInstance

public ClearInstanceResponse ClearInstance(ClearInstanceRequest req)
                                    throws TencentCloudSDKException

清空Redis实例的实例数据。

Parameters:: req - ClearInstanceRequest
Returns:: ClearInstanceResponse
Throws:: TencentCloudSDKException

CreateInstances

public CreateInstancesResponse CreateInstances(CreateInstancesRequest req)
                                        throws TencentCloudSDKException

创建redis实例

Parameters:: req - CreateInstancesRequest
Returns:: CreateInstancesResponse
Throws:: TencentCloudSDKException

DescribeAutoBackupConfig

public DescribeAutoBackupConfigResponse DescribeAutoBackupConfig(DescribeAutoBackupConfigRequest req)
                                                          throws TencentCloudSDKException

获取备份配置

Parameters:: req - DescribeAutoBackupConfigRequest
Returns:: DescribeAutoBackupConfigResponse
Throws:: TencentCloudSDKException

DescribeBackupUrl

public DescribeBackupUrlResponse DescribeBackupUrl(DescribeBackupUrlRequest req)
                                            throws TencentCloudSDKException

查询备份Rdb下载地址

Parameters:: req - DescribeBackupUrlRequest
Returns:: DescribeBackupUrlResponse
Throws:: TencentCloudSDKException

DescribeInstanceBackups

public DescribeInstanceBackupsResponse DescribeInstanceBackups(DescribeInstanceBackupsRequest req)
                                                        throws TencentCloudSDKException

查询 CRS 实例备份列表

Parameters:: req - DescribeInstanceBackupsRequest
Returns:: DescribeInstanceBackupsResponse
Throws:: TencentCloudSDKException

DescribeInstanceDealDetail

public DescribeInstanceDealDetailResponse DescribeInstanceDealDetail(DescribeInstanceDealDetailRequest req)
                                                              throws TencentCloudSDKException

查询订单信息

Parameters:: req - DescribeInstanceDealDetailRequest
Returns:: DescribeInstanceDealDetailResponse
Throws:: TencentCloudSDKException

DescribeInstanceParamRecords

public DescribeInstanceParamRecordsResponse DescribeInstanceParamRecords(DescribeInstanceParamRecordsRequest req)
                                                                  throws TencentCloudSDKException

查询参数修改历史列表

Parameters:: req - DescribeInstanceParamRecordsRequest
Returns:: DescribeInstanceParamRecordsResponse
Throws:: TencentCloudSDKException

DescribeInstanceParams

public DescribeInstanceParamsResponse DescribeInstanceParams(DescribeInstanceParamsRequest req)
                                                      throws TencentCloudSDKException

查询实例参数列表

Parameters:: req - DescribeInstanceParamsRequest
Returns:: DescribeInstanceParamsResponse
Throws:: TencentCloudSDKException

DescribeInstanceSecurityGroup

public DescribeInstanceSecurityGroupResponse DescribeInstanceSecurityGroup(DescribeInstanceSecurityGroupRequest req)
                                                                    throws TencentCloudSDKException

查询实例安全组信息

Parameters:: req - DescribeInstanceSecurityGroupRequest
Returns:: DescribeInstanceSecurityGroupResponse
Throws:: TencentCloudSDKException

DescribeInstanceShards

public DescribeInstanceShardsResponse DescribeInstanceShards(DescribeInstanceShardsRequest req)
                                                      throws TencentCloudSDKException

获取集群版实例分片信息

Parameters:: req - DescribeInstanceShardsRequest
Returns:: DescribeInstanceShardsResponse
Throws:: TencentCloudSDKException

DescribeInstances

public DescribeInstancesResponse DescribeInstances(DescribeInstancesRequest req)
                                            throws TencentCloudSDKException

查询Redis实例列表

Parameters:: req - DescribeInstancesRequest
Returns:: DescribeInstancesResponse
Throws:: TencentCloudSDKException

DescribeProductInfo
```
public DescribeProductInfoResponse DescribeProductInfo(DescribeProductInfoRequest req)
                                                throws TencentCloudSDKException
```
本接口查询指定可用区和实例类型下 Redis 的售卖规格，如果用户不在购买白名单中，将不能查询该可用区或该类型的售卖规格详情。申请购买某地域白名单可以提交工单

Parameters:

req - DescribeProductInfoRequest

Returns:

DescribeProductInfoResponse

Throws:

TencentCloudSDKException

DescribeProjectSecurityGroup

public DescribeProjectSecurityGroupResponse DescribeProjectSecurityGroup(DescribeProjectSecurityGroupRequest req)
                                                                  throws TencentCloudSDKException

查询项目安全组信息

Parameters:: req - DescribeProjectSecurityGroupRequest
Returns:: DescribeProjectSecurityGroupResponse
Throws:: TencentCloudSDKException

DescribeTaskInfo

public DescribeTaskInfoResponse DescribeTaskInfo(DescribeTaskInfoRequest req)
                                          throws TencentCloudSDKException

用于查询任务结果

Parameters:: req - DescribeTaskInfoRequest
Returns:: DescribeTaskInfoResponse
Throws:: TencentCloudSDKException

DestroyPostpaidInstance

public DestroyPostpaidInstanceResponse DestroyPostpaidInstance(DestroyPostpaidInstanceRequest req)
                                                        throws TencentCloudSDKException

按量计费实例销毁

Parameters:: req - DestroyPostpaidInstanceRequest
Returns:: DestroyPostpaidInstanceResponse
Throws:: TencentCloudSDKException

DestroyPrepaidInstance

public DestroyPrepaidInstanceResponse DestroyPrepaidInstance(DestroyPrepaidInstanceRequest req)
                                                      throws TencentCloudSDKException

包年包月实例退还

Parameters:: req - DestroyPrepaidInstanceRequest
Returns:: DestroyPrepaidInstanceResponse
Throws:: TencentCloudSDKException

DisableReplicaReadonly

public DisableReplicaReadonlyResponse DisableReplicaReadonly(DisableReplicaReadonlyRequest req)
                                                      throws TencentCloudSDKException

禁用读写分离

Parameters:: req - DisableReplicaReadonlyRequest
Returns:: DisableReplicaReadonlyResponse
Throws:: TencentCloudSDKException

EnableReplicaReadonly

public EnableReplicaReadonlyResponse EnableReplicaReadonly(EnableReplicaReadonlyRequest req)
                                                    throws TencentCloudSDKException

启用读写分离

Parameters:: req - EnableReplicaReadonlyRequest
Returns:: EnableReplicaReadonlyResponse
Throws:: TencentCloudSDKException

ManualBackupInstance

public ManualBackupInstanceResponse ManualBackupInstance(ManualBackupInstanceRequest req)
                                                  throws TencentCloudSDKException

手动备份Redis实例

Parameters:: req - ManualBackupInstanceRequest
Returns:: ManualBackupInstanceResponse
Throws:: TencentCloudSDKException

ModfiyInstancePassword

public ModfiyInstancePasswordResponse ModfiyInstancePassword(ModfiyInstancePasswordRequest req)
                                                      throws TencentCloudSDKException

修改redis密码

Parameters:: req - ModfiyInstancePasswordRequest
Returns:: ModfiyInstancePasswordResponse
Throws:: TencentCloudSDKException

ModifyAutoBackupConfig

public ModifyAutoBackupConfigResponse ModifyAutoBackupConfig(ModifyAutoBackupConfigRequest req)
                                                      throws TencentCloudSDKException

设置自动备份时间

Parameters:: req - ModifyAutoBackupConfigRequest
Returns:: ModifyAutoBackupConfigResponse
Throws:: TencentCloudSDKException

ModifyInstance
```
public ModifyInstanceResponse ModifyInstance(ModifyInstanceRequest req)
                                      throws TencentCloudSDKException
```
修改实例相关信息（目前支持：实例重命名）

Parameters:

req - ModifyInstanceRequest

Returns:

ModifyInstanceResponse

Throws:

TencentCloudSDKException

ModifyInstanceParams

public ModifyInstanceParamsResponse ModifyInstanceParams(ModifyInstanceParamsRequest req)
                                                  throws TencentCloudSDKException

修改实例参数

Parameters:: req - ModifyInstanceParamsRequest
Returns:: ModifyInstanceParamsResponse
Throws:: TencentCloudSDKException

ModifyNetworkConfig

public ModifyNetworkConfigResponse ModifyNetworkConfig(ModifyNetworkConfigRequest req)
                                                throws TencentCloudSDKException

修改实例网络配置

Parameters:: req - ModifyNetworkConfigRequest
Returns:: ModifyNetworkConfigResponse
Throws:: TencentCloudSDKException

RenewInstance

public RenewInstanceResponse RenewInstance(RenewInstanceRequest req)
                                    throws TencentCloudSDKException

续费实例

Parameters:: req - RenewInstanceRequest
Returns:: RenewInstanceResponse
Throws:: TencentCloudSDKException

ResetPassword

public ResetPasswordResponse ResetPassword(ResetPasswordRequest req)
                                    throws TencentCloudSDKException

重置密码

Parameters:: req - ResetPasswordRequest
Returns:: ResetPasswordResponse
Throws:: TencentCloudSDKException

RestoreInstance

public RestoreInstanceResponse RestoreInstance(RestoreInstanceRequest req)
                                        throws TencentCloudSDKException

恢复 CRS 实例

Parameters:: req - RestoreInstanceRequest
Returns:: RestoreInstanceResponse
Throws:: TencentCloudSDKException

UpgradeInstance

public UpgradeInstanceResponse UpgradeInstance(UpgradeInstanceRequest req)
                                        throws TencentCloudSDKException

升级实例

Parameters:: req - UpgradeInstanceRequest
Returns:: UpgradeInstanceResponse
Throws:: TencentCloudSDKException

Class RedisClient

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

RedisClient

RedisClient

Method Detail

CleanUpInstance

ClearInstance

CreateInstances

DescribeAutoBackupConfig

DescribeBackupUrl

DescribeInstanceBackups

DescribeInstanceDealDetail

DescribeInstanceParamRecords

DescribeInstanceParams

DescribeInstanceSecurityGroup

DescribeInstanceShards

DescribeInstances

DescribeProductInfo

DescribeProjectSecurityGroup

DescribeTaskInfo

DestroyPostpaidInstance

DestroyPrepaidInstance

DisableReplicaReadonly

EnableReplicaReadonly

ManualBackupInstance

ModfiyInstancePassword

ModifyAutoBackupConfig

ModifyInstance

ModifyInstanceParams

ModifyNetworkConfig

RenewInstance

ResetPassword

RestoreInstance

UpgradeInstance