client

package
v1.66.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 8, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type RedisClient

type RedisClient struct {
	core.JDCloudClient
}

func NewRedisClient

func NewRedisClient(credential *core.Credential) *RedisClient

func (*RedisClient) AddWhiteListGroup added in v1.65.0

增加白名单分组,用于用户管理不同类型或者来源的 IP 白名单。

func (*RedisClient) CancelTask added in v1.65.0

func (c *RedisClient) CancelTask(request *redis.CancelTaskRequest) (*redis.CancelTaskResponse, error)

取消定时任务

func (*RedisClient) CheckDeletable added in v1.65.0

func (c *RedisClient) CheckDeletable(request *redis.CheckDeletableRequest) (*redis.CheckDeletableResponse, error)

检查实例是否可以被安全删除

func (*RedisClient) CheckPasswordValid added in v1.65.0

检查密码是否有效

func (*RedisClient) ClientKill added in v1.59.0

func (c *RedisClient) ClientKill(request *redis.ClientKillRequest) (*redis.ClientKillResponse, error)

关闭4.0实例客户端连接

func (*RedisClient) ConfigDiagnosePolicy added in v1.65.0

批量配置实例的自动诊断策略,包括是否开启自动诊断、诊断时间和诊断周期

func (*RedisClient) ConfigOverrideMetric added in v1.65.0

为指定实例配置诊断指标的自定义阈值,覆盖默认的诊断指标配置

func (*RedisClient) CreateAccount added in v1.56.0

func (c *RedisClient) CreateAccount(request *redis.CreateAccountRequest) (*redis.CreateAccountResponse, error)

创建账号

func (*RedisClient) CreateBackup added in v1.12.0

func (c *RedisClient) CreateBackup(request *redis.CreateBackupRequest) (*redis.CreateBackupResponse, error)

创建并执行缓存Redis实例的备份任务,只能为手动备份,可设置备份文件名称

func (*RedisClient) CreateBigKeyAnalysis added in v1.56.0

创建大key分析任务

func (*RedisClient) CreateBigKeyAnalysis2 added in v1.57.0

创建大key分析任务

func (*RedisClient) CreateCacheAnalysis added in v1.20.0

创建缓存分析任务,一天最多创建12次分析任务

func (*RedisClient) CreateCacheInstance

创建一个指定配置的缓存Redis实例:可选择版本、类型、规格(按CPU核数、内存容量、磁盘容量、带宽等划分),自定义分片规格可通过describeSpecConfig接口获取,老规格代码请参考,https://docs.jdcloud.com/cn/jcs-for-redis/specifications

func (*RedisClient) CreateConfigTemplate added in v1.65.0

创建配置模板

func (*RedisClient) CreateOfflineAnalysisTask added in v1.65.0

创建redis实例离线数据分析任务

func (*RedisClient) DeleteAccount added in v1.56.0

func (c *RedisClient) DeleteAccount(request *redis.DeleteAccountRequest) (*redis.DeleteAccountResponse, error)

删除账号

func (*RedisClient) DeleteCacheInstance

删除按配置计费、或包年包月已到期的缓存Redis实例,包年包月未到期不可删除。

只有处于运行running或者错误error状态才可以删除,其余状态不可以删除。 白名单用户不能删除包年包月已到期的缓存Redis实例。

func (*RedisClient) DeleteConfigTemplate added in v1.65.0

删除配置模板

func (*RedisClient) DeleteRecycledCacheInstance added in v1.65.0

强制销毁执行软删除后的实例,例如回收站的实例,注意:该删除操作不涉及交易计费模块,仅删除实例。

func (*RedisClient) DeleteWhiteListGroup added in v1.65.0

删除指定的白名单分组。

func (*RedisClient) DescribeAccounts added in v1.56.0

查询账号信息

func (*RedisClient) DescribeAnalysisThreshold added in v1.56.0

查询缓存分析阈值

func (*RedisClient) DescribeAnalysisThreshold2 added in v1.57.0

查询缓存分析阈值

func (*RedisClient) DescribeAnalysisTime added in v1.20.0

获取自动缓存分析时间

func (*RedisClient) DescribeAvailableRegion added in v1.56.0

