lib/v20180412/models.rb in tencentcloud-sdk-redis-3.0.567 vs lib/v20180412/models.rb in tencentcloud-sdk-redis-3.0.568

@@ -17,26 +17,34 @@
 module TencentCloud
   module Redis
     module V20180412
       # 子账号信息
       class Account < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID
+        # @param InstanceId: 实例 ID。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type InstanceId: String
-        # @param AccountName: 账号名称（如果是主账号，名称为root）
+        # @param AccountName: 账号名称。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type AccountName: String
-        # @param Remark: 账号描述信息
+        # @param Remark: 账号描述信息。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Remark: String
-        # @param Privilege: 读写策略：r-只读，w-只写，rw-读写
+        # @param Privilege: 读写权限策略。
+        # - r：只读。
+        # - w：只写。
+        # - rw：读写。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Privilege: String
-        # @param ReadonlyPolicy: 路由策略：master-主节点，replication-从节点
+        # @param ReadonlyPolicy: 只读路由策略。
+        # - master：主节点。
+        # - replication：从节点。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type ReadonlyPolicy: Array
-        # @param Status: 子账号状态：1-账号变更中，2-账号有效，-4-账号已删除
+        # @param Status: 子账号状态.
+        # - 1：账号变更中。
+        # - 2：账号有效。
+        # - 4：账号已删除。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Status: Integer
 
         attr_accessor :InstanceId, :AccountName, :Remark, :Privilege, :ReadonlyPolicy, :Status
         
@@ -1561,11 +1569,11 @@
 
       # DescribeDBSecurityGroups请求参数结构体
       class DescribeDBSecurityGroupsRequest < TencentCloud::Common::AbstractModel
         # @param Product: 数据库引擎名称，本接口取值：redis。
         # @type Product: String
-        # @param InstanceId: 实例ID，格式如：cdb-c1nl9rpv或者cdbro-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同。
+        # @param InstanceId: 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
         # @type InstanceId: String
 
         attr_accessor :Product, :InstanceId
         
         def initialize(product=nil, instanceid=nil)
@@ -1581,13 +1589,13 @@
 
       # DescribeDBSecurityGroups返回参数结构体
       class DescribeDBSecurityGroupsResponse < TencentCloud::Common::AbstractModel
         # @param Groups: 安全组规则。
         # @type Groups: Array
-        # @param VIP: 安全组生效内网地址。
+        # @param VIP: 实例内网IPv4地址。
         # @type VIP: String
-        # @param VPort: 安全组生效内网端口。
+        # @param VPort: 内网端口。
         # @type VPort: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
         attr_accessor :Groups, :VIP, :VPort, :RequestId
@@ -1614,15 +1622,15 @@
         end
       end
 
       # DescribeInstanceAccount请求参数结构体
       class DescribeInstanceAccountRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例ID
+        # @param InstanceId: 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
         # @type InstanceId: String
-        # @param Limit: 分页大小
+        # @param Limit: 分页大小。
         # @type Limit: Integer
-        # @param Offset: 分页偏移量
+        # @param Offset: 分页偏移量。取Limit整数倍。计算公式：offset=limit*(页码-1)。
         # @type Offset: Integer
 
         attr_accessor :InstanceId, :Limit, :Offset
         
         def initialize(instanceid=nil, limit=nil, offset=nil)
@@ -1638,14 +1646,14 @@
         end
       end
 
       # DescribeInstanceAccount返回参数结构体
       class DescribeInstanceAccountResponse < TencentCloud::Common::AbstractModel
-        # @param Accounts: 账号详细信息
+        # @param Accounts: 账号详细信息。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Accounts: Array
-        # @param TotalCount: 账号个数
+        # @param TotalCount: 账号个数。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type TotalCount: Integer
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
@@ -2444,11 +2452,11 @@
         end
       end
 
       # DescribeInstanceParams请求参数结构体
       class DescribeInstanceParamsRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例Id
+        # @param InstanceId: 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
         # @type InstanceId: String
 
         attr_accessor :InstanceId
         
         def initialize(instanceid=nil)
