{ "name": "redis", "display_name": "云数据库Redis", "description": "介绍如何使用API对云数据库Redis进行操作，包括备份和恢复、禁用读写分离、创建Redis实例等。", "domain": "database", "api_version": "2018-04-12", "endpoint": "redis.tencentcloudapi.com", "actions": [ { "name": "AddReplicationInstance", "description": "本接口（AddReplicationInstance）用于为全球复制组添加实例成员。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。", "example": "crs-rpl-267khx71" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。 - 添加复制组实例有地域与可用区限制。具体信息，请参见[使用限制](https://cloud.tencent.com/document/product/239/71934)。 - 当前仅4.0、5.0 Redis 版集群架构的实例支持加入复制组。 - 请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制需加入复制组的实例 ID。", "example": "crs-deindi7de" }, { "name": "InstanceRole", "type": "string", "required": true, "description": "给复制组添加的实例分配角色。rw：可读写。r：只读。", "example": "rw" } ], "required": [ "GroupId", "InstanceId", "InstanceRole" ] }, { "name": "AllocateWanAddress", "description": "本接口（AllocateWanAddress）用于开通实例外网访问。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-dvchdv5" } ], "required": [ "InstanceId" ] }, { "name": "ApplyParamsTemplate", "description": "本接口（ApplyParamsTemplate）用于应用参数模板到实例。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "[\"crs-deindi7de\"]", "item_type": "string" }, { "name": "TemplateId", "type": "string", "required": true, "description": "应用的参数模板ID。 - 请通过接口 [DescribeParamTemplateInfo](https://cloud.tencent.com/document/product/239/58748) 的返回参数 **TemplateId** 获取参数模板 ID。 - 仅当参数模板版本与目标实例的架构版本一致时，操作才能成功执行。版本不匹配将触发执行错误。", "example": "crs-cfg-rhlppeye" } ], "required": [ "InstanceIds", "TemplateId" ] }, { "name": "AssociateSecurityGroups", "description": "本接口 (AssociateSecurityGroups) 用于将一个安全组绑定于一个或多个数据库实例。创建实例时，未配置安全组，建议通过该接口，绑定安全组。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：redis。", "example": "redis" }, { "name": "SecurityGroupId", "type": "string", "required": true, "description": "要绑定的安全组ID，请在[控制台安全组](https://console.cloud.tencent.com/vpc/security-group)页面获取安全组 ID。", "example": "sg-ajr1jzgj" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "被绑定的实例ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID，支持指定多个实例。", "example": "crs-eb2w7dto", "item_type": "string" } ], "required": [ "Product", "SecurityGroupId", "InstanceIds" ] }, { "name": "ChangeInstanceRole", "description": "本接口（ChangeInstanceRole）用于更换复制组内实例的角色。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。", "example": "crs-rpl-267khx71" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-deindi7de" }, { "name": "InstanceRole", "type": "string", "required": true, "description": "实例角色。 - rw：可读写。 - r：只读。", "example": "rw" } ], "required": [ "GroupId", "InstanceId", "InstanceRole" ] }, { "name": "ChangeMasterInstance", "description": "该接口（ChangeMasterInstance）用于将复制组内只读实例设置为主实例。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "复制组ID。创建复制组时，系统自动分配的 ID，是复制组的唯一标识。例如：crs-rpl-m3zt****，请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID。", "example": "crs-rpl-deindi7de" }, { "name": "InstanceId", "type": "string", "required": true, "description": "指定待提升为主实例的只读实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-deindi7de" }, { "name": "ForceSwitch", "type": "boolean", "required": false, "description": "标识是否强制提主。 - true：强制提主。 - false：不强制提主。", "example": "true" } ], "required": [ "GroupId", "InstanceId" ] }, { "name": "ChangeReplicaToMaster", "description": "本接口（ChangeReplicaToMaster）适用于实例副本组提主或副本提主。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-cdbdbncd" }, { "name": "GroupId", "type": "integer", "required": false, "description": "副本节点组 ID，请通过接口[DescribeInstanceZoneInfo](https://cloud.tencent.com/document/product/239/50312)获取多 AZ备节点组的 ID 信息。单 AZ，则无需配置该参数。", "example": "354266" } ], "required": [ "InstanceId" ] }, { "name": "CleanUpInstance", "description": "本接口（CleanUpInstance）用于立即下线回收站的实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录 [Redis 控制台回收站](https://console.cloud.tencent.com/redis/recycle)的实例列表复制实例 ID。", "example": "crs-5a4py64p" } ], "required": [ "InstanceId" ] }, { "name": "ClearInstance", "description": "本接口（ClearInstance）用于清空实例数据。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "Password", "type": "string", "required": false, "description": "实例访问密码。 - 免密访问：无需配置。 - 密码认证：必须配置。字符个数为[8,64]，至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^\u0026*-+=_|{}[]:;,.?/ 中的2种，不能以\"/\"开头。", "example": "zy456987" }, { "name": "EncryptPassword", "type": "boolean", "required": false, "description": "是否加密密码", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "CloneInstances", "description": "本接口（CloneInstances）用于基于当前实例的备份文件克隆一个完整的新实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定待克隆的源实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-xxx" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "单次克隆实例的数量。 - 包年包月每次购买最大数量为100。 - 按量计费每次购买最大数量为30。", "example": "1" }, { "name": "ZoneId", "type": "integer", "required": true, "description": "克隆实例所属的可用区ID。当前所支持的可用区 ID，请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。", "example": "100001" }, { "name": "BillingMode", "type": "integer", "required": true, "description": "付费方式。0：按量计费。1：包年包月。", "example": "0" }, { "name": "Period", "type": "integer", "required": true, "description": "购买实例时长。单位：月。付费方式选择包年包月计费时，取值范围为[1,2,3,4,5,6,7,8,9,10,11,12,24,36,48,60]。付费方式选择按量计费时，设置为1。", "example": "1" }, { "name": "SecurityGroupIdList", "type": "array", "required": true, "description": "安全组ID。请通过 [DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447) 接口获取实例的安全组 ID。", "example": "[\"sg-bmadczm1\"]", "item_type": "string" }, { "name": "BackupId", "type": "string", "required": true, "description": "克隆实例使用的备份ID。请通过接口[DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011)获取备份ID。", "example": "154572601-1165734322-153705740" }, { "name": "NoAuth", "type": "boolean", "required": false, "description": "配置克隆实例是否支持免密访问。开启 SSL 与外网均不支持免密访问。true：免密实例，false：非免密实例。默认为非免密实例。", "example": "false" }, { "name": "VpcId", "type": "string", "required": false, "description": "配置克隆实例的私有网络ID。如果未配置该参数，默认选择基础网络。", "example": "vpc-pxyzim13" }, { "name": "SubnetId", "type": "string", "required": false, "description": "配置克隆实例所属私有网络的子网。基础网络时该参数无需配置。", "example": "subnet-7jbabche" }, { "name": "InstanceName", "type": "string", "required": false, "description": "克隆实例的名称。仅支持长度小于60的中文、英文或者数字，短划线\"-\"、下划线\"_\"。", "example": "MyInstanceName" }, { "name": "Password", "type": "string", "required": false, "description": "克隆实例的访问密码。当输入参数NoAuth为true时，可不设置该参数。当实例为Redis2.8、4.0和5.0时，其密码格式为：8-30个字符，至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^\u0026*-+=_|{}[]:;,.?/ 中的2种，不能以\"/\"开头；当实例为CKV 3.2时，其密码格式为：8-30个字符，必须包含字母和数字，且不包含其他字符。", "example": "305961MyP@ssword" }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "自动续费标识。0：默认状态，手动续费。1：自动续费。2：不自动续费，到期自动隔离。", "example": "9" }, { "name": "VPort", "type": "integer", "required": false, "description": "用户自定义的端口，默认为6379，取值范围[1024,65535]。", "example": "6378" }, { "name": "NodeSet", "type": "array", "required": false, "description": "实例的节点信息。目前支持配置节点的类型（主节点或者副本节点），及其节点的可用区信息。具体信息，请参见[RedisNodeInfo](https://cloud.tencent.com/document/product/239/20022#RedisNodeInfo)。单可用区部署可不配置该参数。", "example": "无", "item_type": "object", "children": [ { "name": "NodeType", "type": "integer", "required": true, "description": "节点类型。0：为主节点。1：为副本节点。", "example": "1" }, { "name": "NodeId", "type": "integer", "required": false, "description": "主节点或者副本节点的 ID。该参数用于创建 Redis 实例接口[CreateInstances](https://cloud.tencent.com/document/product/239/20026) 并不需要设置，而用于变更实例配置的接口 [UpgradeInstance](https://cloud.tencent.com/document/product/239/20013) 删除副本时才需要设置。该参数可使用接口 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 获取Integer类型的节点 ID。", "example": "1" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "主节点或者副本节点的可用区 ID。", "example": "100001" }, { "name": "ZoneName", "type": "string", "required": false, "description": "主节点或者副本节点的可用区名称。", "example": "ap-guangzhou-1" } ] }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID。登录[Redis 控制台](https://console.cloud.tencent.com/redis#/)，可在右上角的账号中心 \u003e 项目管理中查找项目ID。", "example": "0" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "克隆实例需绑定的标签。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签Key。", "example": "tag-key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签 Key 对应的 Value。", "example": "tag-value" } ] }, { "name": "TemplateId", "type": "string", "required": false, "description": "指定克隆实例相关的参数模板 ID。 - 若不配置该参数，则系统会依据所选择的兼容版本及架构，自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口，查询实例的参数模板列表，获取模板 ID 编号。", "example": "crs-cfg-rhlppeye" }, { "name": "AlarmPolicyList", "type": "array", "required": false, "description": "指定克隆实例的告警策略 ID。请登录[腾讯云可观测平台控制台](https://console.cloud.tencent.com/monitor/alarm2/policy)，在 告警管理 \u003e 策略管理页面获取策略 ID 信息。", "example": "[\"policy-ny3vfcp0\"]", "item_type": "string" }, { "name": "CloneTime", "type": "string", "required": false, "description": "克隆指定恢复数据的时间。 仅支持已开通秒级备份的实例", "example": "2006-01-02 15:04:05" }, { "name": "EncryptPassword", "type": "boolean", "required": false, "description": "是否加密密码", "example": "false" } ], "required": [ "InstanceId", "GoodsNum", "ZoneId", "BillingMode", "Period", "SecurityGroupIdList", "BackupId" ] }, { "name": "CloseSSL", "description": "本接口（CloseSSL）用于关闭SSL加密认证。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-deindi7de" } ], "required": [ "InstanceId" ] }, { "name": "CreateInstanceAccount", "description": "本接口（CreateInstanceAccount）用于自定义访问实例的账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "AccountName", "type": "string", "required": true, "description": "自定义的访问数据库的账号名称。 - 仅由字母、数字、下划线、中划线组成。 - 长度不能大于32位。", "example": "username_01" }, { "name": "AccountPassword", "type": "string", "required": true, "description": "设置自定义账号的密码。密码复杂度要求如下： - 字符个数为[8,64]。 - 至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^\u0026*-+=_|{}[]:;,.?/ 中的两种。 - 不能以\"/\"开头。", "example": "1234567aA" }, { "name": "ReadonlyPolicy", "type": "array", "required": true, "description": "指定账号的读请求路由分发至主节点或副本节点。未开启副本只读，不支持选择副本节点。 - master：主节点 - replication：副本节点", "example": "[\"master\"]", "item_type": "string" }, { "name": "Privilege", "type": "string", "required": true, "description": "账户读写权限，支持选择只读与读写权限。 - r：只读。 - rw: 读写。", "example": "rw" }, { "name": "Remark", "type": "string", "required": false, "description": "账号备注描述信息，长度为[0,64] 字节，支持中文。", "example": "\"生产账号\"" }, { "name": "EncryptPassword", "type": "boolean", "required": false, "description": "是否加密密码", "example": "false" } ], "required": [ "InstanceId", "AccountName", "AccountPassword", "ReadonlyPolicy", "Privilege" ] }, { "name": "CreateInstances", "description": "本接口（CreateInstances）用于创建 Redis 实例。", "status": "online", "parameters": [ { "name": "TypeId", "type": "integer", "required": true, "description": "实例类型。 - 2：Redis 2.8 内存版（标准架构）。 - 3：CKV 3.2 内存版（标准架构）。 - 4：CKV 3.2 内存版（集群架构）。 - 6：Redis 4.0 内存版（标准架构）。 - 7：Redis 4.0 内存版（集群架构）。 - 8：Redis 5.0 内存版（标准架构）。 - 9：Redis 5.0 内存版（集群架构）。 - 15：Redis 6.2 内存版（标准架构）。 - 16：Redis 6.2 内存版（集群架构）。 - 17：Redis 7.0 内存版（标准架构）。 - 18：Redis 7....", "example": "6" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量，单位为MB， 数值需为1024的整数倍。具体规格，请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 - **TypeId**为标准架构时，**MemSize**是实例总内存容量； - **TypeId**为集群架构时，**MemSize**是单分片内存容量。", "example": "4096" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "实例数量，单次购买实例数量。具体信息，请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "购买实例的时长。 - 若 **BillingMode**为**1**，即计费方式为包年包月时，需设置该参数，指定所购买实例的时长。单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 - 若 **BillingMode**为**0**，即计费方式为按量计费时，该参数配置为1。", "example": "1" }, { "name": "BillingMode", "type": "integer", "required": true, "description": "计费方式。 - 0：按量计费。 - 1：包年包月。", "example": "0" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "实例所属的可用区ID，可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。", "example": "100002" }, { "name": "Password", "type": "string", "required": false, "description": "访问实例的密码。 - 当输入参数**NoAuth**为**true**时，指设置实例为免密码访问，Password可不用配置，否则Password为必填参数。 - 当实例类型**TypeId**为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.2、7.0内存版标准架构或集群架构时，其密码复杂度要求为：8-64个字符，至少包含小写字母、大写字母、数字和字符()`~!@#$%^\u0026*-+=_|{}[]:;,.?/ 中的2种，不能以\"/\"开头。 - 当实例类型**TypeId**为CKV 3.2...", "example": "260945MyP@ssword" }, { "name": "VpcId", "type": "string", "required": false, "description": "私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。", "example": "vpc-pxyzim13" }, { "name": "SubnetId", "type": "string", "required": false, "description": "私有网络VPC的子网。基础网络下， 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。", "example": "subnet-7jbabche" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)，在右上角的账户信息菜单中，选择**项目管理**查询项目 ID。", "example": "0" }, { "name": "AutoRenew", "type": "integer", "required": false, "description": "自动续费标识。 - 0：默认状态（手动续费）。 - 1：自动续费。 - 2：到期不续费。", "example": "0" }, { "name": "SecurityGroupIdList", "type": "array", "required": false, "description": "安全组 ID 数组。 - 安全组是一种虚拟防火墙，对云数据库实例的网络访问进行控制。创建实例时，建议绑定相应的安全组。 - 请通过 [DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447) 接口获取实例的安全组 ID。", "example": "[\"sg-bmadczm1\"]", "item_type": "string" }, { "name": "VPort", "type": "integer", "required": false, "description": "用户自定义的网络端口。默认为6379，范围为 [1024,65535]。", "example": "6378" }, { "name": "RedisShardNum", "type": "integer", "required": false, "description": "实例分片数量。 - 标准版实例无需配置该参数。 - 集群版实例，分片数量范围为：[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。", "example": "1" }, { "name": "RedisReplicasNum", "type": "integer", "required": false, "description": "实例副本数量。 - Redis 内存版 4.0、5.0、6.2、7.0 标准架构和集群架构支持副本数量范围为[1,5]。 - Redis 2.8标准版、CKV标准版只支持1副本。", "example": "1" }, { "name": "ReplicasReadonly", "type": "boolean", "required": false, "description": "标识实例是否需支持副本只读。 - Redis 2.8 标准版、CKV标准版不支持副本只读。 - 开启副本只读，实例将自动读写分离，写请求路由到主节点，读请求路由到副本节点。 - 如需开启副本只读，建议副本数量大于等于2。", "example": "true" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。命名要求：仅支持长度小于60的中文、英文或者数字，短划线\"-\"、下划线\"_\"。", "example": "MyInstanceName" }, { "name": "NoAuth", "type": "boolean", "required": false, "description": "配置实例是否支持免密码访问。 - true：免密访问实例。 - false：非免密访问实例。默认为非免密方式，仅VPC网络的实例支持免密码访问。", "example": "false" }, { "name": "NodeSet", "type": "array", "required": false, "description": "实例的节点信息，包含节点 ID、节点类型、节点可用区 ID等。具体信息，请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 目前支持传入节点的类型（主节点或者副本节点），节点的可用区。单可用区部署不需要传递此参数。", "example": "无", "item_type": "object", "children": [ { "name": "NodeType", "type": "integer", "required": true, "description": "节点类型。0：为主节点。1：为副本节点。", "example": "1" }, { "name": "NodeId", "type": "integer", "required": false, "description": "主节点或者副本节点的 ID。该参数用于创建 Redis 实例接口[CreateInstances](https://cloud.tencent.com/document/product/239/20026) 并不需要设置，而用于变更实例配置的接口 [UpgradeInstance](https://cloud.tencent.com/document/product/239/20013) 删除副本时才需要设置。该参数可使用接口 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 获取Integer类型的节点 ID。", "example": "1" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "主节点或者副本节点的可用区 ID。", "example": "100001" }, { "name": "ZoneName", "type": "string", "required": false, "description": "主节点或者副本节点的可用区名称。", "example": "ap-guangzhou-1" } ] }, { "name": "ResourceTags", "type": "array", "required": false, "description": "给实例设定标签。", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签Key。", "example": "tag-key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签 Key 对应的 Value。", "example": "tag-value" } ] }, { "name": "ZoneName", "type": "string", "required": false, "description": "指定实例所属的可用区名称。具体信息，请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。", "example": "ap-guangzhou" }, { "name": "TemplateId", "type": "string", "required": false, "description": "指定实例相关的参数模板 ID。 - 若不配置该参数，则系统会依据所选择的兼容版本及架构，自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口，查询实例的参数模板列表，获取模板 ID 编号。", "example": "crs-cfg-rhlppeye" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "内部参数，标识创建实例是否需要检查。 - false ：默认值。发送正常请求，通过检查后直接创建实例。 - true：发送检查请求，不会创建实例。", "example": "true" }, { "name": "ProductVersion", "type": "string", "required": false, "description": "指实例部署模式。 - local：传统架构，默认为 local。 - cdc：独享集群。 - cloud：云原生，当前已暂停售卖。", "example": "cdc" }, { "name": "RedisClusterId", "type": "string", "required": false, "description": "独享集群 ID。 - 当 **ProductVersion** 设置为 **cdc** 时，该参数必须设置。 - 请通过接口[ DescribeRedisClusters](https://cloud.tencent.com/document/product/239/109628) 获取集群 ID。", "example": "crs-cdc-0xigvn3t" }, { "name": "AlarmPolicyList", "type": "array", "required": false, "description": "告警策略 ID 数组。 - 请登录[腾讯云可观测平台-告警管理-策略管理](https://console.cloud.tencent.com/monitor/alarm/policy)获取告警策略 ID。 - 若不配置该参数，则绑定默认告警策略。默认告警策略具体信息，请登录[腾讯云可观测平台-告警管理-策略管理](https://console.cloud.tencent.com/monitor/alarm/policy)查看。", "example": "[\"policy-6e6wodv4\"]", "item_type": "string" }, { "name": "EncryptPassword", "type": "boolean", "required": false, "description": "是否加密密码", "example": "false" } ], "required": [ "TypeId", "MemSize", "GoodsNum", "Period", "BillingMode" ] }, { "name": "CreateParamTemplate", "description": "该接口（CreateParamTemplate）用于创建参数模板。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "参数模板名称。字符长度要求为[2,64]。", "example": "自定义参数模板" }, { "name": "Description", "type": "string", "required": false, "description": "参数模板描述。", "example": "参数模板描述" }, { "name": "ProductType", "type": "integer", "required": false, "description": "产品类型。 - 6：Redis 4.0 内存版（标准架构）。 - 7：Redis 4.0 内存版（集群架构）。 - 8：Redis 5.0 内存版（标准架构）。 - 9：Redis 5.0 内存版（集群架构）。 - 15：Redis 6.2 内存版（标准架构）。 - 16：Redis 6.2 内存版（集群架构）。 - 17：Redis 7.0 内存版（标准架构）。 - 18：Redis 7.0 内存版（集群架构）。", "example": "6" }, { "name": "TemplateId", "type": "string", "required": false, "description": "源参数模板 ID。", "example": "crs-cfg-rhlppeye" }, { "name": "ParamList", "type": "array", "required": false, "description": "参数列表。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "设置参数的名称。例如timeout。当前支持自定义的参数，请参见参数配置。", "example": "timeout" }, { "name": "Value", "type": "string", "required": true, "description": "设置参数名称对应的运行值。例如timeout对应运行值可设置为120， 单位为秒（s）。指当客户端连接闲置时间达到120 s时，将关闭连接。更多参数取值信息，请参见参数配置。", "example": "120" } ] } ], "required": [ "Name" ] }, { "name": "CreateReplicationGroup", "description": "本接口（CreateReplicationGroup）用于创建复制组。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定复制组中的主实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-dvchdv5" }, { "name": "GroupName", "type": "string", "required": false, "description": "配置复制组名称。仅支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。", "example": "example_group_name" }, { "name": "Remark", "type": "string", "required": false, "description": "备注信息。", "example": "Create a Replication Group Test" } ], "required": [ "InstanceId" ] }, { "name": "DeleteInstanceAccount", "description": "本接口（DeleteInstanceAccount）用于删除实例子账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "AccountName", "type": "string", "required": true, "description": "子账号名称。请登录[Redis控制台](https://console.cloud.tencent.com/redis)，切换至**账号管理**页面获取。具体信息，请参见[管理账号](https://cloud.tencent.com/document/product/239/36710)。", "example": "example_name" } ], "required": [ "InstanceId", "AccountName" ] }, { "name": "DeleteParamTemplate", "description": "本接口（DeleteParamTemplate）用于删除参数模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "参数模板 ID。请登录 [Redis 控制台的参数模板](https://console.cloud.tencent.com/redis/templates)页面获取模板 ID。", "example": "crs-cfg-rhlppeye" } ], "required": [ "TemplateId" ] }, { "name": "DeleteReplicationInstance", "description": "本接口（DeleteReplicationInstance）移除复制组成员。注：该接口下线中，请使用 [RemoveReplicationInstance](https://cloud.tencent.com/document/product/239/90099)。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。", "example": "crs-rpl-deindi7de" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-deindi7de" }, { "name": "SyncType", "type": "boolean", "required": true, "description": "数据同步类型。 - true：需要数据强同步。 - false：不需要强同步，仅限删除主实例。", "example": "false" } ], "required": [ "GroupId", "InstanceId", "SyncType" ] }, { "name": "DescribeAutoBackupConfig", "description": "本接口（DescribeAutoBackupConfig）用于获取自动备份配置规则。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupDetail", "description": "本接口（DescribeBackupDetail）用于查询实例的备份信息详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-4y9t5***" }, { "name": "BackupId", "type": "string", "required": true, "description": "备份 ID，可通过接口 [DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011) 返回的参数 **RedisBackupSet** 获取。", "example": "67836256600000000****" } ], "required": [ "InstanceId", "BackupId" ] }, { "name": "DescribeBackupDownloadRestriction", "description": "本接口（DescribeBackupDownloadRestriction）用于查询当前地域数据库备份文件的下载地址。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBackupUrl", "description": "本接口（DescribeBackupUrl）用于查询备份 Rdb 文件的下载地址。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-4y9t57vt" }, { "name": "BackupId", "type": "string", "required": true, "description": "备份 ID，可通过 [DescribeInstanceBackups ](https://cloud.tencent.com/document/product/239/20011)接口返回的参数 RedisBackupSet 获取。", "example": "678362566696298532848117" }, { "name": "LimitType", "type": "string", "required": false, "description": "下载备份文件的网络限制类型，如果不配置该参数，则使用用户自定义的配置。 - NoLimit：不限制，腾讯云内外网均可以下载备份文件。 - LimitOnlyIntranet：仅腾讯云自动分配的内网地址可下载备份文件。 - Customize：指用户自定义的私有网络可下载备份文件。", "example": "NoLimit" }, { "name": "VpcComparisonSymbol", "type": "string", "required": false, "description": "该参数仅支持输入 In，表示自定义的**LimitVpc**可以下载备份文件。", "example": "In" }, { "name": "IpComparisonSymbol", "type": "string", "required": false, "description": "标识自定义的 LimitIp 地址是否可下载备份文件。 - In: 自定义的 IP 地址可以下载。默认为 In。 - NotIn: 自定义的 IP 不可以下载。", "example": "In" }, { "name": "LimitVpc", "type": "array", "required": false, "description": "自定义的可下载备份文件的 VPC ID。当参数**LimitType**为**Customize **时，需配置该参数。", "example": "无", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": true, "description": "备份文件的下载地址对应VPC 所属的地域。", "example": "ap-guangzhou" }, { "name": "VpcList", "type": "array", "required": true, "description": "备份文件下载地址的 VPC 列表。", "example": "[\"vpc-b3ksv7yt\", \"vpc-a9pl9fiu\"]", "item_type": "string" } ] }, { "name": "LimitIp", "type": "array", "required": false, "description": "自定义的可下载备份文件的 VPC IP 地址。当参数**LimitType**为**Customize **时，需配置该参数。", "example": "[\"10.1.1.12\", \"10.1.1.13\"]", "item_type": "string" } ], "required": [ "InstanceId", "BackupId" ] }, { "name": "DescribeBandwidthRange", "description": "本接口（DescribeBandwidthRange）用于查询实例带宽信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录Redis控制台在实例列表复制实例 ID。", "example": "crs-xxx" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCommonDBInstances", "description": "本接口（DescribeCommonDBInstances）用于查询Redis实例列表信息。当前该接口已废弃。", "status": "online", "parameters": [ { "name": "VpcIds", "type": "array", "required": false, "description": "vpc网络ID信息列表", "example": "[1120,1121]", "item_type": "integer" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "子网ID信息列表", "example": "null", "item_type": "integer" }, { "name": "PayMode", "type": "integer", "required": false, "description": "计费类型过滤列表；0表示包年包月，1表示按量计费", "example": "0" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例ID过滤信息列表，数组最大长度限制为100", "example": "[\"crs-xjhsdj****\\n\"]", "item_type": "string" }, { "name": "InstanceNames", "type": "array", "required": false, "description": "实例名称过滤信息列表", "example": "null", "item_type": "string" }, { "name": "Status", "type": "array", "required": false, "description": "实例状态信息过滤列表", "example": "null", "item_type": "string" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段", "example": "null" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式", "example": "null" }, { "name": "Vips", "type": "array", "required": false, "description": "实例vip信息列表", "example": "null", "item_type": "string" }, { "name": "UniqVpcIds", "type": "array", "required": false, "description": "vpc网络ID信息列表", "example": "null", "item_type": "string" }, { "name": "UniqSubnetIds", "type": "array", "required": false, "description": "子网统一ID列表", "example": "null", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "数量限制，默认推荐100", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" } ], "required": [] }, { "name": "DescribeDBSecurityGroups", "description": "本接口（DescribeDBSecurityGroups）用于查询实例的安全组详情。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：redis。", "example": "redis" }, { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-eb2w7dto" } ], "required": [ "Product", "InstanceId" ] }, { "name": "DescribeGlobalReplicationArea", "description": "本接口（DescribeGlobalReplicationArea）用于查询全球复制支持地域信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeInstanceAccount", "description": "本接口（DescribeInstanceAccount）用于查看实例账号信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小。默认值为20，最小值为1，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量。参数取值：Limit 的整数倍，offset=limit*(页码-1)。默认值：0。", "example": "0" } ], "required": [ "InstanceId", "Limit", "Offset" ] }, { "name": "DescribeInstanceBackups", "description": "本接口（DescribeInstanceBackups）用于查询实例备份列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "每页输出的备份列表大小。默认大小为20，最大值为 100。", "example": "5" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" }, { "name": "InstanceId", "type": "string", "required": false, "description": "待操作的实例ID，可通过 DescribeInstance 接口返回值中的 InstanceId 获取。", "example": "crs-5a4py64p" }, { "name": "BeginTime", "type": "string", "required": false, "description": "开始时间，格式如：2017-02-08 16:46:34。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表，查询时间最大跨度30天。", "example": "2017-02-08 16:46:34" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间，格式如：2017-02-08 19:09:26。查询实例在 [beginTime, endTime] 时间段内开始备份的备份列表，查询时间最大跨度30天。", "example": "2017-02-08 19:09:26" }, { "name": "Status", "type": "array", "required": false, "description": "备份任务的状态： 1：备份在流程中。 2：备份正常。 3：备份转RDB文件处理中。 4：已完成RDB转换。 -1：备份已过期。 -2：备份已删除。", "example": "[2]", "item_type": "integer" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称，支持根据实例名称模糊搜索。", "example": "测试实例" } ], "required": [] }, { "name": "DescribeInstanceDTSInfo", "description": "本接口（DescribeInstanceDTSInfo）用于查询实例 DTS 信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-6ia1c1c3" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceDealDetail", "description": "本接口（DescribeInstanceDealDetail）用于查询订单信息。", "status": "online", "parameters": [ { "name": "DealName", "type": "string", "required": false, "description": "订单号，即 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的输出参数DealName。数组最大长度限制为10", "example": "20250825297021508048753" } ], "required": [] }, { "name": "DescribeInstanceEvents", "description": "本接口（DescribeInstanceEvents）用于查询 Redis 实例事件信息。", "status": "online", "parameters": [ { "name": "ExecutionStartDate", "type": "string", "required": true, "description": "配置查询事件执行计划的起始日期，查询日期最大跨度30天。", "example": "2018-09-10" }, { "name": "ExecutionEndDate", "type": "string", "required": true, "description": "配置查询事件执行计划的结束日期，查询日期最大跨度30天。", "example": "2018-09-10" }, { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-asdasdas" }, { "name": "PageSize", "type": "integer", "required": false, "description": "输出每页显示事件的数量。 - 默认值：10。 - 取值范围：[1,100]。", "example": "10" }, { "name": "PageNo", "type": "integer", "required": false, "description": "配置查询事件的输出页码，即支持根据PageNo（页码）与 PageSize （每页输出数量）查询某一页的事件。 - 默认值：1。 - 取值范围：大于0 的正整数。", "example": "1" }, { "name": "Status", "type": "array", "required": false, "description": "事件当前状态。 - Waiting：未到达执行日期或不在维护时间窗内的事件。 - Running：在维护时间窗内，正在执行维护的事件。 - Finished：已全部完成维护的事件。 - Canceled：已取消执行的事件。", "example": "[\"Running\"]", "item_type": "string" }, { "name": "EventTypes", "type": "array", "required": false, "description": "事件类型，当前仅支持配置实例迁移、资源腾挪、机房裁撤相关的运维操作。该参数仅支持配置为 **InstanceMigration**。", "example": "[\"InstanceMigration\"]", "item_type": "string" }, { "name": "Grades", "type": "array", "required": false, "description": "配置查询事件等级。事件等级根据其影响严重程度和紧急程度进行分级，由重至轻依次为关键、重要、中等、一般。 - Critical：关键 - High：重要 - Middle：中等 - Low：一般", "example": "[\"Low\"]", "item_type": "string" } ], "required": [ "ExecutionStartDate", "ExecutionEndDate" ] }, { "name": "DescribeInstanceLogDelivery", "description": "本接口（DescribeInstanceLogDelivery）用于查询实例的日志投递配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance)在实例列表复制实例 ID。", "example": "crs-d8ej0xn2" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceMonitorBigKey", "description": "腾讯云数据库 Redis 已经于2022年10月31日下线查询实例大 Key 接口。具体公告，请参见[查询实例大 Key 接口下线公告](https://cloud.tencent.com/document/product/239/81005)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "crs-5a4py64p" }, { "name": "ReqType", "type": "integer", "required": true, "description": "请求类型：1——string类型，2——所有类型", "example": "1" }, { "name": "Date", "type": "string", "required": true, "description": "时间；例如：\"20190219\"", "example": "20191101" } ], "required": [ "InstanceId", "ReqType", "Date" ] }, { "name": "DescribeInstanceMonitorBigKeySizeDist", "description": "腾讯云数据库 Redis 已经于2022年10月31日下线查询实例大 Key 接口。具体公告，请参见 [查询实例大 Key 接口下线公告](https://cloud.tencent.com/document/product/239/81005)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "crs-5a4py64p" }, { "name": "Date", "type": "string", "required": true, "description": "时间；例如：\"20190219\"", "example": "2019-11-07" } ], "required": [ "InstanceId", "Date" ] }, { "name": "DescribeInstanceMonitorBigKeyTypeDist", "description": "腾讯云数据库 Redis 已经于2022年10月31日下线查询实例大 Key 接口。具体公告，请参见 [查询实例大 Key 接口下线公告](https://cloud.tencent.com/document/product/239/81005)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例Id", "example": "crs-r34wkc1d" }, { "name": "Date", "type": "string", "required": true, "description": "时间；例如：\"20190219\"", "example": "2019-11-07" } ], "required": [ "InstanceId", "Date" ] }, { "name": "DescribeInstanceMonitorHotKey", "description": "本接口（DescribeInstanceMonitorHotKey）用于查询实例热Key。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-xjhsdj****" }, { "name": "SpanType", "type": "integer", "required": true, "description": "查询时间范围。 - 1：实时。 - 2：近30分钟。 - 3：近6小时。 - 4：近24小时。", "example": "1" } ], "required": [ "InstanceId", "SpanType" ] }, { "name": "DescribeInstanceMonitorSIP", "description": "该接口已下线，请使用数据库智能管家 DBbrain 接口 [DescribeProxyProcessStatistics](https://cloud.tencent.com/document/product/1130/84544) 获取实例访问来源。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceMonitorTookDist", "description": "本接口（DescribeInstanceMonitorTookDist）用于查询实例访问的耗时分布。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "Date", "type": "string", "required": true, "description": "查询时间日期。", "example": "2019-11-07" }, { "name": "SpanType", "type": "integer", "required": true, "description": "时间范围。 - 1：实时。 - 2：近30分钟。 - 3：近6小时。 - 4：近24小时。", "example": "1" } ], "required": [ "InstanceId", "Date", "SpanType" ] }, { "name": "DescribeInstanceMonitorTopNCmd", "description": "本接口（DescribeInstanceMonitorTopNCmd）用于查询实例访问命令。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "SpanType", "type": "integer", "required": true, "description": "时间范围。 - 1：实时。 - 2：近30分钟。 - 3：近6小时。 - 4：近24小时。", "example": "4" } ], "required": [ "InstanceId", "SpanType" ] }, { "name": "DescribeInstanceMonitorTopNCmdTook", "description": "本接口（DescribeInstanceMonitorTopNCmdTook）用于查询实例 CPU 耗时。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-r34wkc1d" }, { "name": "SpanType", "type": "integer", "required": true, "description": "查询时间范围。 - 1：实时。 - 2：近30分钟。 - 3：近6小时。 - 4：近24小时。", "example": "4" } ], "required": [ "InstanceId", "SpanType" ] }, { "name": "DescribeInstanceNodeInfo", "description": "本接口（DescribeInstanceNodeInfo）用于查询实例节点信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-asdasdas" }, { "name": "Limit", "type": "integer", "required": false, "description": "列表大小。每页输出的节点信息大小。默认为 20，最多输出1000条。该字段已不再使用，请忽略。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。该字段已不再使用，请忽略。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceParamRecords", "description": "本接口（DescribeInstanceParamRecords）用于查询参数修改历史列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID 。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小。默认为100，最大值为 200。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，取Limit整数倍，默认值为0。计算公式：offset=limit*(页码-1)。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceParams", "description": "本接口（DescribeInstanceParams）用于查询实例参数列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceSecurityGroup", "description": "本接口（DescribeInstanceSecurityGroup）用于查询实例安全组信息。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例 ID 列表，数组长度限制[0,100]。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "[\"crs-f2ho5rsz\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeInstanceShards", "description": "本接口（DescribeInstanceShards）用于获取集群架构实例的分片信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-7ponppu3" }, { "name": "FilterSlave", "type": "boolean", "required": false, "description": "指定是否过滤掉从节信息。 - true；过滤从节点。 - false：不过滤。默认为 false。", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceSpecBandwidth", "description": "本接口（DescribeInstanceSpecBandwidth）用于查询或计算带宽规格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例 ID。请登录 Redis控制台 在实例列表复制实例 ID。同时，InstanceId 与规格参数不能同时为空，至少提供一种。若仅指定 InstanceId：查询该实例当前规格的带宽。若指定 InstanceId + 至少一个规格参数（ShardSize、ShardNum 或 ReplicateNum）：计算变更规格后的带宽。若指定部分或所有规格参数（ShardSize、ShardNum、ReplicateNum 与 Type），而不指定 InstanceId：根据规格组合查询理论带宽。", "example": "crs-xjhsdj****" }, { "name": "ShardSize", "type": "integer", "required": false, "description": "分片大小。单位：MB。", "example": "4096" }, { "name": "ShardNum", "type": "integer", "required": false, "description": "分片数量。", "example": "1" }, { "name": "ReplicateNum", "type": "integer", "required": false, "description": "复制组数量。", "example": "1" }, { "name": "ReadOnlyWeight", "type": "integer", "required": false, "description": "只读权重。- 100：开启从只读。- 0：关闭从只读。", "example": "0" }, { "name": "Type", "type": "integer", "required": false, "description": "实例类型，同 CreateInstances 的Type。", "example": "2" } ], "required": [] }, { "name": "DescribeInstanceSupportFeature", "description": "本接口（DescribeInstanceSupportFeature）用于查询实例支持的功能特性。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。", "example": "crs-f8bjda0p" }, { "name": "FeatureName", "type": "string", "required": true, "description": "支持查询的功能特性如下所示。 - read-local-node-only：就近接入。 - multi-account：多账号管理。 - auto-failback：故障恢复场景，主节点是否开启自动回切。", "example": "read-local-node-only" } ], "required": [ "InstanceId", "FeatureName" ] }, { "name": "DescribeInstanceZoneInfo", "description": "本接口（DescribeInstanceZoneInfo）用于查询 Redis 节点详细信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-6tl7uxxd" } ], "required": [] }, { "name": "DescribeInstances", "description": "本接口（DescribeInstances）用于查询Redis实例列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": false, "description": "每页输出实例的数量，参数默认值20，最大值为1000。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" }, { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-dagpcalj" }, { "name": "OrderBy", "type": "string", "required": false, "description": "实例列表排序依据，枚举值如下所示： - projectId：依据项目ID排序。 - createtime：依据实例创建时间排序。 - instancename：依据实例名称排序。 - type：依据实例类型排序。 - curDeadline：依据实例到期时间排序。", "example": "instancename" }, { "name": "OrderType", "type": "integer", "required": false, "description": "实例排序方式，默认为倒序排序。 - 1：倒序。 - 0：顺序。", "example": "0" }, { "name": "VpcIds", "type": "array", "required": false, "description": "私有网络 ID 数组。如果不配置该参数或设置数组为空则默认选择基础网络。例如47525。该参数暂时保留，可忽略。请根据 UniqVpcIds 参数格式设置私有网络ID数组。", "example": "47525", "item_type": "string" }, { "name": "SubnetIds", "type": "array", "required": false, "description": "私有网络所属子网 ID 数组，例如：56854。该参数暂时保留，可忽略。请根据 UniqSubnetIds 参数格式设置私有网络子网 ID 数组。", "example": "56854", "item_type": "string" }, { "name": "SearchKey", "type": "string", "required": false, "description": "设置模糊查询关键字段，仅实例名称支持模糊查询。", "example": "模糊查询实例名称" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目 ID 组成的数组。", "example": "[1289900]", "item_type": "integer" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。", "example": "example_InstanceName" }, { "name": "UniqVpcIds", "type": "array", "required": false, "description": "私有网络 ID 数组。如果不配置该参数或者设置数组为空则默认选择基础网络，如：vpc-sad23jfdfk。", "example": "vpc-b6fsjaxt", "item_type": "string" }, { "name": "UniqSubnetIds", "type": "array", "required": false, "description": "私有网络所属子网 ID 数组，如：subnet-fdj24n34j2。", "example": "subnet-gqj66zh0", "item_type": "string" }, { "name": "RegionIds", "type": "array", "required": false, "description": "地域 ID 数组，该参数已经弃用，可通过公共参数Region查询对应地域。", "example": "1", "item_type": "integer" }, { "name": "Status", "type": "array", "required": false, "description": "实例状态。 - 0：待初始化。 - 1：流程中。 - 2：运行中。 - -2：已隔离。 - -3：待删除。", "example": "1", "item_type": "integer" }, { "name": "TypeVersion", "type": "integer", "required": false, "description": "实例架构版本。 - 1：单机版。 - 2：主从版。 - 3：集群版。", "example": "2" }, { "name": "EngineName", "type": "string", "required": false, "description": "存储引擎信息。可设置为Redis-2.8、Redis-4.0、Redis-5.0、Redis-6.0 或者 CKV。", "example": "Redis-4.0" }, { "name": "AutoRenew", "type": "array", "required": false, "description": "续费模式。 - 0：手动续费。 - 1：自动续费。 - 2：到期不再续费。", "example": "1", "item_type": "integer" }, { "name": "BillingMode", "type": "string", "required": false, "description": "计费模式。 - postpaid：按量计费。 - prepaid：包年包月。", "example": "prepaid" }, { "name": "Type", "type": "integer", "required": false, "description": "实例类型。 - 2：Redis 2.8 内存版（标准架构）。 - 3：CKV 3.2 内存版（标准架构）。 - 4：CKV 3.2 内存版（集群架构）。 - 5：Redis 2.8 内存版（单机）。 - 6：Redis 4.0 内存版（标准架构）。 - 7：Redis 4.0 内存版（集群架构）。 - 8：Redis 5.0 内存版（标准架构）。 - 9：Redis 5.0 内存版（集群架构）。 - 15：Redis 6.2 内存版（标准架构）。 - 16：Redis 6.2 内存版（集群架构）。 - 17：Redis 7.0 内\ufffd\ufffd...", "example": "8" }, { "name": "SearchKeys", "type": "array", "required": false, "description": "该参数为数组类型，支持配置实例名称、实例 ID、IP地址，其中实例名称为模糊匹配，实例 ID 和 IP 地址精确匹配。 - 数组中每一个元素取并集进行匹配查询。 - **InstanceId** 与 **SearchKeys** 同时配置，则取二者交集进行匹配查询。", "example": "[\"crs-dagpcalj\"]", "item_type": "string" }, { "name": "TypeList", "type": "array", "required": false, "description": "内部参数，用户可忽略。", "example": "1", "item_type": "integer" }, { "name": "MonitorVersion", "type": "string", "required": false, "description": "内部参数，用户可忽略。", "example": "1" }, { "name": "InstanceTags", "type": "array", "required": false, "description": "根据标签的 Key 和 Value 筛选资源。该参数不配置或者数组设置为空值，则不根据标签进行过滤。", "example": "[{\"TagKey\":\"key1\",\"TagValue\":\"value1\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键。", "example": "tag-key" }, { "name": "TagValue", "type": "string", "required": true, "description": "标签值。", "example": "tag-value" } ] }, { "name": "TagKeys", "type": "array", "required": false, "description": "根据标签的 Key 筛选资源，该参数不配置或者数组设置为空值，则不根据标签Key进行过滤。", "example": "keyname", "item_type": "string" }, { "name": "ProductVersions", "type": "array", "required": false, "description": "实例的产品版本。如果该参数不配置或者数组设置为空值，则默认不依据此参数过滤实例。 - local：本地盘版。 - cdc：独享集群版。", "example": "[\"cdc\"]", "item_type": "string" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "批量查询指定的实例 ID，返回结果已 Limit 限制为主。", "example": "[\"crs-fljrtizn\",\"crs-0tbmwtop\",\"crs-i0n3dutj\"]", "item_type": "string" }, { "name": "AzMode", "type": "string", "required": false, "description": "可用区模式。 - singleaz：单可用区。 - multiaz：多可用区。", "example": "multiaz" } ], "required": [] }, { "name": "DescribeMaintenanceWindow", "description": "本接口（DescribeMaintenanceWindow）用于查询实例维护时间窗。在实例需要进行版本升级或者架构升级的时候，会在维护时间窗时间内进行切换", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" } ], "required": [ "InstanceId" ] }, { "name": "DescribeParamTemplateInfo", "description": "本接口（DescribeParamTemplateInfo）用于查询参数模板详情。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "指定查询的参数模板 ID。请通过接口[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)获取参数模板列表信息。", "example": "crs-cfg-rhlppeye" } ], "required": [ "TemplateId" ] }, { "name": "DescribeParamTemplates", "description": "本接口（DescribeParamTemplates）用于查询参数模板列表。", "status": "online", "parameters": [ { "name": "ProductTypes", "type": "array", "required": false, "description": "指定查询的产品版本与架构。6：Redis 4.0 标准架构。7：Redis 4.0 集群架构。8：Redis 5.0 标准架构。9：Redis 5.0 集群架构。15：Redis 6.2 标准架构。16：Redis 6.2 集群架构。17：Redis 7.0 标准架构。18：Redis 7.0 集群架构。19：ValKey 8.0 标准架构。20：ValKey 8.0 集群架构。", "example": "[18]", "item_type": "integer" }, { "name": "TemplateNames", "type": "array", "required": false, "description": "指定查询的参数模板名称。数据类型：字符串数组，最大长度限制为50。获取方式：请通过 Redis 控制台的参数模版 页面复制自定义模板或系统默认模板的模板名称。", "example": "[\"CustomParamTemplate\"]", "item_type": "string" }, { "name": "TemplateIds", "type": "array", "required": false, "description": "指定查询的参数模板 ID。数据类型：字符串数组，最大长度限制为50。获取方式：请通过 Redis 控制台的参数模版 页面复制自定义模板或系统默认模板的模板 ID。", "example": "[\"crs-cfg-sa23d5d3\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "指定查询结果的分页大小，即每页返回的记录数量。取值范围：0～200。默认值：200。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，用于指定查询结果的起始位置。取值：必须为 Limit 的整数倍，默认值为 0。计算公式：offset=limit*(页码-1)。", "example": "0" } ], "required": [] }, { "name": "DescribeProductInfo", "description": "本接口（DescribeProductInfo）用于查询全地域 Redis 的售卖规格。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeProjectSecurityGroup", "description": "本接口（DescribeProjectSecurityGroup）用于查询项目安全组信息。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": false, "description": "指定查询的项目 ID。 - 0：默认项目。 - -1：所有项目。 - 大于0：特定项目。请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面，在**项目名称**中复制项目 ID。", "example": "15623" }, { "name": "SecurityGroupId", "type": "string", "required": false, "description": "安全组 ID，通过接口[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)的返回参数 **InstanceSecurityGroupsDetail** 的子参数 **SecurityGroupId** 获取。", "example": "sg-gl1egaj1" } ], "required": [] }, { "name": "DescribeProjectSecurityGroups", "description": "本接口（DescribeProjectSecurityGroups）用于查询项目的安全组详情。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：redis。", "example": "redis" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面，在**项目名称**中复制项目 ID。", "example": "11954" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，取值为Limit的整数倍。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "拉取数量限制，默认 20。", "example": "20" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索条件，支持安全组 ID 或者安全组名称。", "example": "sg-0klp2oyp" } ], "required": [ "Product" ] }, { "name": "DescribeProxySlowLog", "description": "本接口（DescribeProxySlowLog）用于查询代理慢查询。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-nujgp1vw" }, { "name": "BeginTime", "type": "string", "required": true, "description": "慢查询的开始时间，查询时间最大跨度30天。", "example": "2021-02-23 11:06:01" }, { "name": "EndTime", "type": "string", "required": true, "description": "慢查询的结束时间，查询时间最大跨度30天。", "example": "2021-02-23 11:08:01" }, { "name": "MinQueryTime", "type": "integer", "required": false, "description": "慢查询阈值。取值为大于0 的正整数。单位：毫秒。", "example": "100" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页输出的任务列表大小。默认值为20，最小值为1，最大值为100。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。默认为0。取值为 Limit 整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" } ], "required": [ "InstanceId", "BeginTime", "EndTime" ] }, { "name": "DescribeRedisClusterOverview", "description": "本接口（DescribeRedisClusterOverview）用于查询 Redis 独享集群概览信息。", "status": "online", "parameters": [ { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "本地专用集群 ID，请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1 )实例列表获取集群 ID。", "example": "cluster-0astoh6a" } ], "required": [] }, { "name": "DescribeRedisClusters", "description": "本接口（DescribeRedisClusters）用于查询Redis独享集群列表。", "status": "online", "parameters": [ { "name": "RedisClusterIds", "type": "array", "required": false, "description": "Redis独享集群 ID。请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1 )切换至**云服务管理**页面，在下拉框选择**云数据库 Redis**，可获取独享集群ID。", "example": "[\"crs-cdc-p8ktf94h\"]", "item_type": "string" }, { "name": "Status", "type": "array", "required": false, "description": "集群状态。 - 1：流程。 - 2：运行中。 - 3：已隔离。", "example": "[1,2]", "item_type": "integer" }, { "name": "ProjectIds", "type": "array", "required": false, "description": "项目ID数组。请登录[项目管理](https://console.cloud.tencent.com/project)页面，在**项目名称**中复制项目 ID。", "example": "[0]", "item_type": "integer" }, { "name": "AutoRenewFlag", "type": "array", "required": false, "description": "续费模式。 - 0：默认状态，手动续费。 - 1：自动续费。 - 2：明确不自动续费。", "example": "[0,1,2]", "item_type": "integer" }, { "name": "ClusterName", "type": "string", "required": false, "description": "Redis 独享集群名称。", "example": "测试集群1" }, { "name": "SearchKey", "type": "string", "required": false, "description": "搜索关键词：支持集群 ID、集群名称。", "example": "crs-cdc-p8ktf94h" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页限制返回大小，不传则默认为20。", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，取Limit整数倍", "example": "0" }, { "name": "DedicatedClusterId", "type": "string", "required": false, "description": "本地专用集群 ID，请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1 )实例列表获取集群 ID。", "example": "cluster-0astoh6a" } ], "required": [] }, { "name": "DescribeReplicationGroup", "description": "本接口（DescribeReplicationGroup）用于查询复制组。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "每页输出实例列表的大小。取值为大于0 的正整数，默认为20。", "example": "20" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" }, { "name": "GroupId", "type": "string", "required": false, "description": "指定复制组 ID。例如：crs-rpl-m3zt****。请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID。", "example": "crs-rpl-deindi7de" }, { "name": "SearchKey", "type": "string", "required": false, "description": "模糊查询的关键字，可以设置为复制组ID或复制组名称进行模糊查询。请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID及名称。", "example": "crs-deindi7de" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeReplicationGroupInstance", "description": "本接口（DescribeReplicationGroupInstance）用于查询复制组信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-deindi7de" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSSLStatus", "description": "本接口（DescribeSSLStatus）用于查询实例 SSL 认证相关信息，包括开启状态、配置状态、证书地址等。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-deindi7de" } ], "required": [ "InstanceId" ] }, { "name": "DescribeSecondLevelBackupInfo", "description": "本接口（DescribeSecondLevelBackupInfo）用于查询实例秒级备份信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例 ID。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-asdasdas" }, { "name": "BackupTimestamp", "type": "integer", "required": false, "description": "秒级备份时间戳。 - 设置范围：支持7天内任意秒级时间点。 - 时间戳格式：Unix 时间戳。", "example": "1716449238" } ], "required": [] }, { "name": "DescribeSlowLog", "description": "本接口（DescribeSlowLog）查询实例慢查询记录。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-asdasdas" }, { "name": "BeginTime", "type": "string", "required": true, "description": "预查询慢日志的起始时间，查询时间最大跨度30天。", "example": "2019-09-08 12:12:41" }, { "name": "EndTime", "type": "string", "required": true, "description": "预查询慢日志的结束时间，查询时间最大跨度30天", "example": "2019-09-09 12:12:41" }, { "name": "MinQueryTime", "type": "integer", "required": false, "description": "慢查询平均执行时间阈值。取值为大于0 的正整数。单位：毫秒。", "example": "100" }, { "name": "Limit", "type": "integer", "required": false, "description": "每个页面展示的慢查询条数，默认值为20，最小值为1，最大值为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "慢查询条数的偏移量。默认为0。取Limit整数倍。计算公式：offset=limit*(页码-1)。", "example": "0" }, { "name": "Role", "type": "string", "required": false, "description": "节点所属角色。 - master：主节点。 - slave：从节点。", "example": "master" } ], "required": [ "InstanceId", "BeginTime", "EndTime" ] }, { "name": "DescribeTaskInfo", "description": "本接口（DescribeTaskInfo）用于获取指定任务的执行情况。", "status": "online", "parameters": [ { "name": "TaskId", "type": "integer", "required": true, "description": "任务 ID, 请通过接口[DescribeTaskList](https://cloud.tencent.com/document/product/239/39374) 的返回参数 **Tasks** 的子参数 **TaskId** 获取。", "example": "18215" } ], "required": [ "TaskId" ] }, { "name": "DescribeTaskList", "description": "本接口（DescribeTaskList）用于查询指定实例的任务列表信息。 - 可查询近30天内任务列表数据。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": false, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-opcazbrb" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例名称。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例名称。", "example": "crs-rhlppeye" }, { "name": "Limit", "type": "integer", "required": false, "description": "每页输出的任务列表大小。默认为 20，最多输出100条。", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。取值需为 Limit 的整数倍：offset=limit*(页码-1)，默认值为0。", "example": "0" }, { "name": "TaskTypes", "type": "array", "required": false, "description": "任务类型。 - FLOW_CREATE: \"001\"，新建实例。 - FLOW_RESIZE ： \"002\"，配置变更。 - FLOW_CLOSE：\"003\"，关闭实例。 - FLOW_CLEAN： \"004\"，清空实例。 - FLOW_STARTUP：\"005\"，实例启用。 - FLOW_DELETE：\"006\"，删除实例。 - FLOW_SETPWD：\"007\"，重置密码。 - FLOW_EXPORTBACKUP：\"009\"，导出备份文件。 - FLOW_RESTOREBACKUP：\"010\"，恢复备份。 - FLOW_BACKUPINSTANCE：\"012\"，备份实例。 - FLOW_MIGRATEINSTANCE：\"013\"，迁移实例。 - FLOW_...", "example": "[\"037\"]", "item_type": "string" }, { "name": "BeginTime", "type": "string", "required": false, "description": "任务执行的起始时间，格式如：2021-12-30 00:00:00，支持查询近30天内数据。", "example": "2021-12-30 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "任务运行的终止时间。格式如：2021-12-30 20:59:35，支持查询近30天内数据。", "example": "2021-12-30 20:59:35" }, { "name": "TaskStatus", "type": "array", "required": false, "description": "该参数为内部使用，请忽略。", "example": "[0,1,2]", "item_type": "integer" }, { "name": "Result", "type": "array", "required": false, "description": "任务执行状态。 - 0：任务初始化。 - 1：执行中。 - 2：完成。 - 4：失败。", "example": "[0,1,2]", "item_type": "integer" }, { "name": "OperateUin", "type": "array", "required": false, "description": "操作者账号 ID，UIN。", "example": "[\"12458915647\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeTendisSlowLog", "description": "本接口（DescribeTendisSlowLog）用于查询 Tendis 实例慢查询。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Tendis控制台](https://console.cloud.tencent.com/tendis)在实例列表复制实例 ID。", "example": "crs-asdasdas" }, { "name": "BeginTime", "type": "string", "required": true, "description": "开始时间：2019-09-08 12:12:41，查询时间最大跨度30天。", "example": "2019-09-08 12:12:41" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间：2019-09-09 12:12:41，查询时间最大跨度30天。", "example": "2019-09-09 12:12:41" }, { "name": "MinQueryTime", "type": "integer", "required": false, "description": "慢查询阈值，取值为大于0的正整数，单位：毫秒。", "example": "10" }, { "name": "Limit", "type": "integer", "required": false, "description": "页面大小。默认为20，最小为1，最大为100。", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量。默认为0，取值为 Limit 整数倍，计算公式：offset=limit*(页码-1)。", "example": "0" } ], "required": [ "InstanceId", "BeginTime", "EndTime" ] }, { "name": "DestroyPostpaidInstance", "description": "本接口（DestroyPostpaidInstance）用于销毁按量计费实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制按量计费的实例 ID。", "example": "crs-5a4py64p" } ], "required": [ "InstanceId" ] }, { "name": "DestroyPrepaidInstance", "description": "本接口（DestroyPrepaidInstance）用于退还包年包月计费的 Redis 实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" } ], "required": [ "InstanceId" ] }, { "name": "DisableReplicaReadonly", "description": "本接口（DisableReplicaReadonly）用于禁用读写分离功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" } ], "required": [ "InstanceId" ] }, { "name": "DisassociateSecurityGroups", "description": "本接口（DisassociateSecurityGroups）用于安全组批量解绑实例。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：redis。", "example": "redis" }, { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组 ID，请通过接口[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)的返回参数InstanceSecurityGroupsDetail 的子参数**SecurityGroupId**获取。", "example": "sg-ajr1jzgj" }, { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表，一个或者多个实例 ID 组成的数组。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "[\"crs-eb2w7dto\"]", "item_type": "string" } ], "required": [ "Product", "SecurityGroupId", "InstanceIds" ] }, { "name": "EnableReplicaReadonly", "description": "本接口（EnableReplicaReadonly）用于启用读写分离功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "ReadonlyPolicy", "type": "array", "required": false, "description": "只读路由策略。 - master：表示只读路由至主节点。 - replication：表示只读路由至从节点。默认值为：replication。", "example": "[\"master\"]", "item_type": "string" } ], "required": [ "InstanceId" ] }, { "name": "InquiryPriceCreateInstance", "description": "本接口（InquiryPriceCreateInstance）用于查询新购实例价格。", "status": "online", "parameters": [ { "name": "TypeId", "type": "integer", "required": true, "description": "实例类型。 - 2：Redis 2.8 内存版（标准架构）。 - 6：Redis 4.0 内存版（标准架构）。 - 7：Redis 4.0 内存版（集群架构）。 - 8：Redis 5.0 内存版（标准架构）。 - 9：Redis 5.0 内存版（集群架构）。 - 15：Redis 6.2 内存版（标准架构）。 - 16：Redis 6.2 内存版（集群架构）。 - 17：Redis 7.0 内存版（标准架构）。 - 18：Redis 7.0 内存版（集群架构）。 - 200:Memcached 1.6 内存版（集群架构）。", "example": "6" }, { "name": "MemSize", "type": "integer", "required": true, "description": "内存容量，单位为MB， 数值需为1024的整数倍，具体规格以 [查询产品售卖规格](https://cloud.tencent.com/document/api/239/30600) 返回的规格为准。 TypeId为标准架构时，MemSize是实例总内存容量；TypeId为集群架构时，MemSize是单分片内存容量。", "example": "4096" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "实例数量，单次购买实例数量以 [查询产品售卖规格](https://cloud.tencent.com/document/api/239/30600) 返回的规格为准。", "example": "1" }, { "name": "Period", "type": "integer", "required": true, "description": "购买时长，在创建包年包月实例的时候需要填写，按量计费实例填1即可，单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。", "example": "1" }, { "name": "BillingMode", "type": "integer", "required": true, "description": "付费方式。 - 0：按量计费。 - 1：包年包月。", "example": "1" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "实例所属的可用区 ID，可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。 **说明**：请在 **ZoneId** 与 **ZoneName** 中至少指定一个参数。", "example": "100002" }, { "name": "RedisShardNum", "type": "integer", "required": false, "description": "实例分片数量。 - 标准架构需要配置分片数量为1。 - 集群架构分片数量支持设置为1、3、5、8、12、16、24、32、40、48、64、80、96、128。", "example": "1" }, { "name": "RedisReplicasNum", "type": "integer", "required": false, "description": "实例副本数量。取值范围为：1、2、3、4、5。", "example": "1" }, { "name": "ReplicasReadonly", "type": "boolean", "required": false, "description": "是否支持副本只读。Redis2.8标准架构、CKV标准架构无需填写。 - true：无需支持副本只读。 - false：需支持。", "example": "false" }, { "name": "ZoneName", "type": "string", "required": false, "description": "实例所属的可用区名称，可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。 **说明**：请在 **ZoneId** 与 **ZoneName** 中至少指定一个参数。", "example": "ap-guangzhou" }, { "name": "ProductVersion", "type": "string", "required": false, "description": "部署方式。 - local：本地盘版，默认为 local。 - cloud：云盘版。 - cdc：独享集群版。", "example": "cloud" } ], "required": [ "TypeId", "MemSize", "GoodsNum", "Period", "BillingMode" ] }, { "name": "InquiryPriceRenewInstance", "description": "本接口（InquiryPriceRenewInstance）用于查询包年包月计费实例的续费价格。", "status": "online", "parameters": [ { "name": "Period", "type": "integer", "required": true, "description": "包年包月实例的购买时长。 - 单位：月。 - 取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。", "example": "1" }, { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis)在实例列表复制包年包月实例 ID。", "example": "crs-rhlppeye" } ], "required": [ "Period", "InstanceId" ] }, { "name": "InquiryPriceUpgradeInstance", "description": "本接口（InquiryPriceUpgradeInstance）用于查询实例扩容价格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-xjhsdjcxjd" }, { "name": "MemSize", "type": "integer", "required": true, "description": "分片大小，单位：MB。", "example": "4096" }, { "name": "RedisShardNum", "type": "integer", "required": false, "description": "分片数量。 - 实例为标准架构，RedisShardNum 默认为1。 - Redis 2.8主从版、CKV主从版和 Redis 2.8单机版不需要填写。", "example": "3" }, { "name": "RedisReplicasNum", "type": "integer", "required": false, "description": "副本数量，Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写。", "example": "1" } ], "required": [ "InstanceId", "MemSize" ] }, { "name": "KillMasterGroup", "description": "本接口（KillMasterGroup）用于模拟故障。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-dfndi7de" }, { "name": "Password", "type": "string", "required": false, "description": "该参数用于配置指定实例的访问密码。若为免密认证，该参数则无需配置。密码复杂度要求如下所示。 - 长度8-30位,推荐使用12位以上的密码 - 不能以\"/\"开头 - 至少包含小写字母a-z、大写字母A-Z、数字0-9及其 ()`~!@#$%^\u0026*-+=_|{}[]:;,.?/中的两项。", "example": "12345Aa" }, { "name": "ShardIds", "type": "array", "required": false, "description": "分片集群的分片 ID。请通过接口[DescribeInstanceNodeInfo](https://cloud.tencent.com/document/product/239/48603) 的返回参数 **Redis** 中的 **ClusterId** 获取。", "example": "null", "item_type": "integer" } ], "required": [ "InstanceId" ] }, { "name": "ManualBackupInstance", "description": "本接口（ManualBackupInstance）用于手动备份Redis实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "Remark", "type": "string", "required": false, "description": "手动备份任务的备注信息。", "example": "Backup instructions" }, { "name": "StorageDays", "type": "integer", "required": false, "description": "备份数据的保存天数。 - 单位：天；默认值为7天；取值范围：[0.1825]。如果超过 7天，请[提交工单](https://console.cloud.tencent.com/workorder/category)申请。 - 如果不配置该参数，默认与自动备份的保留时间一致。 - 如果未设置自动备份，默认为7天。", "example": "7" } ], "required": [ "InstanceId" ] }, { "name": "ModfiyInstancePassword", "description": "本接口（ModfiyInstancePassword）用于修改实例访问密码。鉴于该接口名存在拼写错误，现已更正为（[ModifyInstancePassword](https://cloud.tencent.com/document/product/239/111555)）接口，推荐使用更正后的接口。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "OldPassword", "type": "string", "required": true, "description": "实例旧密码。", "example": "zy456987" }, { "name": "Password", "type": "string", "required": true, "description": "实例新密码。密码复杂度要求如下： - 长度8 - 64位, 推荐使用12位以上的密码。 - 不能以\"/\"开头。 - 至少包含小写字母a - z、大写字母A - Z、数字0 - 9、特殊字符 ()~!@#$%^\u0026*-+=_|{}[]:;,.?/中的两项。", "example": "456987zy" }, { "name": "EncryptPassword", "type": "boolean", "required": false, "description": "是否加密密码", "example": "false" } ], "required": [ "InstanceId", "OldPassword", "Password" ] }, { "name": "ModifyAutoBackupConfig", "description": "本接口（ModifyAutoBackupConfig）用于设置自动备份的配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "WeekDays", "type": "array", "required": false, "description": "设置自动备份周期。可设置为Monday，Tuesday，Wednesday，Thursday，Friday，Saturday，Sunday。该参数暂不支持修改。", "example": "[\"Monday\",\"Tuesday\",\"Wednesday\",\"Thursday\",\"Friday\",\"Saturday\"]", "item_type": "string" }, { "name": "TimePeriod", "type": "string", "required": false, "description": "备份时间段。可设置为每个整点。格式如：00:00-01:00, 01:00-02:00...... 23:00-00:00。", "example": "04:00-05:00" }, { "name": "AutoBackupType", "type": "integer", "required": false, "description": "自动备份类型。目前仅能配置为：1 ，指定时备份。", "example": "1" }, { "name": "BackupStorageDays", "type": "integer", "required": false, "description": "全量备份文件保存天数。 仅支持设置为 7，单位：天。如需更长天数，请[提交工单](https://console.cloud.tencent.com/workorder/category)申请。", "example": "7" } ], "required": [ "InstanceId" ] }, { "name": "ModifyBackupDownloadRestriction", "description": "本接口（ModifyBackupDownloadRestriction）用于修改备份文件下载的网络信息与地址。", "status": "online", "parameters": [ { "name": "LimitType", "type": "string", "required": true, "description": "下载备份文件的网络限制类型： - NoLimit：不限制，腾讯云内外网均可以下载备份文件。 - LimitOnlyIntranet：仅腾讯云自动分配的内网地址可下载备份文件。 - Customize：指用户自定义的私有网络可下载备份文件。", "example": "NoLimit" }, { "name": "VpcComparisonSymbol", "type": "string", "required": false, "description": "该参数仅支持输入 In，表示自定义的**LimitVpc**可以下载备份文件。", "example": "In" }, { "name": "IpComparisonSymbol", "type": "string", "required": false, "description": "标识自定义的 LimitIp 地址是否可下载备份文件。 - In: 自定义的 IP 地址可以下载。 - NotIn: 自定义的 IP 不可以下载。", "example": "In" }, { "name": "LimitVpc", "type": "array", "required": false, "description": "自定义的可下载备份文件的 VPC ID。当参数**LimitType**为**Customize **时，需配置该参数。", "example": "无", "item_type": "object", "children": [ { "name": "Region", "type": "string", "required": true, "description": "备份文件的下载地址对应VPC 所属的地域。", "example": "ap-guangzhou" }, { "name": "VpcList", "type": "array", "required": true, "description": "备份文件下载地址的 VPC 列表。", "example": "[\"vpc-b3ksv7yt\", \"vpc-a9pl9fiu\"]", "item_type": "string" } ] }, { "name": "LimitIp", "type": "array", "required": false, "description": "自定义的可下载备份文件的 VPC IP 地址。当参数**LimitType**为**Customize **时，需配置该参数。", "example": "[\"10.1.1.12\", \"10.1.1.13\"]", "item_type": "string" } ], "required": [ "LimitType" ] }, { "name": "ModifyConnectionConfig", "description": "本接口（ModifyConnectionConfig）用于修改实例的连接配置，包括带宽和最大连接数。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-cpz6b1fn" }, { "name": "Bandwidth", "type": "integer", "required": false, "description": "附加带宽，大于0，单位MB。 **说明**：Bandwidth 和 ClientLimit 参数不能同时为空，您必须至少选择其中一个进行配置。", "example": "5" }, { "name": "ClientLimit", "type": "integer", "required": false, "description": "单分片的总连接数。 - 未开启副本只读时，下限为10000，上限为40000。 - 开启副本只读时，下限为10000，上限为10000×(只读副本数+3)。 **说明**：Bandwidth 和 ClientLimit 参数不能同时为空，您必须至少选择其中一个进行配置。", "example": "20000" } ], "required": [ "InstanceId" ] }, { "name": "ModifyDBInstanceSecurityGroups", "description": "本接口（ModifyDBInstanceSecurityGroups）用于对实例原有的安全组列表进行修改。", "status": "online", "parameters": [ { "name": "Product", "type": "string", "required": true, "description": "数据库引擎名称，本接口取值：redis。", "example": "redis" }, { "name": "SecurityGroupIds", "type": "array", "required": true, "description": "更换为新的安全组 ID 列表，即一个或者多个安全组 ID 组成的数组。 - 若实例第一次配置安全组，请使用接口[AssociateSecurityGroups](https://cloud.tencent.com/document/product/239/41260)先绑定安全组。 - 更换安全组，请在[控制台安全组](https://console.cloud.tencent.com/vpc/security-group)页面获取安全组 ID。 **注意：**该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。", "example": "[\"sg-ajr1jzgj\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-eb2w7dto" } ], "required": [ "Product", "SecurityGroupIds", "InstanceId" ] }, { "name": "ModifyInstance", "description": "本接口（ModifyInstance）用于修改实例相关信息。", "status": "online", "parameters": [ { "name": "Operation", "type": "string", "required": true, "description": "修改实例操作。如填写： - rename：表示实例重命名。 - modifyProject：修改实例所属项目。 - modifyAutoRenew：修改实例续费标记。 - modifyDeleteProtectionSwitch：修改实例删除保护。", "example": "rename" }, { "name": "InstanceIds", "type": "array", "required": false, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。每次请求的实例数量的上限为10。", "example": "[\"crs-r3nqjq3n\",\"crs-9bvd9b8v\"]", "item_type": "string" }, { "name": "InstanceNames", "type": "array", "required": false, "description": "实例的新名称。名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符-。", "example": "[\"newname1\",\"newname2\\r\\n\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目 ID，请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面，在**项目名称**中复制项目 ID。", "example": "10035" }, { "name": "AutoRenews", "type": "array", "required": false, "description": "自动续费标识。 - 0：默认状态，指手动续费。 - 1：自动续费。 - 2：明确不自动续费。", "example": "[1,0]", "item_type": "integer" }, { "name": "DeleteProtectionSwitches", "type": "array", "required": false, "description": "删除保护开关。- 0：默认状态，指关闭。- 1：开关打开。", "example": "[1,0]", "item_type": "integer" } ], "required": [ "Operation" ] }, { "name": "ModifyInstanceAccount", "description": "本接口（ModifyInstanceAccount）用于修改实例账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "AccountName", "type": "string", "required": true, "description": "指定需修改的账号。 - root：指在创建 Redis 数据库实例时自动生成的账号。用户无法修改其读写权限，仅可修改其请求路由策略。 - 自定义的账号：用户在实例创建成功后手动创建的账号。用户可以随时修改其读写权限与请求路由策略。", "example": "example_name" }, { "name": "AccountPassword", "type": "string", "required": false, "description": "指定所修改账号访问的密码。", "example": "redis***" }, { "name": "Remark", "type": "string", "required": false, "description": "账号描述信息", "example": "some account instruction" }, { "name": "ReadonlyPolicy", "type": "array", "required": false, "description": "指定所修改账号读写请求路由的策略。 - master：表示读写请求路由至主节点。 - replication：表示读写请求路由至从节点。", "example": "master", "item_type": "string" }, { "name": "Privilege", "type": "string", "required": false, "description": "指定所修改账号的读写权限。 - r：只读。 - w：只写。 - rw：读写。", "example": "rw" }, { "name": "NoAuth", "type": "boolean", "required": false, "description": "指定是否将默认账号（root）设置为免密账号。自定义账号不支持免密访问。 - true：默认账号（root）设置为免密账号。 - false：默认账号（root）不设置为免密账号。", "example": "true" }, { "name": "EncryptPassword", "type": "boolean", "required": false, "description": "指定所修改的账号是否加密密码", "example": "false" } ], "required": [ "InstanceId", "AccountName" ] }, { "name": "ModifyInstanceAvailabilityZones", "description": "本接口（ModifyInstanceAvailabilityZones）用于变更实例可用区", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****，请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。", "example": "crs-65xie09x" }, { "name": "SwitchOption", "type": "integer", "required": true, "description": "切换时间。 - 1：维护时间窗切换。 - 2：立即切换。", "example": "2" }, { "name": "NodeSet", "type": "array", "required": true, "description": "实例的节点信息，包含节点 ID、节点类型、节点可用区 ID等。具体信息，请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 单可用区实例无需传NodeId，多可用区实例NodeId必传", "example": "无", "item_type": "object", "children": [ { "name": "NodeType", "type": "integer", "required": true, "description": "节点类型。0：为主节点。1：为副本节点。", "example": "1" }, { "name": "NodeId", "type": "integer", "required": false, "description": "主节点或者副本节点的 ID。该参数用于创建 Redis 实例接口[CreateInstances](https://cloud.tencent.com/document/product/239/20026) 并不需要设置，而用于变更实例配置的接口 [UpgradeInstance](https://cloud.tencent.com/document/product/239/20013) 删除副本时才需要设置。该参数可使用接口 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 获取Integer类型的节点 ID。", "example": "1" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "主节点或者副本节点的可用区 ID。", "example": "100001" }, { "name": "ZoneName", "type": "string", "required": false, "description": "主节点或者副本节点的可用区名称。", "example": "ap-guangzhou-1" } ] } ], "required": [ "InstanceId", "SwitchOption", "NodeSet" ] }, { "name": "ModifyInstanceBackupMode", "description": "本接口（ModifyInstanceBackupMode）用于修改实例的备份模式。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例的ID。请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-asdasda2" }, { "name": "BackupMode", "type": "string", "required": false, "description": "备份模式： - SecondLevelBackup 秒级备份。 - NormalLevelBackup 普通备份。", "example": "SecondLevelBackup" } ], "required": [ "InstanceId" ] }, { "name": "ModifyInstanceEvent", "description": "本接口（ModifyInstanceEvent）用于修改实例的运维事件的执行计划。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。", "example": "crs-deindi7de" }, { "name": "EventId", "type": "integer", "required": true, "description": "事件 ID。请通过 [DescribeInstanceEvents](https://cloud.tencent.com/document/product/239/104779) 获取需修改的事件 ID。", "example": "89" }, { "name": "StartTime", "type": "string", "required": false, "description": "修改事件执行的计划开始时间。", "example": "03:10" }, { "name": "EndTime", "type": "string", "required": false, "description": "修改事件计划执行的结束时间。开始时间配置之后，结束时间只能选择在开始时间之后的 30 分钟、1 小时、1.5 小时、2 小时和 3 小时之内。", "example": "04:10" }, { "name": "ExecutionDate", "type": "string", "required": false, "description": "修改事件执行计划的开始日期。", "example": "2018-09-10" }, { "name": "Status", "type": "string", "required": false, "description": "修改事件的运行状态。该参数当前仅支持设置为 **Canceled**， 即取消执行当前事件。可通过 DescribeInstanceEvents 接口查询当前事件的运行状态与事件级别。 - 事件级别为Critical（关键）或 High（重要）类事件不支持取消。即严重的事件必须执行，不可取消。 - 仅运行状态为 Waiting （待执行的事件）的事件，才能执行取消操作。", "example": "Canceled" } ], "required": [ "InstanceId", "EventId" ] }, { "name": "ModifyInstanceLogDelivery", "description": "本接口（ModifyInstanceLogDelivery）用于开启或关闭投递实例日志到CLS。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-d8ej0xn2" }, { "name": "LogType", "type": "string", "required": true, "description": "日志类型。当前仅支持设置为slowlog，指慢查询日志。", "example": "slowlog" }, { "name": "Enabled", "type": "boolean", "required": true, "description": "日志投递开启状态。 - true：开启。 - false：关闭。", "example": "true" }, { "name": "LogsetId", "type": "string", "required": false, "description": "投递的日志集ID。通过接口[DescribeLogsets](https://cloud.tencent.com/document/api/614/58624)获取到日志集ID。", "example": "4ae3d686-0dcf-4db3-9867-482def442c9a" }, { "name": "TopicId", "type": "string", "required": false, "description": "投递的日志主题ID。通过接口[DescribeTopics](https://cloud.tencent.com/document/api/614/56454)获取到日志主题ID。", "example": "27197b72-e1cb-4fc1-ab21-3865f589136f" }, { "name": "LogsetName", "type": "string", "required": false, "description": "日志集名称。**LogsetId**为空时必传，系统会以LogsetName为名称来创建新的日志集并投递日志。", "example": "test-set-name" }, { "name": "TopicName", "type": "string", "required": false, "description": "日志主题名称。**TopicId**为空时必传，系统会以TopicName为名称来创建新的日志主题并投递日志。", "example": "test-topic-name" }, { "name": "LogRegion", "type": "string", "required": false, "description": "日志集所在地域，不传默认使用实例所在地域。", "example": "ap-shanghai" }, { "name": "Period", "type": "integer", "required": false, "description": "日志存储时间，默认为30天，可选范围1-3600天。", "example": "30" }, { "name": "CreateIndex", "type": "boolean", "required": false, "description": "创建日志主题时，是否创建索引。", "example": "true" } ], "required": [ "InstanceId", "LogType", "Enabled" ] }, { "name": "ModifyInstanceParams", "description": "本接口（ModifyInstanceParams）用于修改 Redis 实例的参数配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "InstanceParams", "type": "array", "required": true, "description": "实例修改的参数列表。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "设置参数的名称。例如timeout。当前支持自定义的参数，请参见参数配置。", "example": "timeout" }, { "name": "Value", "type": "string", "required": true, "description": "设置参数名称对应的运行值。例如timeout对应运行值可设置为120， 单位为秒（s）。指当客户端连接闲置时间达到120 s时，将关闭连接。更多参数取值信息，请参见参数配置。", "example": "120" } ] } ], "required": [ "InstanceId", "InstanceParams" ] }, { "name": "ModifyInstancePassword", "description": "本接口（ModifyInstancePassword）用于修改实例访问密码。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "OldPassword", "type": "string", "required": true, "description": "实例旧密码。", "example": "zy456987" }, { "name": "Password", "type": "string", "required": true, "description": "实例新密码。密码复杂度要求如下： - 长度8 - 30位, 推荐使用12位以上的密码。 - 不能以\"/\"开头。 - 至少包含小写字母a - z、大写字母A - Z、数字0 - 9、特殊字符 ()~!@#$%^\u0026*-+=_|{}[]:;,.?/中的两项。", "example": "456987zy" } ], "required": [ "InstanceId", "OldPassword", "Password" ] }, { "name": "ModifyInstanceReadOnly", "description": "本接口（ModifyInstanceReadOnly）用于设置实例输入模式。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-deindi7de" }, { "name": "InputMode", "type": "string", "required": true, "description": "实例输入模式。 - 0：读写。 - 1：只读。", "example": "1" } ], "required": [ "InstanceId", "InputMode" ] }, { "name": "ModifyMaintenanceWindow", "description": "本接口（ModifyMaintenanceWindow）用于修改实例维护时间窗时间，需要进行版本升级或者架构升级的实例，会在维护时间窗内进行时间切换。注意：已经发起版本升级或者架构升级的实例，无法修改维护时间窗。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "StartTime", "type": "string", "required": true, "description": "维护时间窗起始时间，如：17:00。", "example": "03:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "维护时间窗结束时间，如：19:00。 **说明：**维护时间窗时长，当前支持：30分钟、1小时、1.5小时、2小时、3小时。", "example": "06:00" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "ModifyNetworkConfig", "description": "本接口（ModifyNetworkConfig）用于修改实例网络配置。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "Operation", "type": "string", "required": true, "description": "指预修改网络的类别，包括： - changeVip：指切换私有网络，包含其内网IPv4地址及端口。 - changeVpc：指切换私有网络所属子网。 - changeBaseToVpc：指基础网络切换为私有网络。 - changeVPort：指仅修改实例网络端口。", "example": "changeVip" }, { "name": "Vip", "type": "string", "required": false, "description": "指实例私有网络内网 IPv4 地址。当**Operation**为**changeVip**时，需配置该参数。", "example": "10.1.1.2" }, { "name": "VpcId", "type": "string", "required": false, "description": "指修改后的私有网络 ID。 - 当**Operation**为**changeVpc**或**changeBaseToVpc**时，需配置该参数。 - 请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)，切换至**实例详情**页面，在**网络信息**区域，单击所属网络后面的私有网络名称，获取私有网络 ID。", "example": "vpc-hu6khgap" }, { "name": "SubnetId", "type": "string", "required": false, "description": "指修改后的私有网络所属子网 ID。 - 当**Operation**为**changeVpc**或**changeBaseToVpc**时，需配置该参数。 - 请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)，切换至**实例详情**页面，在**网络信息**区域，单击所属网络后面的子网名称，获取子网ID。", "example": "subnet-6mt7lir6" }, { "name": "Recycle", "type": "integer", "required": false, "description": "原内网 IPv4 地址保留时长。 - 单位：天。 - 取值范围：0、1、2、3、7、15。 **说明**：保留时长不设置或者设置为0，原网络地址将立即释放。", "example": "7" }, { "name": "VPort", "type": "integer", "required": false, "description": "指修改后的网络端口。当**Operation**为**changeVPort**或**changeVip**时，需配置该参数。取值范围为[1024,65535]。", "example": "6379" } ], "required": [ "InstanceId", "Operation" ] }, { "name": "ModifyParamTemplate", "description": "本接口（ModifyParamTemplate）用于修改参数模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "源参数模板 ID。 请通过接口[DescribeParamTemplateInfo](https://cloud.tencent.com/document/product/239/58748)的返回参数 **TemplateId** 获取参数模板 ID。", "example": "crs-cfg-rhlppeye" }, { "name": "Name", "type": "string", "required": false, "description": "参数模板修改后的新名称。", "example": "自定义参数模板" }, { "name": "Description", "type": "string", "required": false, "description": "参数模板修改后的新描述。", "example": "参数模板描述" }, { "name": "ParamList", "type": "array", "required": false, "description": "修改后的新参数列表。", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "设置参数的名称。例如timeout。当前支持自定义的参数，请参见参数配置。", "example": "timeout" }, { "name": "Value", "type": "string", "required": true, "description": "设置参数名称对应的运行值。例如timeout对应运行值可设置为120， 单位为秒（s）。指当客户端连接闲置时间达到120 s时，将关闭连接。更多参数取值信息，请参见参数配置。", "example": "120" } ] } ], "required": [ "TemplateId" ] }, { "name": "ModifyReplicationGroup", "description": "本接口（ModifyReplicationGroup）用于修改复制组信息。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。", "example": "crs-rpl-qhj4wgcn" }, { "name": "GroupName", "type": "string", "required": false, "description": "修改后的复制组名称。", "example": "复制组名称" }, { "name": "Remark", "type": "string", "required": false, "description": "备注描述。", "example": "备注" } ], "required": [ "GroupId" ] }, { "name": "OpenSSL", "description": "本接口（OpenSSL）用于开启 SSL 加密认证功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-deindi7de" } ], "required": [ "InstanceId" ] }, { "name": "ReleaseWanAddress", "description": "本接口（ReleaseWanAddress）用于关闭外网访问。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-dvchdv5" } ], "required": [ "InstanceId" ] }, { "name": "RemoveReplicationGroup", "description": "本接口（RemoveReplicationGroup）用于删除复制组。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "复制组ID。请登录 [Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication) 页面获取复制组 ID。", "example": "crs-rpl-xxx" } ], "required": [ "GroupId" ] }, { "name": "RemoveReplicationInstance", "description": "本接口（RemoveReplicationInstance）用于移除复制组中的实例。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "复制组 ID。例如：crs-rpl-m3zt****。请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID。", "example": "crs-rpl-deindi7de" }, { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。", "example": "crs-deindi7de" }, { "name": "SyncType", "type": "boolean", "required": true, "description": "数据同步类型。 - true：需数据强同步。 - false：无需强同步，仅限删除主实例。", "example": "false" } ], "required": [ "GroupId", "InstanceId", "SyncType" ] }, { "name": "RenewInstance", "description": "本接口（RenewInstance）可用于为实例续费。", "status": "online", "parameters": [ { "name": "Period", "type": "integer", "required": true, "description": "购买时长。 - 单位：月。 - 取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。", "example": "12" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录 [Redis 控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "ModifyPayMode", "type": "string", "required": false, "description": "标识是否修改计费模式。 - 当前实例计费模式为按量计费方式，预转换为包年包月而续费，请指定该参数为 prepaid。 - 当前实例计费模式为包年包月方式，可不设置该参数。", "example": "PREPAID" } ], "required": [ "Period", "InstanceId" ] }, { "name": "ResetPassword", "description": "本接口（ResetPassword）用于重置实例访问密码。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "Password", "type": "string", "required": false, "description": "重置的密码。若切换为免密实例时，可不配置该参数。 - 长度8-32位, 推荐使用12位以上的密码。 - 不能以\"/\"开头。 - 至少包含小写字母a- z、大写字母A - Z、数字0 - 9、特殊字符 ()~!@#$%^\u0026*-+=_|{}[]:;,.?/中的两项。", "example": "zy456987" }, { "name": "NoAuth", "type": "boolean", "required": false, "description": "是否切换免密实例。 - false：切换为非免密码实例。默认 false。 - true：切换为免密码实例。", "example": "true" }, { "name": "EncryptPassword", "type": "boolean", "required": false, "description": "是否加密密码。 - false：非加密密码。默认 false。 - true：加密密码。", "example": "false" } ], "required": [ "InstanceId" ] }, { "name": "RestoreInstance", "description": "本接口（RestoreInstance）用于恢复实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待操作的实例ID，可通过 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 接口返回值中的 InstanceId 获取。", "example": "crs-5a4py64p" }, { "name": "BackupId", "type": "string", "required": true, "description": "备份ID，可通过 [DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011) 接口返回的参数 RedisBackupSet 获取。", "example": "\"154572601-1165734321-153731245\"" }, { "name": "Password", "type": "string", "required": false, "description": "实例密码，恢复实例时，需要校验实例密码（免密实例不需要传密码）", "example": "mypassword" } ], "required": [ "InstanceId", "BackupId" ] }, { "name": "StartupInstance", "description": "本接口（StartupInstance）用于实例解隔离。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在回收站复制需解隔离的实例 ID。", "example": "crs-7ponppu3" } ], "required": [ "InstanceId" ] }, { "name": "SwitchAccessNewInstance", "description": "本接口（SwitchAccessNewInstance）针对处于时间窗口中待切换操作的实例，用户可主动发起该操作。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。 示例值：crs-asdasdas", "example": "crs-0k6k7gzo" } ], "required": [ "InstanceId" ] }, { "name": "SwitchInstanceVip", "description": "在通过 DTS 支持跨可用区灾备的场景中，通过该接口（SwitchInstanceVip）交换实例 VIP 完成实例灾备切换。交换 VIP 后目标实例可写，源和目标实例VIP互换，同时源与目标实例间 DTS 同步任务断开。", "status": "online", "parameters": [ { "name": "SrcInstanceId", "type": "string", "required": true, "description": "源实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5a4py64p" }, { "name": "DstInstanceId", "type": "string", "required": true, "description": "目标实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-1kl0iy0v" }, { "name": "TimeDelay", "type": "integer", "required": false, "description": "单位为秒。源实例与目标实例间DTS已断开时间。如果 DTS 断开时间大于TimeDelay，则不切换VIP，建议尽量根据业务设置一个可接受的值。", "example": "100" }, { "name": "ForceSwitch", "type": "integer", "required": false, "description": "在 DTS 断开的情况下是否强制切换。 - 1：强制切换。 - 0：不强制切换。", "example": "1" }, { "name": "SwitchTime", "type": "string", "required": false, "description": "now: 立即切换，syncComplete：等待同步完成后切换", "example": "now" } ], "required": [ "SrcInstanceId", "DstInstanceId" ] }, { "name": "SwitchProxy", "description": "本接口（SwitchProxy）为 Proxy 模拟故障接口。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-deindi7de" }, { "name": "ProxyID", "type": "string", "required": false, "description": "实例 ProxyID，请通过接口[DescribeInstanceNodeInfo](https://cloud.tencent.com/document/product/239/48603)的返回参数**Proxy**中的**NodeId**获取。", "example": "6ff0eb7815606bb7e3f14cdde9410b64b488e8f9" }, { "name": "ProxyIDList", "type": "array", "required": false, "description": "实例 ProxyID列表，请通过接口[DescribeInstanceNodeInfo](https://cloud.tencent.com/document/product/239/48603)的返回参数**Proxy**中的**NodeId**获取。", "example": "[\"896873be5805ebacae5042311237e6d2d78be00b\"]", "item_type": "string" } ], "required": [ "InstanceId" ] }, { "name": "UpgradeInstance", "description": "本接口（UpgradeInstance）用于变更实例的配置规格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "待变更实例 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-5qlr****" }, { "name": "MemSize", "type": "integer", "required": true, "description": "指实例每个分片内存变更后的大小。 - 单位 MB。 - 每次只能修改参数MemSize、RedisShardNum和RedisReplicasNum其中的一个，不能同时修改。且修改其中一个参数时，其他两个参数需输入实例原有的配置规格。 - 缩容时，缩容后的规格务必要大于等于使用容量的1.3倍，否则将执行失败。", "example": "3096" }, { "name": "RedisShardNum", "type": "integer", "required": false, "description": "指实例变更后的分片数量。 - 标准架构不需要配置该参数，集群架构为必填参数。 - 集群架构，每次只能修改参数RedisShardNum、MemSize和RedisReplicasNum其中的一个，不能同时修改。且修改其中一个参数时，其他两个参数需输入实例原有的配置规格。", "example": "3" }, { "name": "RedisReplicasNum", "type": "integer", "required": false, "description": "指实例变更后的副本数量。 - 每次只能修改参数 RedisReplicasNum、MemSize 和 RedisShardNum 其中的一个，不能同时修改。且修改其中一个参数时，其他两个参数需输入实例原有的配置规格。 - 多AZ实例修改副本时必须要传入 NodeSet。", "example": "2" }, { "name": "NodeSet", "type": "array", "required": false, "description": "多AZ实例，增加副本时的节点信息，包括副本的 ID 编号及可用区信息。非多AZ实例不需要配置该参数。", "example": "无", "item_type": "object", "children": [ { "name": "NodeType", "type": "integer", "required": true, "description": "节点类型。0：为主节点。1：为副本节点。", "example": "1" }, { "name": "NodeId", "type": "integer", "required": false, "description": "主节点或者副本节点的 ID。该参数用于创建 Redis 实例接口[CreateInstances](https://cloud.tencent.com/document/product/239/20026) 并不需要设置，而用于变更实例配置的接口 [UpgradeInstance](https://cloud.tencent.com/document/product/239/20013) 删除副本时才需要设置。该参数可使用接口 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 获取Integer类型的节点 ID。", "example": "1" }, { "name": "ZoneId", "type": "integer", "required": false, "description": "主节点或者副本节点的可用区 ID。", "example": "100001" }, { "name": "ZoneName", "type": "string", "required": false, "description": "主节点或者副本节点的可用区名称。", "example": "ap-guangzhou-1" } ] }, { "name": "SwitchOption", "type": "integer", "required": false, "description": "切换时间。 - 1：维护时间窗操作：指升级规格在设置的维护时间窗内执行。请通过接口[DescribeMaintenanceWindow](https://cloud.tencent.com/document/product/239/46336)查询设置的维护时间窗时间段。增减副本、增减分片、扩缩内存均支持在维护时间窗执行操作。维护时间窗升级规格正在分地域逐步测试发布中，部分区域已支持，未覆盖地域若需紧急接入，请[提交工单](https://console.cloud.tencent.com/...", "example": "2" } ], "required": [ "InstanceId", "MemSize" ] }, { "name": "UpgradeInstanceVersion", "description": "本接口（UpgradeInstanceVersion）用于将当前实例升级到更高版本，或者将当前标准架构升级至集群架构。", "status": "online", "parameters": [ { "name": "TargetInstanceType", "type": "string", "required": true, "description": "目标实例类型，同 [CreateInstances](https://cloud.tencent.com/document/api/239/20026) 的**TypeId**，即实例要变更的目标类型。 - Redis 4.0 及以上的版本，支持相同版本的实例从标准架构升级至集群架构，例如，支持 Redis 4.0 标准架构升级至 Redis 4.0 集群架构。 - 不支持跨版本架构升级，例如，Redis 4.0 标准架构升级至 Redis 5.0 集群架构。 - 不支持 Redis 2.8 版本升级架构。 - 不支持从集群架构降级至...", "example": "6" }, { "name": "SwitchOption", "type": "integer", "required": true, "description": "切换时间。 - 1：维护时间窗切换。 - 2：立即切换。", "example": "2" }, { "name": "InstanceId", "type": "string", "required": true, "description": "指定实例 ID。例如：crs-xjhsdj****，请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)在实例列表复制实例 ID。", "example": "crs-5qlrlhux" } ], "required": [ "TargetInstanceType", "SwitchOption", "InstanceId" ] }, { "name": "UpgradeProxyVersion", "description": "本接口（UpgradeProxyVersion）用于升级实例 Proxy 版本。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-dvchdv5" }, { "name": "CurrentProxyVersion", "type": "string", "required": true, "description": "当前 Proxy 版本。请通过 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 接口获取实例当前 Proxy 版本。", "example": "5.0.0" }, { "name": "UpgradeProxyVersion", "type": "string", "required": true, "description": "可升级的 Redis 版本。请通过 [DescribeInstances](https://cloud.tencent.com/document/product/239/20018) 接口获取实例可升级的 Redis 版本。", "example": "5.0.1" }, { "name": "InstanceTypeUpgradeNow", "type": "integer", "required": true, "description": "指定是否立即升级。 - 1：立即升级。 - 0：维护时间窗口升级。", "example": "1" } ], "required": [ "InstanceId", "CurrentProxyVersion", "UpgradeProxyVersion", "InstanceTypeUpgradeNow" ] }, { "name": "UpgradeSmallVersion", "description": "本接口（UpgradeSmallVersion）用于实例小版本升级。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。", "example": "crs-dvchdv5" }, { "name": "CurrentRedisVersion", "type": "string", "required": true, "description": "当前 Redis 小版本。小版本信息，请参见[升级实例版本](https://cloud.tencent.com/document/product/239/46457)。", "example": "5.0.0" }, { "name": "UpgradeRedisVersion", "type": "string", "required": true, "description": "升级后的 Redis 小版本。小版本信息，请参见[升级实例版本](https://cloud.tencent.com/document/product/239/46457)。", "example": "5.0.1" }, { "name": "InstanceTypeUpgradeNow", "type": "integer", "required": true, "description": "指定是否立即升级。 - 1：立即升级。 - 0：维护时间窗口升级。", "example": "1" } ], "required": [ "InstanceId", "CurrentRedisVersion", "UpgradeRedisVersion", "InstanceTypeUpgradeNow" ] }, { "name": "UpgradeVersionToMultiAvailabilityZones", "description": "本接口已废弃。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，请登录 Redis 控制台在实例列表复制实例 ID。", "example": "crs-rhlppeye" }, { "name": "UpgradeProxyAndRedisServer", "type": "boolean", "required": false, "description": "升级多可用区之后是否支持就近访问功能。- true：支持就近访问功能。升级过程，需同时升级 Proxy 版本和 Redis 内核小版本，涉及数据搬迁，可能会长达数小时。- false：无需支持就近访问功能。升级多可用区仅涉及管理元数据迁移，对服务没有影响，升级过程通常在3分钟内完成。默认为 false。", "example": "true" } ], "required": [ "InstanceId" ] } ] }