查询支持的地域列表

func (*RedisClient) DescribeAvailableResource added in v1.56.0

查询支持的规格列表

func (*RedisClient) DescribeAvailableResource2 added in v1.57.0

查询支持的规格列表

func (*RedisClient) DescribeAvailableSentinelList added in v1.65.0

查询可用的共享哨兵列表

func (*RedisClient) DescribeBackupInfo added in v1.65.0

查询缓存Redis实例的备份详情

func (*RedisClient) DescribeBackupPolicy added in v1.12.0

查询缓存Redis实例的自动备份策略

func (*RedisClient) DescribeBackups added in v1.12.0

查询缓存Redis实例的备份任务(文件)列表,可分页、可指定起止时间或备份任务ID

func (*RedisClient) DescribeBigKeyAnalysisTime added in v1.56.0

获取大key自动缓存分析时间

func (*RedisClient) DescribeBigKeyAnalysisTime2 added in v1.57.0

获取大key自动缓存分析时间

func (*RedisClient) DescribeBigKeyDetail added in v1.56.0

查询大key分析详情

func (*RedisClient) DescribeBigKeyDetail2 added in v1.57.0

查询大key分析详情

func (*RedisClient) DescribeBigKeyList added in v1.56.0

查询大key分析任务列表

func (*RedisClient) DescribeBigKeyList2 added in v1.57.0

查询大key分析任务列表

func (*RedisClient) DescribeCacheAnalysisList added in v1.20.0

查询缓存分析任务列表

func (*RedisClient) DescribeCacheAnalysisResult added in v1.20.0

查询缓存分析任务详情,最多查询到30天前的数据

func (*RedisClient) DescribeCacheInstance

查询缓存Redis实例的详细信息

func (*RedisClient) DescribeCacheInstances

查询缓存Redis实例列表,可分页、可排序、可搜索、可过滤

func (*RedisClient) DescribeChartReleases added in v1.65.0

查询缓存Redis chart版本发布记录

func (*RedisClient) DescribeClearData added in v1.56.0

查询数据清理任务进度

func (*RedisClient) DescribeClientIpDetail added in v1.44.0

查询指定客户端IP的连接详细信息

func (*RedisClient) DescribeClientList added in v1.44.0

查询当前客户端IP列表

func (*RedisClient) DescribeClusterInfo added in v1.10.0

查询Redis实例的集群内部信息

func (*RedisClient) DescribeConfigModifyHistory added in v1.65.0

获取实例参数修改历史,可分页、可搜索

func (*RedisClient) DescribeConfigTemplate added in v1.65.0

获取配置模板详情

func (*RedisClient) DescribeConfigTemplates added in v1.65.0

获取配置模板列表

func (*RedisClient) DescribeDetailNodeList added in v1.65.0

获取缓存Redis实例的节点列表,可分页、可搜索

func (*RedisClient) DescribeDownloadUrl added in v1.12.0

获取缓存Redis实例的备份文件临时下载地址(1个小时有效期)

func (*RedisClient) DescribeHotKeyDetail added in v1.58.0

查询热key分析详情

func (*RedisClient) DescribeHotKeyDetail2 added in v1.57.0

查询热key分析详情

func (*RedisClient) DescribeHotKeyResult2 added in v1.57.0

查询热key分析结果

func (*RedisClient) DescribeHotKeySummary added in v1.58.0

查询热key分析结果汇总

func (*RedisClient) DescribeImageReleases added in v1.65.0

查询缓存Redis镜像版本发布记录

func (*RedisClient) DescribeInstanceClass

查询缓存Redis实例的规格列表

func (*RedisClient) DescribeInstanceConfig added in v1.12.0

查看缓存Redis实例的当前配置参数

func (*RedisClient) DescribeInstanceTLS added in v1.65.0

查询tls配置

func (*RedisClient) DescribeIpWhiteList added in v1.20.0

获取Redis实例的IP白名单(只有白名单内的IP、网络才能访问该实例)

func (*RedisClient) DescribeOfflineAnalysisOverview added in v1.65.0

查询redis实例离线分析总览

func (*RedisClient) DescribeOfflineAnalysisTime added in v1.65.0