@@ -2460,19 +2468,19 @@
         end
       end
 
       # DescribeInstanceParams返回参数结构体
       class DescribeInstanceParamsResponse < TencentCloud::Common::AbstractModel
-        # @param TotalCount: 实例参数个数
+        # @param TotalCount: 参数列表总数量。
         # @type TotalCount: Integer
-        # @param InstanceEnumParam: 实例枚举类型参数
+        # @param InstanceEnumParam: 实例枚举类型参数。
         # @type InstanceEnumParam: Array
-        # @param InstanceIntegerParam: 实例整型参数
+        # @param InstanceIntegerParam: 实例整型参数。
         # @type InstanceIntegerParam: Array
-        # @param InstanceTextParam: 实例字符型参数
+        # @param InstanceTextParam: 实例字符型参数。
         # @type InstanceTextParam: Array
-        # @param InstanceMultiParam: 实例多选项型参数
+        # @param InstanceMultiParam: 实例多选项型参数。
         # @type InstanceMultiParam: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
         attr_accessor :TotalCount, :InstanceEnumParam, :InstanceIntegerParam, :InstanceTextParam, :InstanceMultiParam, :RequestId
@@ -2524,11 +2532,11 @@
         end
       end
 
       # DescribeInstanceSecurityGroup请求参数结构体
       class DescribeInstanceSecurityGroupRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceIds: 实例列表
+        # @param InstanceIds: 实例 ID 列表。例如;["crs-f2ho5rsz\n"]
         # @type InstanceIds: Array
 
         attr_accessor :InstanceIds
         
         def initialize(instanceids=nil)
@@ -2540,11 +2548,11 @@
         end
       end
 
       # DescribeInstanceSecurityGroup返回参数结构体
       class DescribeInstanceSecurityGroupResponse < TencentCloud::Common::AbstractModel
-        # @param InstanceSecurityGroupsDetail: 实例安全组信息
+        # @param InstanceSecurityGroupsDetail: 实例安全组信息。
         # @type InstanceSecurityGroupsDetail: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
         attr_accessor :InstanceSecurityGroupsDetail, :RequestId
@@ -2620,11 +2628,11 @@
         end
       end
 
       # DescribeInstanceZoneInfo请求参数结构体
       class DescribeInstanceZoneInfoRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例Id，如：crs-6ubhgouj
+        # @param InstanceId: 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
         # @type InstanceId: String
 
         attr_accessor :InstanceId
         
         def initialize(instanceid=nil)
@@ -2636,13 +2644,13 @@
         end
       end
 
       # DescribeInstanceZoneInfo返回参数结构体
       class DescribeInstanceZoneInfoResponse < TencentCloud::Common::AbstractModel
-        # @param TotalCount: 实例节点组的个数
+        # @param TotalCount: 实例节点组的个数。
         # @type TotalCount: Integer
-        # @param ReplicaGroups: 实例节点组列表
+        # @param ReplicaGroups: 实例节点组列表。
         # @type ReplicaGroups: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
         attr_accessor :TotalCount, :ReplicaGroups, :RequestId
@@ -3152,21 +3160,21 @@
         end
       end
 
       # DescribeProxySlowLog请求参数结构体
       class DescribeProxySlowLogRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例Id
+        # @param InstanceId: 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
         # @type InstanceId: String
-        # @param BeginTime: 开始时间
+        # @param BeginTime: 慢查询的开始时间。
         # @type BeginTime: String
-        # @param EndTime: 结束时间
+        # @param EndTime: 慢查询的结束时间。
         # @type EndTime: String
-        # @param MinQueryTime: 慢查询阈值（单位：毫秒）
+        # @param MinQueryTime: 慢查询阈值，单位：毫秒。
         # @type MinQueryTime: Integer
-        # @param Limit: 页面大小
+        # @param Limit: 分页大小。默认为 20，取值范围[20,1000]。
         # @type Limit: Integer
-        # @param Offset: 偏移量，取Limit整数倍
+        # @param Offset: 偏移量，取Limit整数倍。
         # @type Offset: Integer
 
         attr_accessor :InstanceId, :BeginTime, :EndTime, :MinQueryTime, :Limit, :Offset
         
         def initialize(instanceid=nil, begintime=nil, endtime=nil, minquerytime=nil, limit=nil, offset=nil)
