lib/v20180412/models.rb in tencentcloud-sdk-redis-3.0.945 vs lib/v20180412/models.rb in tencentcloud-sdk-redis-3.0.946

- old
+ new

@@ -72,13 +72,13 @@ end end # AddReplicationInstance请求参数结构体 class AddReplicationInstanceRequest < TencentCloud::Common::AbstractModel - # @param GroupId: 复制组ID。 + # @param GroupId: 复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。 # @type GroupId: String - # @param InstanceId: 实例ID。 + # @param InstanceId: 实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String # @param InstanceRole: 给复制组添加的实例分配角色。<ul><li>rw：可读写。</li><li>r：只读。</li></ul> # @type InstanceRole: String attr_accessor :GroupId, :InstanceId, :InstanceRole @@ -116,11 +116,11 @@ end end # AllocateWanAddress请求参数结构体 class AllocateWanAddressRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -156,13 +156,13 @@ end end # ApplyParamsTemplate请求参数结构体 class ApplyParamsTemplateRequest < TencentCloud::Common::AbstractModel - # @param InstanceIds: 实例ID列表 + # @param InstanceIds: 实例 ID 列表，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceIds: Array - # @param TemplateId: 应用的参数模板ID + # @param TemplateId: 应用的参数模板ID，请通过接口[DescribeParamTemplateInfo](https://cloud.tencent.com/document/product/239/58748)的返回参数 **TemplateId** 获取参数模板 ID。 # @type TemplateId: String attr_accessor :InstanceIds, :TemplateId def initialize(instanceids=nil, templateid=nil) @@ -198,13 +198,13 @@ # AssociateSecurityGroups请求参数结构体 class AssociateSecurityGroupsRequest < TencentCloud::Common::AbstractModel # @param Product: 数据库引擎名称，本接口取值：redis。 # @type Product: String - # @param SecurityGroupId: 要绑定的安全组ID，类似sg-efil73jd。 + # @param SecurityGroupId: 要绑定的安全组ID，请在[控制台安全组](https://console.cloud.tencent.com/vpc/security-group)页面获取安全组 ID。 # @type SecurityGroupId: String - # @param InstanceIds: 被绑定的实例ID，类似ins-lesecurk，支持指定多个实例。 + # @param InstanceIds: 被绑定的实例ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID，支持指定多个实例。 # @type InstanceIds: Array attr_accessor :Product, :SecurityGroupId, :InstanceIds def initialize(product=nil, securitygroupid=nil, instanceids=nil) @@ -448,15 +448,17 @@ end end # ChangeInstanceRole请求参数结构体 class ChangeInstanceRoleRequest < TencentCloud::Common::AbstractModel - # @param GroupId: 复制组ID + # @param GroupId: 复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。 # @type GroupId: String - # @param InstanceId: 实例ID + # @param InstanceId: 实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param InstanceRole: 实例角色，rw可读写，r只读 + # @param InstanceRole: 实例角色。 + # - rw：可读写。 + # - r：只读。 # @type InstanceRole: String attr_accessor :GroupId, :InstanceId, :InstanceRole def initialize(groupid=nil, instanceid=nil, instancerole=nil) @@ -579,11 +581,11 @@ end end # CleanUpInstance请求参数结构体 class CleanUpInstanceRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -615,13 +617,15 @@ end end # ClearInstance请求参数结构体 class ClearInstanceRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String - # @param Password: redis的实例密码（免密实例不需要传密码，非免密实例必传） + # @param Password: 实例访问密码。 + # - 免密访问：无需配置。 + # - 密码认证：必须配置。字符个数为[8,64]，至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种，不能以"/"开头。 # @type Password: String attr_accessor :InstanceId, :Password def initialize(instanceid=nil, password=nil) @@ -790,11 +794,11 @@ end end # CloseSSL请求参数结构体 class CloseSSLRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID。 + # @param InstanceId: 实例 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -846,13 +850,13 @@ end end # CreateInstanceAccount请求参数结构体 class CreateInstanceAccountRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例 ID。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String - # @param AccountName: 自定义访问数据库的名称。 + # @param AccountName: 自定义的访问数据库的账号名称。 # - 仅由字母、数字、下划线、中划线组成。 # - 长度不能大于32位。 # @type AccountName: String # @param AccountPassword: 设置自定义账号的密码。密码复杂度要求如下： # - 字符个数为[8,64]。 @@ -1168,13 +1172,13 @@ end end # CreateReplicationGroup请求参数结构体 class CreateReplicationGroupRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 指定复制组中的主实例ID。 + # @param InstanceId: 指定复制组中的主实例ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String - # @param GroupName: 复制组名称。名称只支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。 + # @param GroupName: 配置复制组名称。仅支持长度为2-64个字符的中文、英文、数字、下划线_、分隔符-。 # @type GroupName: String # @param Remark: 备注信息。 # @type Remark: String attr_accessor :InstanceId, :GroupName, :Remark @@ -1242,13 +1246,13 @@ end end # DeleteInstanceAccount请求参数结构体 class DeleteInstanceAccountRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String - # @param AccountName: 子账号名称 + # @param AccountName: 子账号名称。请登录[Redis控制台](https://console.cloud.tencent.com/redis)，切换至**账号管理**页面获取。具体信息，请参见[管理账号](https://cloud.tencent.com/document/product/239/36710)。 # @type AccountName: String attr_accessor :InstanceId, :AccountName def initialize(instanceid=nil, accountname=nil) @@ -1314,15 +1318,17 @@ end end # DeleteReplicationInstance请求参数结构体 class DeleteReplicationInstanceRequest < TencentCloud::Common::AbstractModel - # @param GroupId: 复制组ID + # @param GroupId: 复制组ID。请登录[Redis控制台的全球复制](https://console.cloud.tencent.com/redis/replication)页面获取复制组 ID。 # @type GroupId: String - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String - # @param SyncType: 数据同步类型，true:需要数据强同步,false:不需要强同步，仅限删除主实例 + # @param SyncType: 数据同步类型。 + # - true：需要数据强同步。 + # - false：不需要强同步，仅限删除主实例。 # @type SyncType: Boolean attr_accessor :GroupId, :InstanceId, :SyncType def initialize(groupid=nil, instanceid=nil, synctype=nil) @@ -1410,11 +1416,11 @@ end end # DescribeBackupDetail请求参数结构体 class DescribeBackupDetailRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例 ID。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String # @param BackupId: 备份 ID，可通过接口 [DescribeInstanceBackups](https://cloud.tencent.com/document/product/239/20011) 返回的参数 **RedisBackupSet** 获取。 # @type BackupId: String attr_accessor :InstanceId, :BackupId @@ -1660,11 +1666,11 @@ end end # DescribeBandwidthRange请求参数结构体 class DescribeBandwidthRangeRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例 ID。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -2030,11 +2036,11 @@ end end # DescribeInstanceDTSInfo请求参数结构体 class DescribeInstanceDTSInfoRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -2521,11 +2527,11 @@ end end # DescribeInstanceMonitorSIP请求参数结构体 class DescribeInstanceMonitorSIPRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例Id + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -2564,11 +2570,11 @@ end end # DescribeInstanceMonitorTookDist请求参数结构体 class DescribeInstanceMonitorTookDistRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例 ID。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String # @param Date: 查询时间日期。 # @type Date: String # @param SpanType: 时间范围。 # - 1：实时。 @@ -2670,11 +2676,11 @@ end end # DescribeInstanceMonitorTopNCmdTook请求参数结构体 class DescribeInstanceMonitorTopNCmdTookRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例 ID。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String # @param SpanType: 查询时间范围。 # - 1：实时。 # - 2：近30分钟。 # - 3：近6小时。 @@ -3577,13 +3583,16 @@ end end # DescribeProjectSecurityGroup请求参数结构体 class DescribeProjectSecurityGroupRequest < TencentCloud::Common::AbstractModel - # @param ProjectId: 0:默认项目；-1 所有项目; >0: 特定项目 + # @param ProjectId: 指定查询的项目 ID。 + # - 0：默认项目。 + # - -1：所有项目。 + # - 大于0：特定项目。请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面，在**项目名称**中复制项目 ID。 # @type ProjectId: Integer - # @param SecurityGroupId: 安全组Id + # @param SecurityGroupId: 安全组 ID，通过接口[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)的返回参数 **InstanceSecurityGroupsDetail** 的子参数 **SecurityGroupId** 获取。 # @type SecurityGroupId: String attr_accessor :ProjectId, :SecurityGroupId def initialize(projectid=nil, securitygroupid=nil) @@ -3626,11 +3635,11 @@ # DescribeProjectSecurityGroups请求参数结构体 class DescribeProjectSecurityGroupsRequest < TencentCloud::Common::AbstractModel # @param Product: 数据库引擎名称，本接口取值：redis。 # @type Product: String - # @param ProjectId: 项目 ID。 + # @param ProjectId: 项目 ID，请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面，在**项目名称**中复制项目 ID。 # @type ProjectId: Integer # @param Offset: 偏移量，取值为Limit的整数倍。 # @type Offset: Integer # @param Limit: 拉取数量限制，默认 20。 # @type Limit: Integer @@ -3754,11 +3763,12 @@ end end # DescribeRedisClusterOverview请求参数结构体 class DescribeRedisClusterOverviewRequest < TencentCloud::Common::AbstractModel - # @param DedicatedClusterId: 本地专用集群id + # @param DedicatedClusterId: 本地专用集群 ID，请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1 + # )实例列表获取集群 ID。 # @type DedicatedClusterId: String attr_accessor :DedicatedClusterId def initialize(dedicatedclusterid=nil) @@ -3794,27 +3804,35 @@ end end # DescribeRedisClusters请求参数结构体 class DescribeRedisClustersRequest < TencentCloud::Common::AbstractModel - # @param RedisClusterIds: Redis独享集群id + # @param RedisClusterIds: Redis独享集群 ID。请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1 + # )切换至**云服务管理**页面，在下拉框选择**云数据库 Redis**，可获取独享集群ID。 # @type RedisClusterIds: Array - # @param Status: 集群状态：1-流程中，2-运行中，3-已隔离 + # @param Status: 集群状态。 + # - 1：流程。 + # - 2：运行中。 + # - 3：已隔离。 # @type Status: Array - # @param ProjectIds: 项目ID数组 + # @param ProjectIds: 项目ID数组。请登录[项目管理](https://console.cloud.tencent.com/project)页面，在**项目名称**中复制项目 ID。 # @type ProjectIds: Array - # @param AutoRenewFlag: 续费模式：0 - 默认状态（手动续费）；1 - 自动续费；2 - 明确不自动续费 + # @param AutoRenewFlag: 续费模式。 + # - 0：默认状态，手动续费。 + # - 1：自动续费。 + # - 2：明确不自动续费。 # @type AutoRenewFlag: Array - # @param ClusterName: Redis独享集群名称 + # @param ClusterName: Redis 独享集群名称。 # @type ClusterName: String - # @param SearchKey: 搜索关键词：支持集群Id、集群名称 + # @param SearchKey: 搜索关键词：支持集群 ID、集群名称。 # @type SearchKey: String - # @param Limit: 分页限制返回大小，不传则默认为20 + # @param Limit: 分页限制返回大小，不传则默认为20。 # @type Limit: Integer # @param Offset: 偏移量，取Limit整数倍 # @type Offset: Integer - # @param DedicatedClusterId: 本地专用集群id + # @param DedicatedClusterId: 本地专用集群 ID，请登录[专用集群控制台](https://console.cloud.tencent.com/cdc/dedicatedcluster/index?rid=1 + # )实例列表获取集群 ID。 # @type DedicatedClusterId: String attr_accessor :RedisClusterIds, :Status, :ProjectIds, :AutoRenewFlag, :ClusterName, :SearchKey, :Limit, :Offset, :DedicatedClusterId def initialize(redisclusterids=nil, status=nil, projectids=nil, autorenewflag=nil, clustername=nil, searchkey=nil, limit=nil, offset=nil, dedicatedclusterid=nil) @@ -4128,11 +4146,11 @@ end end # DescribeTaskInfo请求参数结构体 class DescribeTaskInfoRequest < TencentCloud::Common::AbstractModel - # @param TaskId: 任务 ID。 + # @param TaskId: 任务 ID, 请通过接口[DescribeTaskList](https://cloud.tencent.com/document/product/239/39374) 的返回参数 **Tasks** 的子参数 **TaskId** 获取。 # @type TaskId: Integer attr_accessor :TaskId def initialize(taskid=nil) @@ -4336,11 +4354,11 @@ end end # DescribeTendisSlowLog请求参数结构体 class DescribeTendisSlowLogRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例Id：crs-ngvou0i1 + # @param InstanceId: 实例 ID，请登录[Tendis控制台](https://console.cloud.tencent.com/tendis)在实例列表复制实例 ID。 # @type InstanceId: String # @param BeginTime: 开始时间：2019-09-08 12:12:41，查询时间最大跨度30天。 # @type BeginTime: String # @param EndTime: 结束时间：2019-09-09 12:12:41，查询时间最大跨度30天。 # @type EndTime: String @@ -4403,11 +4421,11 @@ end end # DestroyPostpaidInstance请求参数结构体 class DestroyPostpaidInstanceRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -4439,11 +4457,11 @@ end end # DestroyPrepaidInstance请求参数结构体 class DestroyPrepaidInstanceRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -4475,11 +4493,11 @@ end end # DisableReplicaReadonly请求参数结构体 class DisableReplicaReadonlyRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例序号ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -4514,13 +4532,13 @@ # DisassociateSecurityGroups请求参数结构体 class DisassociateSecurityGroupsRequest < TencentCloud::Common::AbstractModel # @param Product: 数据库引擎名称，本接口取值：redis。 # @type Product: String - # @param SecurityGroupId: 安全组 ID。 + # @param SecurityGroupId: 安全组 ID，请通过接口[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)的返回参数InstanceSecurityGroupsDetail 的子参数**SecurityGroupId**获取。 # @type SecurityGroupId: String - # @param InstanceIds: 实例ID列表，一个或者多个实例 ID 组成的数组。 + # @param InstanceIds: 实例ID列表，一个或者多个实例 ID 组成的数组。请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceIds: Array attr_accessor :Product, :SecurityGroupId, :InstanceIds def initialize(product=nil, securitygroupid=nil, instanceids=nil) @@ -4552,13 +4570,16 @@ end end # EnableReplicaReadonly请求参数结构体 class EnableReplicaReadonlyRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例序号ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param ReadonlyPolicy: 账号路由策略：填写master或者replication，表示路由主节点，从节点；不填路由策略默认为写主节点，读从节点 + # @param ReadonlyPolicy: 只读路由策略。 + # - master：表示只读路由至主节点。 + # - replication：表示只读路由至从节点。 + # - 默认策略：表示写主节点，读从节点。 # @type ReadonlyPolicy: Array attr_accessor :InstanceId, :ReadonlyPolicy def initialize(instanceid=nil, readonlypolicy=nil) @@ -4876,17 +4897,17 @@ end end # InquiryPriceUpgradeInstance请求参数结构体 class InquiryPriceUpgradeInstanceRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例Id + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param MemSize: 分片大小 单位 MB + # @param MemSize: 分片大小，单位：MB。 # @type MemSize: Integer - # @param RedisShardNum: 分片数量，Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写 + # @param RedisShardNum: 分片数量，Redis 2.8主从版、CKV主从版和Redis2.8单机版不需要填写。 # @type RedisShardNum: Integer - # @param RedisReplicasNum: 副本数量，Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写 + # @param RedisReplicasNum: 副本数量，Redis2.8主从版、CKV主从版和Redis2.8单机版不需要填写。 # @type RedisReplicasNum: Integer attr_accessor :InstanceId, :MemSize, :RedisShardNum, :RedisReplicasNum def initialize(instanceid=nil, memsize=nil, redisshardnum=nil, redisreplicasnum=nil) @@ -5874,11 +5895,11 @@ # @param Password: 该参数用于配置指定实例的访问密码。若为免密认证，该参数则无需配置。密码复杂度要求如下所示。 # - 长度8-30位,推荐使用12位以上的密码 # - 不能以"/"开头 # - 至少包含小写字母a-z、大写字母A-Z、数字0-9及其 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/中的两项。 # @type Password: String - # @param ShardIds: 分片集群的分片 ID。 + # @param ShardIds: 分片集群的分片 ID。请通过接口[DescribeInstanceNodeInfo](https://cloud.tencent.com/document/product/239/48603) 的返回参数 **Redis** 中的 **ClusterId** 获取。 # @type ShardIds: Array attr_accessor :InstanceId, :Password, :ShardIds def initialize(instanceid=nil, password=nil, shardids=nil) @@ -6162,17 +6183,17 @@ end end # ModifyConnectionConfig请求参数结构体 class ModifyConnectionConfigRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例的ID，长度在12-36之间。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String # @param Bandwidth: 附加带宽，大于0，单位MB。 # @type Bandwidth: Integer # @param ClientLimit: 单分片的总连接数。 - # 未开启副本只读时，下限为10000，上限为40000； - # 开启副本只读时，下限为10000，上限为10000×(只读副本数+3)。 + # - 未开启副本只读时，下限为10000，上限为40000。 + # - 开启副本只读时，下限为10000，上限为10000×(只读副本数+3)。 # @type ClientLimit: Integer attr_accessor :InstanceId, :Bandwidth, :ClientLimit def initialize(instanceid=nil, bandwidth=nil, clientlimit=nil) @@ -6210,13 +6231,15 @@ # ModifyDBInstanceSecurityGroups请求参数结构体 class ModifyDBInstanceSecurityGroupsRequest < TencentCloud::Common::AbstractModel # @param Product: 数据库引擎名称，本接口取值：redis。 # @type Product: String - # @param SecurityGroupIds: 更换为新的安全组 ID 列表，即一个或者多个安全组 ID 组成的数组。若实例第一次配置安全组，请使用接口[AssociateSecurityGroups](https://cloud.tencent.com/document/product/239/41260)先绑定安全组。 + # @param SecurityGroupIds: 更换为新的安全组 ID 列表，即一个或者多个安全组 ID 组成的数组。 + # - 若实例第一次配置安全组，请使用接口[AssociateSecurityGroups](https://cloud.tencent.com/document/product/239/41260)先绑定安全组。 + # - 更换安全组，请在[控制台安全组](https://console.cloud.tencent.com/vpc/security-group)页面获取安全组 ID。 # @type SecurityGroupIds: Array - # @param InstanceId: 实例 ID，格式如：cdb-c1nl9rpv或者cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :Product, :SecurityGroupIds, :InstanceId def initialize(product=nil, securitygroupids=nil, instanceid=nil) @@ -6248,23 +6271,30 @@ end end # ModifyInstanceAccount请求参数结构体 class ModifyInstanceAccountRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param AccountName: 子账号名称，如果要修改主账号，填root + # @param AccountName: 子账号名称，如果要修改主账号，填 root。 # @type AccountName: String - # @param AccountPassword: 子账号密码 + # @param AccountPassword: 子账号密码。 # @type AccountPassword: String # @param Remark: 子账号描述信息 # @type Remark: String - # @param ReadonlyPolicy: 路由策略：填写master或者replication，表示主节点或者从节点 + # @param ReadonlyPolicy: 账号读写路由策略。 + # - master：表示主节点。 + # - replication：表示从节点。 # @type ReadonlyPolicy: Array - # @param Privilege: 子账号读写策略：填写r、w、rw，表示只读，只写，读写策略 + # @param Privilege: 子账号读写策略。 + # - r：只读。 + # - w：只写。 + # - rw：读写。 # @type Privilege: String - # @param NoAuth: true表示将主账号切换为免密账号，这里只适用于主账号，子账号不可免密。 + # @param NoAuth: 指定是否将主账号切换为免密账号。这里只适用于主账号，子账号不可免密。 + # - true：将主账号切换为免密账号。 + # - false：不切换。 # @type NoAuth: Boolean attr_accessor :InstanceId, :AccountName, :AccountPassword, :Remark, :ReadonlyPolicy, :Privilege, :NoAuth def initialize(instanceid=nil, accountname=nil, accountpassword=nil, remark=nil, readonlypolicy=nil, privilege=nil, noauth=nil) @@ -6420,21 +6450,21 @@ end end # ModifyInstanceLogDelivery请求参数结构体 class ModifyInstanceLogDeliveryRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String # @param LogType: 日志类型。当前仅支持设置为slowlog，指慢查询日志。 # @type LogType: String # @param Enabled: 日志投递开启状态。 # - true：开启。 # - false：关闭。 # @type Enabled: Boolean - # @param LogsetId: 投递的日志集ID。 + # @param LogsetId: 投递的日志集ID。通过接口[DescribeInstanceLogDelivery](https://cloud.tencent.com/document/product/239/110878)的返回参数 **SlowLog** 的子参数 **LogsetId** 获取。 # @type LogsetId: String - # @param TopicId: 投递的日志主题ID。 + # @param TopicId: 投递的日志主题ID。请通过接口[DescribeInstanceLogDelivery](https://cloud.tencent.com/document/product/239/110878)的返回参数 **SlowLog** 的子参数 **TopicId** 获取。 # @type TopicId: String # @param LogsetName: 日志集名称。若**LogsetId**未指定具体的日志集ID，请配置该参数，设置日志集名称，系统会以设置的日志集名称自动创建新的日志集。 # @type LogsetName: String # @param TopicName: 日志主题名称，TopicId为空时必传，会自动创建新的日志主题。 # @type TopicName: String @@ -6490,11 +6520,11 @@ end end # ModifyInstanceParams请求参数结构体 class ModifyInstanceParamsRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String # @param InstanceParams: 实例修改的参数列表。 # @type InstanceParams: Array attr_accessor :InstanceId, :InstanceParams @@ -6588,13 +6618,15 @@ end end # ModifyInstanceReadOnly请求参数结构体 class ModifyInstanceReadOnlyRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param InputMode: 实例输入模式，0：读写 1：只读 + # @param InputMode: 实例输入模式。 + # - 0：读写。 + # - 1：只读。 # @type InputMode: String attr_accessor :InstanceId, :InputMode def initialize(instanceid=nil, inputmode=nil) @@ -6628,25 +6660,31 @@ end end # ModifyInstance请求参数结构体 class ModifyInstanceRequest < TencentCloud::Common::AbstractModel - # @param Operation: 修改实例操作，如填写：rename-表示实例重命名；modifyProject-修改实例所属项目；modifyAutoRenew-修改实例续费标记 + # @param Operation: 修改实例操作。如填写： + # - rename：表示实例重命名。 + # - modifyProject：修改实例所属项目。 + # - modifyAutoRenew：修改实例续费标记。 # @type Operation: String - # @param InstanceIds: 实例Id，每次请求的实例的上限为10。 + # @param InstanceIds: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。每次请求的实例数量的上限为10。 # @type InstanceIds: Array - # @param InstanceNames: 实例的新名称 + # @param InstanceNames: 实例的新名称。 # @type InstanceNames: Array - # @param ProjectId: 项目Id + # @param ProjectId: 项目 ID，请登录[Redis控制台的项目管理](https://console.cloud.tencent.com/project)页面，在**项目名称**中复制项目 ID。 # @type ProjectId: Integer - # @param AutoRenews: 自动续费标识。0 - 默认状态（手动续费）；1 - 自动续费；2 - 明确不自动续费 + # @param AutoRenews: 自动续费标识。 + # - 0：默认状态，指手动续费。 + # - 1：自动续费。 + # - 2：明确不自动续费。 # @type AutoRenews: Array - # @param InstanceId: 已经废弃 + # @param InstanceId: 目前在废弃中，存量用户还可以使用，建议新用户使用 InstanceIds。 # @type InstanceId: String # @param InstanceName: 已经废弃 # @type InstanceName: String - # @param AutoRenew: 已经废弃 + # @param AutoRenew: 已经废弃。 # @type AutoRenew: Integer attr_accessor :Operation, :InstanceIds, :InstanceNames, :ProjectId, :AutoRenews, :InstanceId, :InstanceName, :AutoRenew def initialize(operation=nil, instanceids=nil, instancenames=nil, projectid=nil, autorenews=nil, instanceid=nil, instancename=nil, autorenew=nil) @@ -6688,15 +6726,15 @@ end end # ModifyMaintenanceWindow请求参数结构体 class ModifyMaintenanceWindowRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param StartTime: 维护时间窗起始时间，如：17:00 + # @param StartTime: 维护时间窗起始时间，如：17:00。 # @type StartTime: String - # @param EndTime: 维护时间窗结束时间，如：19:00 + # @param EndTime: 维护时间窗结束时间，如：19:00。 # @type EndTime: String attr_accessor :InstanceId, :StartTime, :EndTime def initialize(instanceid=nil, starttime=nil, endtime=nil) @@ -6819,11 +6857,11 @@ end end # ModifyParamTemplate请求参数结构体 class ModifyParamTemplateRequest < TencentCloud::Common::AbstractModel - # @param TemplateId: 源参数模板 ID。 + # @param TemplateId: 源参数模板 ID。 请通过接口[DescribeParamTemplateInfo](https://cloud.tencent.com/document/product/239/58748)的返回参数 **TemplateId** 获取参数模板 ID。 # @type TemplateId: String # @param Name: 参数模板修改后的新名称。 # @type Name: String # @param Description: 参数模板修改后的新描述。 # @type Description: String @@ -6910,11 +6948,11 @@ end end # OpenSSL请求参数结构体 class OpenSSLRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID。 + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -7563,11 +7601,11 @@ end end # ReleaseWanAddress请求参数结构体 class ReleaseWanAddressRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -7603,15 +7641,17 @@ end end # RemoveReplicationInstance请求参数结构体 class RemoveReplicationInstanceRequest < TencentCloud::Common::AbstractModel - # @param GroupId: 复制组ID + # @param GroupId: 复制组 ID。例如：crs-rpl-m3zt****。请登录[Redis 控制台](https://console.cloud.tencent.com/redis/replication)的全球复制组列表获取复制组 ID。 # @type GroupId: String - # @param InstanceId: 实例ID + # @param InstanceId: 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。 # @type InstanceId: String - # @param SyncType: 数据同步类型，true:需要数据强同步,false:不需要强同步，仅限删除主实例 + # @param SyncType: 数据同步类型。 + # - true：需数据强同步。 + # - false：无需强同步，仅限删除主实例。 # @type SyncType: Boolean attr_accessor :GroupId, :InstanceId, :SyncType def initialize(groupid=nil, instanceid=nil, synctype=nil) @@ -7627,11 +7667,11 @@ end end # RemoveReplicationInstance返回参数结构体 class RemoveReplicationInstanceResponse < TencentCloud::Common::AbstractModel - # @param TaskId: 异步任务ID + # @param TaskId: 异步任务ID。 # @type TaskId: Integer # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 # @type RequestId: String attr_accessor :TaskId, :RequestId @@ -7730,15 +7770,17 @@ end end # ResetPassword请求参数结构体 class ResetPasswordRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: Redis实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param Password: 重置的密码（切换为免密实例时，可不传；其他情况必传） + # @param Password: 重置的密码。若切换为免密实例时，可不配置该参数。其他情况必须配置。 # @type Password: String - # @param NoAuth: 是否切换免密实例，false-切换为非免密码实例，true-切换为免密码实例；默认false + # @param NoAuth: 是否切换免密实例。 + # - false：切换为非免密码实例。 + # - true：切换为免密码实例。默认 false。 # @type NoAuth: Boolean attr_accessor :InstanceId, :Password, :NoAuth def initialize(instanceid=nil, password=nil, noauth=nil) @@ -8044,11 +8086,11 @@ end end # StartupInstance请求参数结构体 class StartupInstanceRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例id + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String attr_accessor :InstanceId def initialize(instanceid=nil) @@ -8113,17 +8155,19 @@ end end # SwitchInstanceVip请求参数结构体 class SwitchInstanceVipRequest < TencentCloud::Common::AbstractModel - # @param SrcInstanceId: 源实例ID + # @param SrcInstanceId: 源实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type SrcInstanceId: String - # @param DstInstanceId: 目标实例ID + # @param DstInstanceId: 目标实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type DstInstanceId: String - # @param TimeDelay: 单位为秒。源实例与目标实例间DTS已断开时间，如果DTS断开时间大于TimeDelay，则不切换VIP，建议尽量根据业务设置一个可接受的值。 + # @param TimeDelay: 单位为秒。源实例与目标实例间DTS已断开时间。如果 DTS 断开时间大于TimeDelay，则不切换VIP，建议尽量根据业务设置一个可接受的值。 # @type TimeDelay: Integer - # @param ForceSwitch: 在DTS断开的情况下是否强制切换。1：强制切换，0：不强制切换 + # @param ForceSwitch: 在 DTS 断开的情况下是否强制切换。 + # - 1：强制切换。 + # - 0：不强制切换。 # @type ForceSwitch: Integer # @param SwitchTime: now: 立即切换，syncComplete：等待同步完成后切换 # @type SwitchTime: String attr_accessor :SrcInstanceId, :DstInstanceId, :TimeDelay, :ForceSwitch, :SwitchTime @@ -8165,13 +8209,13 @@ end end # SwitchProxy请求参数结构体 class SwitchProxyRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param ProxyID: 实例ProxyID + # @param ProxyID: 实例 ProxyID，请通过接口[DescribeInstanceNodeInfo](https://cloud.tencent.com/document/product/239/48603)的返回参数**Proxy**中的**NodeId**获取。 # @type ProxyID: String attr_accessor :InstanceId, :ProxyID def initialize(instanceid=nil, proxyid=nil) @@ -8543,17 +8587,19 @@ end end # UpgradeProxyVersion请求参数结构体 class UpgradeProxyVersionRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param CurrentProxyVersion: 当前proxy版本 + # @param CurrentProxyVersion: 当前 Proxy 版本。 # @type CurrentProxyVersion: String - # @param UpgradeProxyVersion: 可升级的redis版本 + # @param UpgradeProxyVersion: 可升级的 Redis 版本。 # @type UpgradeProxyVersion: String - # @param InstanceTypeUpgradeNow: 1-立即升级 0-维护时间窗口升级 + # @param InstanceTypeUpgradeNow: 指定是否立即升级。 + # - 1：立即升级。 + # - 0：维护时间窗口升级。 # @type InstanceTypeUpgradeNow: Integer attr_accessor :InstanceId, :CurrentProxyVersion, :UpgradeProxyVersion, :InstanceTypeUpgradeNow def initialize(instanceid=nil, currentproxyversion=nil, upgradeproxyversion=nil, instancetypeupgradenow=nil) @@ -8591,17 +8637,19 @@ end end # UpgradeSmallVersion请求参数结构体 class UpgradeSmallVersionRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID + # @param InstanceId: 实例 ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String - # @param CurrentRedisVersion: 当前redis版本 + # @param CurrentRedisVersion: 当前 Redis 小版本。小版本信息，请参见[升级实例版本](https://cloud.tencent.com/document/product/239/46457)。 # @type CurrentRedisVersion: String - # @param UpgradeRedisVersion: 可升级的redis版本 + # @param UpgradeRedisVersion: 升级后的 Redis 小版本。小版本信息，请参见[升级实例版本](https://cloud.tencent.com/document/product/239/46457)。 # @type UpgradeRedisVersion: String - # @param InstanceTypeUpgradeNow: 1-立即升级 0-维护时间窗口升级 + # @param InstanceTypeUpgradeNow: 指定是否立即升级。 + # - 1：立即升级。 + # - 0：维护时间窗口升级。 # @type InstanceTypeUpgradeNow: Integer attr_accessor :InstanceId, :CurrentRedisVersion, :UpgradeRedisVersion, :InstanceTypeUpgradeNow def initialize(instanceid=nil, currentredisversion=nil, upgraderedisversion=nil, instancetypeupgradenow=nil) @@ -8639,10 +8687,10 @@ end end # UpgradeVersionToMultiAvailabilityZones请求参数结构体 class UpgradeVersionToMultiAvailabilityZonesRequest < TencentCloud::Common::AbstractModel - # @param InstanceId: 实例ID。 + # @param InstanceId: 实例ID，请登录[Redis控制台](https://console.cloud.tencent.com/redis/instance/list)在实例列表复制实例 ID。 # @type InstanceId: String # @param UpgradeProxyAndRedisServer: 升级多可用区之后是否支持就近访问功能。 # <ul><li>true：支持就近访问功能。升级过程，需同时升级 Proxy 版本和 Redis 内核小版本，涉及数据搬迁，可能会长达数小时。</li><li>false：无需支持就近访问功能。升级多可用区仅涉及管理元数据迁移，对服务没有影响，升级过程通常在3分钟内完成。</li></ul> # @type UpgradeProxyAndRedisServer: Boolean