获取离线自动缓存分析时间

func (*RedisClient) DescribeOfflineAnalysisTopKeyPrefixList added in v1.65.0

查询redis实例离线分析top key前缀列表

func (*RedisClient) DescribeOfflineAnalysisTopKeys added in v1.65.0

查询redis实例离线分析key列表

func (*RedisClient) DescribeProxySlowLog added in v1.65.0

获取缓存Redis实例的代理慢日志,可分页、可按时间范围过滤

func (*RedisClient) DescribeRedisServerLog added in v1.65.0

查询redis服务端日志

func (*RedisClient) DescribeResizeModeIpTimeInfo added in v1.59.0

查询缓存Red4.0实例是否支持新变配功能,是否支持并行变配, 变配需要的IP数量及变配预估时间

func (*RedisClient) DescribeSentinelAvailableZones added in v1.65.0

查询哨兵节点可以迁移的可用区

func (*RedisClient) DescribeSlowLog added in v1.13.0

获取缓存Redis实例的慢查询日志,可分页、可搜索

func (*RedisClient) DescribeSpecConfig added in v1.20.0

查询缓存Redis实例的规格配置信息

func (*RedisClient) DescribeTaskProgressList added in v1.56.0

查询正在执行的任务进度列表

func (*RedisClient) DescribeUpgradeVersion added in v1.65.0

查询缓存Redis实例可升级的版本

func (*RedisClient) DescribeUserQuota

查询账户的缓存Redis配额信息

func (*RedisClient) DescribeWhiteListGroup added in v1.65.0

查看实例当前白名单。白名单是允许访问当前实例的IP/IP段列表,缺省情况下,白名单对本VPC开放。如果用户开启了外网访问的功能,还需要对外网的IP配置白名单。

func (*RedisClient) DisableLogger added in v1.13.0

func (c *RedisClient) DisableLogger()

func (*RedisClient) GetBackupFiles added in v1.65.0

func (c *RedisClient) GetBackupFiles(request *redis.GetBackupFilesRequest) (*redis.GetBackupFilesResponse, error)

查询历史备份文件

func (*RedisClient) GetDisableCommands added in v1.56.0

获取禁用命令列表

func (*RedisClient) GetMetric added in v1.65.0

func (c *RedisClient) GetMetric(request *redis.GetMetricRequest) (*redis.GetMetricResponse, error)

获取指定实例的指标数据,支持多种监控指标,时间范围最多支持近30天数据

func (*RedisClient) HaDiagnosis added in v1.65.0

func (c *RedisClient) HaDiagnosis(request *redis.HaDiagnosisRequest) (*redis.HaDiagnosisResponse, error)

实例高科用诊断

func (*RedisClient) ImportData added in v1.65.0

func (c *RedisClient) ImportData(request *redis.ImportDataRequest) (*redis.ImportDataResponse, error)

离线数据导入

func (*RedisClient) InterruptTask added in v1.65.0

func (c *RedisClient) InterruptTask(request *redis.InterruptTaskRequest) (*redis.InterruptTaskResponse, error)

中断任务

func (*RedisClient) JvesselV1Health added in v1.65.0

京舰V1实例健康状态

func (*RedisClient) JvesselV1ListMasterConfig added in v1.65.0

获取京舰V1 master参数

func (*RedisClient) JvesselV1ListProxyConfig added in v1.65.0

获取京舰V1 proxy参数

func (*RedisClient) JvesselV1ListSlaveConfig added in v1.65.0

获取京舰V1 slave参数

func (*RedisClient) JvesselV1ModifyProxyFlavor added in v1.65.0

修改京舰V1代理规格

func (*RedisClient) JvesselV1ModifyProxyReplica added in v1.65.0

修改京舰V1代理数量

func (*RedisClient) JvesselV1ProbeSuccessRate added in v1.65.0

京舰V1实例可用性监测

func (*RedisClient) JvesselV1ProxyInfo added in v1.65.0

获取京舰V1 proxy信息

func (*RedisClient) JvesselV1RollingUpdate added in v1.65.0

滚动升级京舰V1 redis镜像