@@ -3188,13 +3196,13 @@
         end
       end
 
       # DescribeProxySlowLog返回参数结构体
       class DescribeProxySlowLogResponse < TencentCloud::Common::AbstractModel
-        # @param TotalCount: 慢查询总数
+        # @param TotalCount: 慢查询总数。
         # @type TotalCount: Integer
-        # @param InstanceProxySlowLogDetail: 慢查询详情
+        # @param InstanceProxySlowLogDetail: 慢查询详情。
         # @type InstanceProxySlowLogDetail: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
         attr_accessor :TotalCount, :InstanceProxySlowLogDetail, :RequestId
@@ -3344,11 +3352,11 @@
         # @type BeginTime: String
         # @param EndTime: 预查询慢日志的结束时间。
         # @type EndTime: String
         # @param MinQueryTime: 慢查询平均执行时间阈值，单位：毫秒。
         # @type MinQueryTime: Integer
-        # @param Limit: 每个页面展示的慢查询条数，默认值为20。
+        # @param Limit: 每个页面展示的慢查询条数，默认值为20。取值范围：[20,1000]。
         # @type Limit: Integer
         # @param Offset: 慢查询条数的偏移量，取Limit整数倍。计算公式：offset=limit*(页码-1)。
         # @type Offset: Integer
         # @param Role: 节点所属角色。<ul><li>master：主节点。</li><li>slave：从节点。</li></ul>
         # @type Role: String
@@ -4271,25 +4279,29 @@
         end
       end
 
       # 实例枚举类型参数描述
       class InstanceEnumParam < TencentCloud::Common::AbstractModel
-        # @param ParamName: 参数名
+        # @param ParamName: 参数名称。
         # @type ParamName: String
-        # @param ValueType: 参数类型：enum
+        # @param ValueType: 参数类型，例如：Enum。
         # @type ValueType: String
-        # @param NeedRestart: 修改后是否需要重启：true，false
+        # @param NeedRestart: 参数值修改后是否需要重启。
+        # - true：需要。
+        # - false：不需要。
         # @type NeedRestart: String
-        # @param DefaultValue: 参数默认值
+        # @param DefaultValue: 参数默认值。
         # @type DefaultValue: String
-        # @param CurrentValue: 当前运行参数值
+        # @param CurrentValue: 参数当前运行值。
         # @type CurrentValue: String
-        # @param Tips: 参数说明
+        # @param Tips: 参数说明。
         # @type Tips: String
-        # @param EnumValue: 参数可取值
+        # @param EnumValue: 参数可取的值。
         # @type EnumValue: Array
-        # @param Status: 参数状态, 1: 修改中， 2：修改完成
+        # @param Status: 参数修改状态。
+        # - 1: 修改中。
+        # - 2：修改完成。
         # @type Status: Integer
 
         attr_accessor :ParamName, :ValueType, :NeedRestart, :DefaultValue, :CurrentValue, :Tips, :EnumValue, :Status
         
         def initialize(paramname=nil, valuetype=nil, needrestart=nil, defaultvalue=nil, currentvalue=nil, tips=nil, enumvalue=nil, status=nil)
@@ -4368,25 +4380,29 @@
         end
       end
 
       # 实例多选项类型参数描述
       class InstanceMultiParam < TencentCloud::Common::AbstractModel
-        # @param ParamName: 参数名
+        # @param ParamName: 参数名称。
         # @type ParamName: String
-        # @param ValueType: 参数类型：multi
+        # @param ValueType: 参数类型。例如：multi。
         # @type ValueType: String
-        # @param NeedRestart: 修改后是否需要重启：true，false
+        # @param NeedRestart: 参数修改后是否需要重启。
+        # - true：需要。
+        # - false：不需要。
         # @type NeedRestart: String
-        # @param DefaultValue: 参数默认值
+        # @param DefaultValue: 参数默认值。
         # @type DefaultValue: String
-        # @param CurrentValue: 当前运行参数值
+        # @param CurrentValue: 当前运行参数值。
         # @type CurrentValue: String
