tencentcloud-sdk-redis 3.0.553 → 3.0.554

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 027a9d31ca0669e78a0ac24c2da8d961a0154cb5
-  data.tar.gz: 35bc23c20c0c8af2cbabe68c386a8d1697c82373
+  metadata.gz: 2db6eb962a0599f572776d2460c8f2e2b095c443
+  data.tar.gz: 65987c42ced7f6b2851c4f054d6e29ad2b3020d2
 SHA512:
-  metadata.gz: 282af89a8b14bb5492888cbd44c1affda27c99744f8324c76738e7424dd97b626a88cfbea57d30d53ad10a5737229e8ac67f0f1a96e441c0cfb9606d3cd5239c
-  data.tar.gz: a12b433077f1fca060509dc8aee3a6443722fa57afd26faebd54d81dbdde3f531a67cdf1951d6054b6fe61c7e2da3c4e6dfa1283f6c1f3b1de049e2bb050e6de
+  metadata.gz: 904dd179f65c36c2c639e087d8c86514a703880bb311576bca00547ebeab41dd489a4e3e3c4c33018d9b7c208eabcfc3233dae1af3d549fad5d518bdc47696c7
+  data.tar.gz: 5cc122af2d24b6c437dc12fd404680521f221cac31325993282885e9050434a58d9f5054c7e6abaec567ac6da78890b5ebd56e8694ce23a1b4994c6852699575

data/lib/VERSION

@@ -1 +1 @@
-3.0.553
+3.0.554

data/lib/v20180412/client.rb

@@ -317,7 +317,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 本接口(CreateInstances)用于创建redis实例。
+        # 本接口（CreateInstances）用于创建 Redis 实例。
 
         # @param request: Request instance for CreateInstances.
         # @type request: :class:`Tencentcloud::redis::V20180412::CreateInstancesRequest`

data/lib/v20180412/models.rb

@@ -781,58 +781,85 @@ module TencentCloud
 
       # CreateInstances请求参数结构体
       class CreateInstancesRequest < TencentCloud::Common::AbstractModel
-        # @param TypeId: 实例类型：2 – Redis2.8内存版(标准架构)，3 – CKV 3.2内存版(标准架构)，4 – CKV 3.2内存版(集群架构)，6 – Redis4.0内存版(标准架构)，7 – Redis4.0内存版(集群架构)，8 – Redis5.0内存版(标准架构)，9 – Redis5.0内存版(集群架构)，15 – Redis6.0内存版(标准架构)，16 – Redis6.0内存版(集群架构)。
+        # @param TypeId: 实例类型。
+        # <ul><li>2：Redis 2.8 内存版（标准架构）。</li><li>3：CKV 3.2 内存版（标准架构）。</li><li>4：CKV 3.2 内存版（集群架构）。</li><li>6：Redis 4.0 内存版（标准架构）。</li><li>7：Redis 4.0 内存版（集群架构）。</li><li>8：Redis 5.0 内存版（标准架构）。</li><li>9：Redis 5.0 内存版（集群架构）。</li><li>15：Redis 6.2 内存版（标准架构）。</li><li>16：Redis 6.2 内存版（集群架构）。</li></ul>
         # @type TypeId: Integer
-        # @param MemSize: 内存容量，单位为MB， 数值需为1024的整数倍，具体规格以 [查询产品售卖规格](https://cloud.tencent.com/document/api/239/30600) 返回的规格为准。
-        # TypeId为标准架构时，MemSize是实例总内存容量；TypeId为集群架构时，MemSize是单分片内存容量。
+        # @param MemSize: 内存容量，单位为MB， 数值需为1024的整数倍。具体规格，请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。
+        # - **TypeId**为标准架构时，**MemSize**是实例总内存容量；
+        # - **TypeId**为集群架构时，**MemSize**是单分片内存容量。
         # @type MemSize: Integer
-        # @param GoodsNum: 实例数量，单次购买实例数量以 [查询产品售卖规格](https://cloud.tencent.com/document/api/239/30600) 返回的规格为准。
+        # @param GoodsNum: 实例数量，单次购买实例数量。具体信息，请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。
         # @type GoodsNum: Integer
-        # @param Period: 购买时长，在创建包年包月实例的时候需要填写，按量计费实例填1即可，单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
+        # @param Period: 购买实例的时长。
+        # - 若 **BillingMode**为**1**，即计费方式为包年包月时，需设置该参数，指定所购买实例的时长。单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
+        # - 若 **BillingMode**为**0**，即计费方式为按量计费时，该参数配置为1。
         # @type Period: Integer