func (*RedisClient) JvesselV1SetConfig added in v1.65.0

设置京舰V1参数

func (*RedisClient) JvesselV1UpdateProxyImage added in v1.65.0

修改京舰V1代理规格

func (*RedisClient) ListDisableCommands added in v1.65.0

获取支持被禁用的命令列表

func (*RedisClient) ListInstanceDiagnoseTasks added in v1.65.0

查询指定实例的诊断任务列表,支持时间范围过滤和分页

func (*RedisClient) ListModules added in v1.65.0

func (c *RedisClient) ListModules(request *redis.ListModulesRequest) (*redis.ListModulesResponse, error)

获取module列表

func (*RedisClient) ListOfflineAnalysis added in v1.65.0

查询redis离线分析任务列表

func (*RedisClient) ListPinDiagnoseTasks added in v1.65.0

查询当前用户下所有实例的诊断任务列表,支持按实例ID、实例名称、地域过滤

func (*RedisClient) ListTask added in v1.65.0

func (c *RedisClient) ListTask(request *redis.ListTaskRequest) (*redis.ListTaskResponse, error)

查询任务详情

func (*RedisClient) ListTaskTypes added in v1.65.0

func (c *RedisClient) ListTaskTypes(request *redis.ListTaskTypesRequest) (*redis.ListTaskTypesResponse, error)

获取任务类型列表

func (*RedisClient) ListTasks added in v1.65.0

func (c *RedisClient) ListTasks(request *redis.ListTasksRequest) (*redis.ListTasksResponse, error)

查询任务列表

func (*RedisClient) LoadModules added in v1.65.0

func (c *RedisClient) LoadModules(request *redis.LoadModulesRequest) (*redis.LoadModulesResponse, error)

加载module

func (*RedisClient) MaintenanceTime added in v1.65.0

修改运维时间

func (*RedisClient) ModifyAccount added in v1.56.0

func (c *RedisClient) ModifyAccount(request *redis.ModifyAccountRequest) (*redis.ModifyAccountResponse, error)

修改账号信息

func (*RedisClient) ModifyAccounts added in v1.57.0

func (c *RedisClient) ModifyAccounts(request *redis.ModifyAccountsRequest) (*redis.ModifyAccountsResponse, error)

批量修改账号信息

func (*RedisClient) ModifyAnalysisThreshold added in v1.56.0

设置缓存分析阈值

func (*RedisClient) ModifyAnalysisThreshold2 added in v1.57.0

设置缓存分析阈值

func (*RedisClient) ModifyAnalysisTime added in v1.20.0

设置自动缓存分析时间

func (*RedisClient) ModifyBackupPolicy added in v1.12.0

开启或更新缓存Redis实例的自动备份策略,可修改备份周期和备份时间

func (*RedisClient) ModifyBigKeyAnalysisTime added in v1.56.0

设置大key自动缓存分析时间

func (*RedisClient) ModifyBigKeyAnalysisTime2 added in v1.57.0

设置大key自动缓存分析时间

func (*RedisClient) ModifyBlockStatus added in v1.65.0

修改实例Block状态

func (*RedisClient) ModifyCacheInstanceAttribute

修改缓存Redis实例的资源名称或描述,二者至少选一

func (*RedisClient) ModifyCacheInstanceClass

变更缓存Redis实例规格(变配),实例运行时可以变配,新规格不能与之前的老规格相同,新规格内存大小不能小于实例的已使用内存

func (*RedisClient) ModifyInstanceConfig added in v1.12.0

修改缓存Redis实例的配置参数,支持部分配置参数修改

func (*RedisClient) ModifyInstanceMinorVersion added in v1.65.0

修改缓存Redis实例的小版本号

func (*RedisClient) ModifyInstanceNodeGroupVersion added in v1.65.0

修改缓存Redis实例指定节点组、分片的Redis镜像

func (*RedisClient) ModifyInstanceTLS added in v1.65.0

修改实例tls配置

func (*RedisClient) ModifyInstanceType added in v1.65.0

修改缓存Redis实例的架构类型,仅支持单分片集群架构的实例变更为原生集群架构

func (*RedisClient) ModifyInstanceVersion added in v1.65.0