-        # @param Tips: 参数说明
+        # @param Tips: 参数说明。
         # @type Tips: String
-        # @param EnumValue: 参数说明
+        # @param EnumValue: 参数说明。
         # @type EnumValue: Array
-        # @param Status: 参数状态, 1: 修改中， 2：修改完成
+        # @param Status: 参数修改的状态。
+        # - 1：修改中。
+        # - 2：修改完成。
         # @type Status: Integer
 
         attr_accessor :ParamName, :ValueType, :NeedRestart, :DefaultValue, :CurrentValue, :Tips, :EnumValue, :Status
         
         def initialize(paramname=nil, valuetype=nil, needrestart=nil, defaultvalue=nil, currentvalue=nil, tips=nil, enumvalue=nil, status=nil)
@@ -4526,13 +4542,13 @@
         end
       end
 
       # 实例安全组信息
       class InstanceSecurityGroupDetail < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 实例Id
+        # @param InstanceId: 实例 ID。
         # @type InstanceId: String
-        # @param SecurityGroupDetails: 安全组信息
+        # @param SecurityGroupDetails: 安全组信息，包括：安全组 ID、安全组名称、安全组出入站规则。
         # @type SecurityGroupDetails: Array
 
         attr_accessor :InstanceId, :SecurityGroupDetails
         
         def initialize(instanceid=nil, securitygroupdetails=nil)
@@ -4894,25 +4910,29 @@
         end
       end
 
       # 实例字符型参数描述
       class InstanceTextParam < TencentCloud::Common::AbstractModel
-        # @param ParamName: 参数名
+        # @param ParamName: 参数名称。
         # @type ParamName: String
-        # @param ValueType: 参数类型：text
+        # @param ValueType: 参数类型。例如：text。
         # @type ValueType: String
-        # @param NeedRestart: 修改后是否需要重启：true，false
+        # @param NeedRestart: 参数修改后是否需要重启。
+        # - true：需要。
+        # - false：不需要。
         # @type NeedRestart: String
-        # @param DefaultValue: 参数默认值
+        # @param DefaultValue: 参数默认值。
         # @type DefaultValue: String
-        # @param CurrentValue: 当前运行参数值
+        # @param CurrentValue: 参数当前运行值。
         # @type CurrentValue: String
-        # @param Tips: 参数说明
+        # @param Tips: 参数说明。
         # @type Tips: String
-        # @param TextValue: 参数可取值
+        # @param TextValue: 参数可取值。
         # @type TextValue: Array
-        # @param Status: 参数状态, 1: 修改中， 2：修改完成
+        # @param Status: 参数修改状态。
+        # - 1: 修改中。
+        # - 2：修改完成。
         # @type Status: Integer
 
         attr_accessor :ParamName, :ValueType, :NeedRestart, :DefaultValue, :CurrentValue, :Tips, :TextValue, :Status
         
         def initialize(paramname=nil, valuetype=nil, needrestart=nil, defaultvalue=nil, currentvalue=nil, tips=nil, textvalue=nil, status=nil)
@@ -5089,15 +5109,18 @@
         end
       end
 
       # ManualBackupInstance请求参数结构体
       class ManualBackupInstanceRequest < TencentCloud::Common::AbstractModel
-        # @param InstanceId: 待操作的实例ID，可通过 DescribeInstance接口返回值中的 InstanceId 获取。
+        # @param InstanceId: 指定实例 ID。例如：crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
         # @type InstanceId: String
-        # @param Remark: 备份的备注信息
+        # @param Remark: 手动备份任务的备注信息。
         # @type Remark: String
-        # @param StorageDays: 保存天数。0代表指定默认保留时间
+        # @param StorageDays: 备份数据的保存天数。
+        # - 单位：天；默认值为7天；取值范围：[0.1825]。如果超过 7天，请[提交工单](https://console.cloud.tencent.com/workorder/category)申请。
+        # - 如果不配置该参数，默认与自动备份的保留时间一致。
+        # - 如果未设置自动备份，默认为7天。
         # @type StorageDays: Integer
 
         attr_accessor :InstanceId, :Remark, :StorageDays
         
         def initialize(instanceid=nil, remark=nil, storagedays=nil)