-        # @param BillingMode: 付费方式:0-按量计费，1-包年包月。
+        # @param BillingMode: 计费方式。
+        # - 0：按量计费。
+        # - 1：包年包月。
         # @type BillingMode: Integer
         # @param ZoneId: 实例所属的可用区ID，可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106)  。
         # @type ZoneId: Integer
-        # @param Password: 实例密码，当输入参数NoAuth为true且使用私有网络VPC时，Password为非必填，否则Password为必填参数。
-        # 当实例类型TypeId为Redis2.8、4.0和5.0时，其密码格式为：8-30个字符，至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种，不能以"/"开头；
-        # 当实例类型TypeId为CKV 3.2时，其密码格式为：8-30个字符，必须包含字母和数字 且 不包含其他字符。
+        # @param Password: 访问实例的密码。
+        # - 当输入参数**NoAuth**为**true**时，指设置实例为免密码访问，Password可不用配置，否则Password为必填参数。
+        # - 当实例类型**TypeId**为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.0内存版标准架构或集群架构时，其密码复杂度要求为：8-30个字符，至少包含小写字母、大写字母、数字和字符()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种，不能以"/"开头。
+        # - 当实例类型**TypeId**为CKV 3.2 内存版标准架构或集群架构时，其密码复杂度为：8-30个字符，必须包含字母和数字，且 不包含其他字符。
         # @type Password: String
-        # @param VpcId: 私有网络ID，如果不传则默认选择基础网络，请使用私有网络列表查询，如：vpc-sad23jfdfk。
+        # @param VpcId: 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。
         # @type VpcId: String
-        # @param SubnetId: 基础网络下， subnetId无效； vpc子网下，取值以查询子网列表，如：subnet-fdj24n34j2。
+        # @param SubnetId: 私有网络VPC的子网。基础网络下， 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。
         # @type SubnetId: String
-        # @param ProjectId: 项目id，取值以用户账户>用户账户相关接口查询>项目列表返回的projectId为准。
+        # @param ProjectId: 项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/)，在右上角的账户信息菜单中，选择**项目管理**查询项目 ID。
         # @type ProjectId: Integer
-        # @param AutoRenew: 自动续费标识。0 - 默认状态（手动续费）；1 - 自动续费；2 - 明确不自动续费。
+        # @param AutoRenew: 自动续费标识。
+        # - 0：默认状态（手动续费）。
+        # - 1：自动续费。
+        # - 2：到期不续费。
         # @type AutoRenew: Integer
-        # @param SecurityGroupIdList: 安全组id数组。
+        # @param SecurityGroupIdList: 安全组 ID 数组。请通过[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)接口获取实例的安全组 ID。
         # @type SecurityGroupIdList: Array
-        # @param VPort: 用户自定义的端口 不填则默认为6379，范围[1024,65535]。
+        # @param VPort: 用户自定义的网络端口。默认为6379，范围为 [1024,65535]。
         # @type VPort: Integer
-        # @param RedisShardNum: 实例分片数量，购买标准版实例不需要填写，集群版分片数量范围[3,5,8,12,16,24,32,64,96,128]。
+        # @param RedisShardNum: 实例分片数量。
+        # - 标准版实例无需配置该参数。
+        # - 集群版实例，分片数量范围为：[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。
         # @type RedisShardNum: Integer
-        # @param RedisReplicasNum: 实例副本数量，Redis 2.8标准版、CKV标准版只支持1副本，4.0、5.0标准版和集群版支持1-5个副本。
+        # @param RedisReplicasNum: 实例副本数量。
+        # - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。
+        # - Redis 2.8标准版、CKV标准版只支持1副本。
         # @type RedisReplicasNum: Integer
-        # @param ReplicasReadonly: 是否支持副本只读，Redis 2.8标准版、CKV标准版不支持副本只读，开启副本只读，实例将自动读写分离，写请求路由到主节点，读请求路由到副本节点，如需开启副本只读建议副本数>=2。
+        # @param ReplicasReadonly: 标识实例是否需支持副本只读。
+        # - Redis 2.8 标准版、CKV标准版不支持副本只读。
+        # - 开启副本只读，实例将自动读写分离，写请求路由到主节点，读请求路由到副本节点。
+        # - 如需开启副本只读，建议副本数量大于等于2。
         # @type ReplicasReadonly: Boolean
-        # @param InstanceName: 实例名称，长度小于60的中文/英文/数字/"-"/"_"。
+        # @param InstanceName: 实例名称。命名要求：仅支持长度小于60的中文、英文或者数字，短划线"-"、下划线"_"。
         # @type InstanceName: String
