jdcloud_sdk.services.redis.models package

Submodules

jdcloud_sdk.services.redis.models.AzId module

class jdcloud_sdk.services.redis.models.AzId.AzId(azSpecifyType=None, azsForCluster=None, master=None, slave=None)[source]

Bases: object

Parameters:
  • azSpecifyType – (Optional) AZ指定方式，SpecifyByReplicaGroup表示按副本组指定，SpecifyByCluster表示按整个集群指定
  • azsForCluster – (Optional) 为集群指定的AZ范围，按集群指定AZ时生效
  • master – (Optional) 缓存Redis主实例所在区域的可用区ID，按副本组指定AZ时生效
  • slave – (Optional) 缓存Redis从实例所在区域的可用区ID，按副本组指定AZ时生效

jdcloud_sdk.services.redis.models.AzIdSpec module

class jdcloud_sdk.services.redis.models.AzIdSpec.AzIdSpec(master, slave, azSpecifyType=None, azsForCluster=None)[source]

Bases: object

Parameters:
  • azSpecifyType – (Optional) AZ指定方式，SpecifyByReplicaGroup表示按副本组指定，SpecifyByCluster表示按整个集群指定
  • azsForCluster – (Optional) 为集群指定的AZ范围，按集群指定AZ时生效
  • master – 缓存Redis主实例所在的可用区ID，按副本组指定AZ时生效
  • slave – 缓存Redis从实例所在的可用区ID，按副本组指定AZ时生效

jdcloud_sdk.services.redis.models.Backup module

class jdcloud_sdk.services.redis.models.Backup.Backup(baseId, backupFileName, cacheInstanceId, backupStartTime, backupEndTime, backupType, backupSize, backupStatus, backupDownloadURL)[source]

Bases: object

Parameters:
  • baseId – 备份操作ID
  • backupFileName – 备份文件的名称
  • cacheInstanceId – 备份文件对应的实例ID
  • backupStartTime – 备份开始时间（ISO 8601标准的UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ）
  • backupEndTime – 备份结束时间（ISO 8601标准的UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ）
  • backupType – 备份类型，1表示手动备份，0表示自动备份
  • backupSize – 备份文件总字节大小，如果实例是集群版，则表示每个分片备份文件大小的总和
  • backupStatus – 备份任务状态状态，0表示备份中，1表示失败，2表示成功
  • backupDownloadURL – 备份文件下载地址（已废弃，调用获取备份文件下载地址接口获取）

jdcloud_sdk.services.redis.models.CacheInstance module

class jdcloud_sdk.services.redis.models.CacheInstance.CacheInstance(cacheInstanceId=None, cacheInstanceName=None, cacheInstanceClass=None, cacheInstanceMemoryMB=None, cacheInstanceStatus=None, cacheInstanceDescription=None, createTime=None, azId=None, vpcId=None, subnetId=None, connectionDomain=None, port=None, charge=None, instanceVersion=None, auth=None, isAllowNoAuth=None, redisVersion=None, cacheInstanceType=None, ipv6On=None, tags=None, resourceGroupId=None, shardNumber=None, memoryMBPerShard=None, extension=None, otherDomains=None, slaveAppendonly=None, databaseNum=None, maxmemoryPolicy=None, replicaNumber=None, enableSmartProxy=None, cpuArchType=None)[source]

Bases: object

Parameters:
  • cacheInstanceId – (Optional) 实例ID
  • cacheInstanceName – (Optional) 实例名称
  • cacheInstanceClass – (Optional) 规格代码，2.8、4.0标准版是实例规格，4.0自定义分片集群版实例表示单分片规格
  • cacheInstanceMemoryMB – (Optional) 实例的总内存（MB），表示用户购买的可使用内存
  • cacheInstanceStatus – (Optional) 实例状态：creating表示创建中，running表示运行中，error表示错误，changing表示变更规格中，deleting表示删除中，configuring表示修改参数中，restoring表示备份恢复中，upgrading表示升级中
  • cacheInstanceDescription – (Optional) 实例描述
  • createTime – (Optional) 创建时间（ISO 8601标准的UTC时间，格式为：YYYY-MM-DDTHH:mm:ssZ）
  • azId – (Optional) az信息
  • vpcId – (Optional) 实例所属VPC ID
  • subnetId – (Optional) 实例所属子网ID
  • connectionDomain – (Optional) 实例的访问域名
  • port – (Optional) 实例的访问端口
  • charge – (Optional) 实例的计费信息
  • instanceVersion – (Optional) 实例的详细版本号，形如x.x-x.x
  • auth – (Optional) 连接实例时，是否需要密码认证，false表示无密码
  • isAllowNoAuth – (Optional) 实例是否允许修改为免密
  • redisVersion – (Optional) 创建实例时选择的引擎版本：目前支持2.8和4.0
  • cacheInstanceType – (Optional) 实例类型：master-slave（标准版）、cluster（代理集群版）、native-cluster（cluster集群版）
  • ipv6On – (Optional) 是否支持IPv6，0表示不支持（只能用IPv4），1表示支持
  • tags – (Optional) 标签信息
  • resourceGroupId – (Optional) 实例所属资源组ID
  • shardNumber – (Optional) 实例分片数，标准版固定为1，自定义分片集群版实例分片数由用户创建时选择，其他实例为固定分片数
  • memoryMBPerShard – (Optional) 单分片内存大小（MB）
  • extension – (Optional) 扩展配置
  • otherDomains – (Optional) 实例其他访问域名列表
  • slaveAppendonly – (Optional) 从节点aof开关
  • databaseNum – (Optional) db数量
  • maxmemoryPolicy – (Optional) 淘汰策略
  • replicaNumber – (Optional) 副本数，含主副本
  • enableSmartProxy – (Optional) 实例是否开启SmartProxy，当架构类型为native-cluster时才有效，1表示开启，0表示不开启
  • cpuArchType – (Optional) cpu架构类型:arm64、amd64

jdcloud_sdk.services.redis.models.CacheInstanceSpec module

class jdcloud_sdk.services.redis.models.CacheInstanceSpec.CacheInstanceSpec(vpcId, subnetId, cacheInstanceName, cacheInstanceClass, azId, password=None, cacheInstanceDescription=None, redisVersion=None, ipv6On=None, shardNumber=None, userTags=None, resourceGroupId=None, dbNum=None, slaveAppendonly=None, maxmemoryPolicy=None, cacheInstanceType=None, replicaNumber=None, enableSmartProxy=None, port=None, extension=None, cpuArchType=None)[source]

Bases: object

Parameters:
  • vpcId – 缓存Redis实例所属的私有网络ID
  • subnetId – 缓存Redis实例在私有网络下所属的子网ID
  • cacheInstanceName – 缓存Redis实例名称，只支持数字、字母、英文下划线、中文，且不少于2字符不超过32字符
  • cacheInstanceClass – 缓存Redis实例的规格代码（可调用describeInstanceClass接口获取），或者自定义分片实例的单分片规格代码（可调用describeSpecConfig接口获取）
  • password – (Optional) 缓存Redis实例的连接密码，为空即为免密，包含且只支持字母及数字，不少于8字符不超过16字符
  • azId – 缓存Redis实例所在区域的可用区ID
  • cacheInstanceDescription – (Optional) 缓存Redis实例的描述，不能超过256个字符
  • redisVersion – (Optional) 缓存Redis引擎主次版本号：目前支持2.8和4.0，默认为2.8
  • ipv6On – (Optional) 是否支持IPv6，0或空表示不支持，1表示支持IPv6，注意不是所有区域都支持IPv6，且必须保证VPC支持IPv6
  • shardNumber – (Optional) 分片数，自定义分片规格集群版实例必须有，且大于1。每种分片规格支持的分片数可调用describeSpecConfig接口获取
  • userTags – (Optional) 用户普通标签
  • resourceGroupId – (Optional) 缓存Redis实例所属的资源组ID
  • dbNum – (Optional) db数量，默认为16，参数范围为16~256
  • slaveAppendonly – (Optional) slave节点是否开启持久化
  • maxmemoryPolicy – (Optional) 内存淘汰策略
  • cacheInstanceType – (Optional) 缓存Redis实例类型，目前支持：master-slave（标准版）、cluster（代理集群版）、native-cluster（cluster集群版）
  • replicaNumber – (Optional) 副本数，含主副本
  • enableSmartProxy – (Optional) 实例是否开启SmartProxy，当架构类型为native-cluster时才有效，1表示开启，0表示不开启
  • port – (Optional) 缓存Redis实例访问端口
  • extension – (Optional) 扩展配置
  • cpuArchType – (Optional) cpu架构类型:arm64、amd64

jdcloud_sdk.services.redis.models.ConfigItem module

class jdcloud_sdk.services.redis.models.ConfigItem.ConfigItem(configName, configValue, configDefaultValue=None, configValueType=None, configValueMin=None, configValueMax=None, configValueOptional=None, configValueOutputBuffer=None)[source]

Bases: object

param configName:
 configName目前只支持以下参数：

maxmemory-policy（redis 2.8和redis 4.0都支持，但配置值不相同）：内存剔除策略的最大使用内存限制 hash-max-ziplist-entries（redis 2.8和redis 4.0都支持）：用ziplist编码实现的哈希对象，ziplist中最多能存放entry个数的阈值 hash-max-ziplist-value（redis 2.8和redis 4.0都支持）：用ziplist编码实现的哈希对象，ziplist中能存放的value长度的最大值 list-max-ziplist-entries（只有redis 2.8支持）：用ziplist编码实现的列表对象，ziplist中最多能存放entry个数的阈值 list-max-ziplist-value（只有redis 2.8支持）：用ziplist编码实现的列表对象，ziplist中能存放的value长度的最大值 list-max-ziplist-size（只有redis 4.0支持）：用ziplist编码实现的列表对象，按照数据项个数或占用的字节数，限定ziplist的长度 list-compress-depth（只有redis 4.0支持）：用ziplist编码实现的列表对象，quicklist两端不被压缩的节点个数 set-max-intset-entries（redis 2.8和redis 4.0都支持）：用intset编码实现的集合对象，intset中最多能存放entry个数的阈值 zset-max-ziplist-entries（redis 2.8和redis 4.0都支持）：用ziplist编码实现的有序集合对象，ziplist中最多能存放entry个数的阈值 zset-max-ziplist-value（redis 2.8和redis 4.0都支持）：用ziplist编码实现的有序集合对象，ziplist中能存放的value长度的最大值 slowlog-log-slower-than（redis 2.8和redis 4.0都支持）：慢查询日志超时时间，单位微秒（1000000表示1秒），0表示记录所有的命令 notify-keyspace-events（只有redis 4.0支持）：事件通知

param configValue:
 参数的配置值，默认值、参考值如下：

maxmemory-policy（redis 2.8和redis 4.0的默认值都为volatile-lru）：redis 4.0 的参考值有[volatile-lru, allkeys-lru, volatile-lfu, allkeys-lfu, volatile-random, allkeys-random, volatile-ttl, noeviction]，redis 2.8的参考值有[volatile-lru , allkeys-lru , volatile-random , allkeys-random , volatile-ttl , noeviction] hash-max-ziplist-entries（redis 2.8和redis 4.0的默认值都为512）：[0-10000] hash-max-ziplist-value（redis 2.8和redis 4.0的默认值都为64）：[0-10000] list-max-ziplist-entries（redis 2.8的默认值为512，redis 4.0不支持）：[0-10000] list-max-ziplist-value（redis 2.8的默认值为64，redis 4.0不支持）：[0-10000] list-max-ziplist-size（redis 4.0的默认值为-2，redis 2.8不支持）：[-5-10000] list-compress-depth（redis 4.0的默认值为0，redis 2.8不支持）：[0-10000] set-max-intset-entries（redis 2.8和redis 4.0的默认值都为512）：[0-10000] zset-max-ziplist-entries（redis 2.8和redis 4.0的默认值都为128）：[0-10000] zset-max-ziplist-value（redis 2.8和redis 4.0的默认值都为64）：[0-10000] slowlog-log-slower-than（redis 2.8和redis 4.0的默认值都为10000）：[0-10000] notify-keyspace-events（redis 4.0的默认值为空，redis 2.8不支持）：[K , E , g , $ , l , s , h , z , x , e , A]字母的组合，区分大小写，或为空

param configDefaultValue:
 (Optional) 参数默认值
param configValueType:
 (Optional) 参数值类型，目前有int、string、outputBuffer、byteArray这四种
param configValueMin:
 (Optional) 参数值的最小值，在configValueType为int时有效
param configValueMax:
 (Optional) 参数值的最大值，在configValueType为int时有效
param configValueOptional:
 (Optional) 参数值的可选值，在configValueType为string或byteArray时有效
param configValueOutputBuffer:
 (Optional) configValueType为outputBuffer时的参数值规则

jdcloud_sdk.services.redis.models.InstanceClass module

class jdcloud_sdk.services.redis.models.InstanceClass.InstanceClass(instanceClass=None, instanceType=None, cpu=None, memoryMB=None, diskGB=None, maxConnection=None, bandwidthMbps=None)[source]

Bases: object

Parameters:
  • instanceClass – (Optional) 规格代码：redis 2.8与redis 4.0的规格码不同，具体参考 https://docs.jdcloud.com/cn/jcs-for-redis/specifications
  • instanceType – (Optional) 规格类型：master-slave表示主从版，cluster表示集群版
  • cpu – (Optional) cpu核数
  • memoryMB – (Optional) 内存总容量（MB）
  • diskGB – (Optional) 磁盘总容量（GB）
  • maxConnection – (Optional) 最大连接数
  • bandwidthMbps – (Optional) 内网带宽（MBps）

jdcloud_sdk.services.redis.models.OrderStatus module

class jdcloud_sdk.services.redis.models.OrderStatus.OrderStatus(total=None, success=None, fail=None, inProcess=None, resourceIds=None)[source]

Bases: object

Parameters:
  • total – (Optional) 订单总数
  • success – (Optional) 成功的订单数
  • fail – (Optional) 失败的订单数
  • inProcess – (Optional) 正在处理的订单数
  • resourceIds – (Optional) 成功的资源Id

Module contents