@@ -6212,19 +6235,19 @@
         end
       end
 
       # Redis节点的运行信息
       class RedisNode < TencentCloud::Common::AbstractModel
-        # @param Keys: 节点key的个数
+        # @param Keys: Redis 节点上 Key 的个数。
         # @type Keys: Integer
-        # @param Slot: 节点slot分布
+        # @param Slot: Redis 节点 Slot 分布范围。例如：0-5460。
         # @type Slot: String
-        # @param NodeId: 节点的序列ID
+        # @param NodeId: 节点的序列 ID。
         # @type NodeId: String
-        # @param Status: 节点的状态
+        # @param Status: 节点的状态。
         # @type Status: String
-        # @param Role: 节点角色
+        # @param Role: 节点角色。
         # @type Role: String
 
         attr_accessor :Keys, :Slot, :NodeId, :Status, :Role
         
         def initialize(keys=nil, slot=nil, nodeid=nil, status=nil, role=nil)
@@ -6465,15 +6488,15 @@
           @DealId = params['DealId']
           @RequestId = params['RequestId']
         end
       end
 
-      # 实例节点信息
+      # 实例节点组信息
       class ReplicaGroup < TencentCloud::Common::AbstractModel
-        # @param GroupId: 节点组ID
+        # @param GroupId: 节点组 ID。
         # @type GroupId: Integer
-        # @param GroupName: 节点组的名称，主节点为空
+        # @param GroupName: 节点组的名称，主节点为空。
         # @type GroupName: String
         # @param ZoneId: 节点的可用区ID，比如ap-guangzhou-1
         # @type ZoneId: String
         # @param Role: 节点组类型，master为主节点，replica为副本节点
         # @type Role: String
@@ -6668,23 +6691,23 @@
         end
       end
 
       # 安全组详情
       class SecurityGroupDetail < TencentCloud::Common::AbstractModel
-        # @param ProjectId: 项目Id
+        # @param ProjectId: 项目ID。
         # @type ProjectId: Integer
-        # @param CreateTime: 创建时间
+        # @param CreateTime: 创建安全组的时间。
         # @type CreateTime: String
-        # @param SecurityGroupId: 安全组Id
+        # @param SecurityGroupId: 安全组 ID。
         # @type SecurityGroupId: String
-        # @param SecurityGroupName: 安全组名称
+        # @param SecurityGroupName: 安全组名称。
         # @type SecurityGroupName: String
-        # @param SecurityGroupRemark: 安全组标记
+        # @param SecurityGroupRemark: 安全组标记。
         # @type SecurityGroupRemark: String
-        # @param InboundRule: 安全组入站规则
+        # @param InboundRule: 安全组入站规则，即控制访问数据库的来源。
         # @type InboundRule: Array
-        # @param OutboundRule: 安全组出站规则
+        # @param OutboundRule: 安全组出站规则。
         # @type OutboundRule: Array
 
         attr_accessor :ProjectId, :CreateTime, :SecurityGroupId, :SecurityGroupName, :SecurityGroupRemark, :InboundRule, :OutboundRule
         
         def initialize(projectid=nil, createtime=nil, securitygroupid=nil, securitygroupname=nil, securitygroupremark=nil, inboundrule=nil, outboundrule=nil)
@@ -6722,16 +6745,16 @@
         end
       end
 
       # 安全组出入规则
       class SecurityGroupsInboundAndOutbound < TencentCloud::Common::AbstractModel
-        # @param Action: 执行动作
+        # @param Action: 标识出入数据库的IP与端口是否被允许。
         # @type Action: String
-        # @param Ip: IP地址
+        # @param Ip: 出入数据库的IP地址
         # @type Ip: String
-        # @param Port: 端口号
+        # @param Port: 端口号。
         # @type Port: String
-        # @param Proto: 协议类型
+        # @param Proto: 协议类型。
         # @type Proto: String
 
         attr_accessor :Action, :Ip, :Port, :Proto
         
         def initialize(action=nil, ip=nil, port=nil, proto=nil)