-        # @param NoAuth: 是否支持免密，true-免密实例，false-非免密实例，默认为非免密实例，仅VPC网络的实例支持免密码访问。
+        # @param NoAuth: 配置实例是否支持免密码访问。
+        # - true：免密访问实例。
+        # - false：非免密访问实例。默认为非免密方式，仅VPC网络的实例支持免密码访问。
         # @type NoAuth: Boolean
-        # @param NodeSet: 实例的节点信息，目前支持传入节点的类型（主节点或者副本节点），节点的可用区。单可用区部署不需要传递此参数。
+        # @param NodeSet: 实例的节点信息，包含节点 ID、节点类型、节点可用区 ID等。具体信息，请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。
+        # 目前支持传入节点的类型（主节点或者副本节点），节点的可用区。单可用区部署不需要传递此参数。
         # @type NodeSet: Array
-        # @param ResourceTags: 购买实例绑定标签
+        # @param ResourceTags: 给实例设定标签。
         # @type ResourceTags: Array
-        # @param ZoneName: 实例所属的可用区名称，可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106)  。
+        # @param ZoneName: 指定实例所属的可用区名称。具体信息，请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106)  。
         # @type ZoneName: String
-        # @param TemplateId: 创建实例需要应用的参数模板ID，不传则应用默认的参数模板
+        # @param TemplateId: 指定实例相关的参数模板 ID。
+        # - 若不配置该参数，则系统会依据所选择的兼容版本及架构，自动适配对应的默认模板。
+        # - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口，查询实例的参数模板列表，获取模板 ID 编号。
         # @type TemplateId: String
-        # @param DryRun: false ：默认值,发送正常请求，通过检查后直接创建实例 true：发送检查请求，不会创建实例。
+        # @param DryRun: 内部参数，标识创建实例是否需要检查。
+        # - false ：默认值。发送正常请求，通过检查后直接创建实例。
+        # - true：发送检查请求，不会创建实例。
         # @type DryRun: Boolean
-        # @param ProductVersion: "local"本地盘版，"cloud"云盘版，"cdc"独享集群版，如果不传默认发货为本地盘版本
+        # @param ProductVersion: 指定实例的产品版本。
+        # - local：本地盘版。
+        # - cloud：云盘版，
+        # - cdc：独享集群版。如果不传默认发货为本地盘版本。
         # @type ProductVersion: String
-        # @param RedisClusterId: 独享集群id，ProductVersion="cdc"时必传
+        # @param RedisClusterId: 独享集群 ID。当**ProductVersion**设置为**cdc**时，该参数必须设置。
         # @type RedisClusterId: String
 
         attr_accessor :TypeId, :MemSize, :GoodsNum, :Period, :BillingMode, :ZoneId, :Password, :VpcId, :SubnetId, :ProjectId, :AutoRenew, :SecurityGroupIdList, :VPort, :RedisShardNum, :RedisReplicasNum, :ReplicasReadonly, :InstanceName, :NoAuth, :NodeSet, :ResourceTags, :ZoneName, :TemplateId, :DryRun, :ProductVersion, :RedisClusterId
@@ -910,9 +937,9 @@ module TencentCloud
 
       # CreateInstances返回参数结构体
       class CreateInstancesResponse < TencentCloud::Common::AbstractModel
-        # @param DealId: 交易的ID
+        # @param DealId: 交易的ID。
         # @type DealId: String
-        # @param InstanceIds: 实例ID
+        # @param InstanceIds: 实例ID。
         # @type InstanceIds: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -4151,23 +4178,27 @@ module TencentCloud
 
       # 实例分片列表信息
       class InstanceClusterShard < TencentCloud::Common::AbstractModel
-        # @param ShardName: 分片节点名称
+        # @param ShardName: 分片节点名称。
         # @type ShardName: String
-        # @param ShardId: 分片节点Id
+        # @param ShardId: 分片节点序号。
         # @type ShardId: String
-        # @param Role: 角色
+        # @param Role: 分片节点的角色。
+        # - 0：主节点。
+        # - 1：副本节点。
         # @type Role: Integer
-        # @param Keys: Key数量
+        # @param Keys: Key数量。
         # @type Keys: Integer
-        # @param Slots: slot信息
+        # @param Slots: Slot信息。
         # @type Slots: String
-        # @param Storage: 使用容量
+        # @param Storage: 已使用容量。
         # @type Storage: Integer
-        # @param StorageSlope: 容量倾斜率
+        # @param StorageSlope: 容量倾斜率。
         # @type StorageSlope: Float
-        # @param Runid: 实例运行时节点Id
+        # @param Runid: 实例运行时节点 ID。
         # @type Runid: String
-        # @param Connected: 服务状态：0-down；1-on
+        # @param Connected: 服务状态。
+        # - 0：down。
+        # - 1：on。
         # @type Connected: Integer
 
         attr_accessor :ShardName, :ShardId, :Role, :Keys, :Slots, :Storage, :StorageSlope, :Runid, :Connected
@@ -4485,7 +4516,7 @@ module TencentCloud
         # @type InstanceName: String
         # @param InstanceId: 实例 ID。
         # @type InstanceId: String
-        # @param Appid: 用户的 AppID。
+        # @param Appid: 用户APPID。APPID是与账号ID有唯一对应关系的应用 ID，部分腾讯云产品会使用此 APPID。
         # @type Appid: Integer
         # @param ProjectId: 项目 ID。
         # @type ProjectId: Integer
@@ -4503,9 +4534,9 @@ module TencentCloud
         # @type WanIp: String
         # @param Port: 实例端口号。
         # @type Port: Integer
-        # @param Createtime: 实例创建时间。
+        # @param Createtime: 实例创建时间。格式如：2020-01-15 10:20:00。
         # @type Createtime: String
-        # @param Size: 实例容量大小，单位：MB。
+        # @param Size: 实例内存容量大小。单位：MB，1MB=1024KB。
         # @type Size: Float
         # @param SizeUsed: 该字段已废弃。请使用腾讯云可观测平台API 接口 [GetMonitorData](https://cloud.tencent.com/document/product/248/31014) 获取实例已使用的内存容量。
         # @type SizeUsed: Float
@@ -4523,7 +4554,7 @@ module TencentCloud
         # @type Type: Integer
         # @param AutoRenewFlag: 实例是否设置自动续费标识。<ul><li>1：设置自动续费。</li><li>0：未设置自动续费。</li></ul>
         # @type AutoRenewFlag: Integer
-        # @param DeadlineTime: 实例到期时间。
+        # @param DeadlineTime: 包年包月计费实例到期的时间。
         # @type DeadlineTime: String
         # @param Engine: 引擎：社区版Redis、腾讯云CKV。
         # @type Engine: String
@@ -4537,7 +4568,7 @@ module TencentCloud
         # @type BillingMode: Integer
         # @param InstanceTitle: 实例运行状态描述：如”实例运行中“。
         # @type InstanceTitle: String
-        # @param OfflineTime: 计划下线时间。
+        # @param OfflineTime: 已隔离实例默认下线时间。按量计费实例隔离后默认两小时后下线，包年包月默认7天后下线。格式如：2020-02-15 10:20:00。
         # @type OfflineTime: String
         # @param SubStatus: 流程中的实例，返回子状态。
         # @type SubStatus: Integer
@@ -4553,7 +4584,7 @@ module TencentCloud
         # @type RedisReplicasNum: Integer
         # @param PriceId: 计费 ID。
         # @type PriceId: Integer
-        # @param CloseTime: 隔离时间。
+        # @param CloseTime: 实例隔离开始的时间。
         # @type CloseTime: String
         # @param SlaveReadWeight: 从节点读取权重。
         # @type SlaveReadWeight: Integer
@@ -4590,7 +4621,7 @@ module TencentCloud
         # @param DiskSize: Redis实例请忽略该参数。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type DiskSize: Integer
-        # @param MonitorVersion: 监控版本。<ul><li>1m：1分钟粒度监控。</li><li>5s：5秒粒度监控。</li></ul>
+        # @param MonitorVersion: 监控版本。<ul><li>1m：1分钟粒度监控。目前该监控粒度已下线，具体信息，请参见[云数据库 Redis 1分钟粒度下线公告](https://cloud.tencent.com/document/product/239/80653)。</li><li>5s：5秒粒度监控。</li></ul>
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type MonitorVersion: String
         # @param ClientLimitMin: 客户端最大连接数可设置的最小值。
@@ -4608,7 +4639,7 @@ module TencentCloud
         # @param WanAddress: 外网地址。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type WanAddress: String
-        # @param PolarisServer: 北极星服务地址。
+        # @param PolarisServer: 北极星服务地址，内部使用。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type PolarisServer: String
         # @param CurrentProxyVersion: 实例当前Proxy版本。

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-redis
 version: !ruby/object:Gem::Version
-  version: 3.0.553
+  version: 3.0.554
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common