修改缓存Redis实例Redis镜像

func (*RedisClient) ModifyIpWhiteList added in v1.20.0

修改Redis实例的IP白名单

func (*RedisClient) ModifyOfflineAnalysisTime added in v1.65.0

设置离线自动缓存分析时间

func (*RedisClient) ModifyProxyAvailableZones added in v1.65.0

迁移代理可用区

func (*RedisClient) ModifyPublicAddress added in v1.65.0

修改实例公网访问配置

func (*RedisClient) ModifyRedisAZSpecifyType added in v1.65.0

修改redis部署方式

func (*RedisClient) ModifyRedisAvailableZones added in v1.65.0

迁移Redis可用区

func (*RedisClient) ModifySentinel added in v1.65.0

func (c *RedisClient) ModifySentinel(request *redis.ModifySentinelRequest) (*redis.ModifySentinelResponse, error)

修改共享哨兵所使用的集群

func (*RedisClient) ModifySentinelAvailableZones added in v1.65.0

迁移哨兵可用区

func (*RedisClient) ModifyTaskRunTime added in v1.65.0

修改任务的执行时间

func (*RedisClient) ModifyTemplate added in v1.65.0

func (c *RedisClient) ModifyTemplate(request *redis.ModifyTemplateRequest) (*redis.ModifyTemplateResponse, error)

修改配置模板

func (*RedisClient) ModifyWhiteListGroup added in v1.65.0

修改允许访问实例的IP白名单。白名单是允许访问当前实例的IP/IP段列表,缺省情况下,白名单对本VPC开放。如果用户开启了外网访问的功能,还需要对外网的IP配置白名单。

func (*RedisClient) QueryDiagnosePolicy added in v1.65.0

批量查询实例的自动诊断配置信息

func (*RedisClient) RecoverInstance added in v1.65.0

恢复实例

func (*RedisClient) RecycledCacheInstance added in v1.65.0

查询回收站里缓存Redis实例列表,可分页、可排序、可搜索、可过滤

func (*RedisClient) ResetCacheInstancePassword

修改缓存Redis实例的密码,可为空

func (*RedisClient) RestartInstance added in v1.65.0

重启redis实例

func (*RedisClient) RestartProxy added in v1.59.0

func (c *RedisClient) RestartProxy(request *redis.RestartProxyRequest) (*redis.RestartProxyResponse, error)

重启4.0实例代理

func (*RedisClient) RestoreInstance added in v1.12.0

恢复缓存Redis实例的某次备份

func (*RedisClient) SetConfig

func (c *RedisClient) SetConfig(config *core.Config)

func (*RedisClient) SetDisableCommands added in v1.56.0

禁用redis命令

func (*RedisClient) SetExposeType added in v1.65.0

func (c *RedisClient) SetExposeType(request *redis.SetExposeTypeRequest) (*redis.SetExposeTypeResponse, error)

设置缓存Redis实例的外部访问方式

func (*RedisClient) SetLogger

func (c *RedisClient) SetLogger(logger core.Logger)

func (*RedisClient) StartClearData added in v1.56.0

func (c *RedisClient) StartClearData(request *redis.StartClearDataRequest) (*redis.StartClearDataResponse, error)

创建数据清理任务

func (*RedisClient) StopCacheAnalysis added in v1.56.0

停止缓存分析任务

func (*RedisClient) StopClearData added in v1.56.0

func (c *RedisClient) StopClearData(request *redis.StopClearDataRequest) (*redis.StopClearDataResponse, error)

停止数据清理任务

func (*RedisClient) SwitchInstanceHA added in v1.65.0

修改集群高可用分布

func (*RedisClient) UnloadModules added in v1.65.0

func (c *RedisClient) UnloadModules(request *redis.UnloadModulesRequest) (*redis.UnloadModulesResponse, error)

卸载module

func (*RedisClient) UserDiagnoseInstances added in v1.65.0

创建实例诊断任务,对指定的一个或多个实例进行健康诊断

func (*RedisClient) UserGetDiagnoseReport added in v1.65.0

获取指定诊断任务的详细报告,包括基本信息、诊断摘要、性能信息和慢日志

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL