jdcloud_sdk.services.redis.apis package

Submodules

jdcloud_sdk.services.redis.apis.CreateCacheInstanceRequest module

class jdcloud_sdk.services.redis.apis.CreateCacheInstanceRequest.CreateCacheInstanceParameters(regionId, cacheInstance)[source]

Bases: object

Parameters:
  • regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
  • cacheInstance – 实例的创建参数
setCharge(charge)[source]
Parameters:charge – (Optional) 实例的计费类型
class jdcloud_sdk.services.redis.apis.CreateCacheInstanceRequest.CreateCacheInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

jdcloud_sdk.services.redis.apis.DeleteCacheInstanceRequest module

class jdcloud_sdk.services.redis.apis.DeleteCacheInstanceRequest.DeleteCacheInstanceParameters(regionId, cacheInstanceId)[source]

Bases: object

Parameters:
  • regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
  • cacheInstanceId – 缓存Redis实例ID,是访问实例的唯一标识
class jdcloud_sdk.services.redis.apis.DeleteCacheInstanceRequest.DeleteCacheInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

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

jdcloud_sdk.services.redis.apis.DescribeCacheInstanceRequest module

class jdcloud_sdk.services.redis.apis.DescribeCacheInstanceRequest.DescribeCacheInstanceParameters(regionId, cacheInstanceId)[source]

Bases: object

Parameters:
  • regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
  • cacheInstanceId – 缓存Redis实例ID,是访问实例的唯一标识
class jdcloud_sdk.services.redis.apis.DescribeCacheInstanceRequest.DescribeCacheInstanceRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

jdcloud_sdk.services.redis.apis.DescribeCacheInstancesRequest module

class jdcloud_sdk.services.redis.apis.DescribeCacheInstancesRequest.DescribeCacheInstancesParameters(regionId)[source]

Bases: object

Parameters:regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
setFilters(filters)[source]
param filters:(Optional) 过滤属性:

cacheInstanceId - 实例Id,精确匹配,可选择多个 cacheInstanceName - 实例名称,模糊匹配 cacheInstanceStatus - 实例状态,精确匹配,可选择多个(running:运行中,error:错误,creating:创建中,changing:变配中,configuring:参数修改中,restoring:备份恢复中,deleting:删除中) redisVersion - redis引擎版本,精确匹配,可选择2.8和4.0 instanceType - 实例类型,精确匹配(redis表示主从版,redis_cluster表示集群版) chargeMode - 计费类型,精确匹配(prepaid_by_duration表示包年包月预付费,postpaid_by_duration表示按配置后付费)

setPageNumber(pageNumber)[source]
Parameters:pageNumber – (Optional) 页码:取值范围[1,∞),默认为1
setPageSize(pageSize)[source]
Parameters:pageSize – (Optional) 分页大小:取值范围[10, 100],默认为10
setResourceGroupIds(resourceGroupIds)[source]
Parameters:resourceGroupIds – (Optional)
setSorts(sorts)[source]
param sorts:(Optional) 排序属性:

createTime - 按创建时间排序(asc表示按时间正序,desc表示按时间倒序)

setTagFilters(tagFilters)[source]
Parameters:tagFilters – (Optional) 标签的过滤条件
class jdcloud_sdk.services.redis.apis.DescribeCacheInstancesRequest.DescribeCacheInstancesRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

jdcloud_sdk.services.redis.apis.DescribeInstanceClassRequest module

class jdcloud_sdk.services.redis.apis.DescribeInstanceClassRequest.DescribeInstanceClassParameters(regionId)[source]

Bases: object

Parameters:regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
setRedisVersion(redisVersion)[source]
Parameters:redisVersion – (Optional) 缓存Redis的版本号:目前有2.8和4.0,默认为2.8
class jdcloud_sdk.services.redis.apis.DescribeInstanceClassRequest.DescribeInstanceClassRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

jdcloud_sdk.services.redis.apis.DescribeUserQuotaRequest module

class jdcloud_sdk.services.redis.apis.DescribeUserQuotaRequest.DescribeUserQuotaParameters(regionId)[source]

Bases: object

Parameters:regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
class jdcloud_sdk.services.redis.apis.DescribeUserQuotaRequest.DescribeUserQuotaRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

jdcloud_sdk.services.redis.apis.ModifyCacheInstanceAttributeRequest module

class jdcloud_sdk.services.redis.apis.ModifyCacheInstanceAttributeRequest.ModifyCacheInstanceAttributeParameters(regionId, cacheInstanceId)[source]

Bases: object

Parameters:
  • regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
  • cacheInstanceId – 缓存Redis实例ID,是访问实例的唯一标识
setCacheInstanceDescription(cacheInstanceDescription)[source]
Parameters:cacheInstanceDescription – (Optional) 实例的描述,不能超过256个字符
setCacheInstanceName(cacheInstanceName)[source]
Parameters:cacheInstanceName – (Optional) 实例的名称,名称只支持数字、字母、英文下划线、中文,且不少于2字符不超过32字符
class jdcloud_sdk.services.redis.apis.ModifyCacheInstanceAttributeRequest.ModifyCacheInstanceAttributeRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

jdcloud_sdk.services.redis.apis.ModifyCacheInstanceClassRequest module

class jdcloud_sdk.services.redis.apis.ModifyCacheInstanceClassRequest.ModifyCacheInstanceClassParameters(regionId, cacheInstanceId, cacheInstanceClass)[source]

Bases: object

Parameters:
  • regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
  • cacheInstanceId – 缓存Redis实例ID,是访问实例的唯一标识
  • cacheInstanceClass – 新规格
setParallel(parallel)[source]
Parameters:parallel – (Optional) 是否开启4.0集群并行变配
setShardNumber(shardNumber)[source]
Parameters:shardNumber – (Optional) 自定义分片数,只对自定义分片规格实例有效
class jdcloud_sdk.services.redis.apis.ModifyCacheInstanceClassRequest.ModifyCacheInstanceClassRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

jdcloud_sdk.services.redis.apis.ResetCacheInstancePasswordRequest module

class jdcloud_sdk.services.redis.apis.ResetCacheInstancePasswordRequest.ResetCacheInstancePasswordParameters(regionId, cacheInstanceId)[source]

Bases: object

Parameters:
  • regionId – 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域,Region ID分别为cn-north-1、cn-south-1、cn-east-2
  • cacheInstanceId – 缓存Redis实例ID,是访问实例的唯一标识
setPassword(password)[source]
Parameters:password – (Optional) 密码,为空即为免密,不少于8字符不超过16字符
class jdcloud_sdk.services.redis.apis.ResetCacheInstancePasswordRequest.ResetCacheInstancePasswordRequest(parameters, header=None, version='v1')[source]

Bases: jdcloud_sdk.core.jdcloudrequest.JDCloudRequest

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

Module contents