Class CreateInstancesRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Long getAutoRenew()
      Get 自动续费标识。 - 0:默认状态(手动续费)。 - 1:自动续费。 - 2:到期不续费。
      Long getBillingMode()
      Get 计费方式。 - 0:按量计费。 - 1:包年包月。
      Boolean getDryRun()
      Get 内部参数,标识创建实例是否需要检查。 - false :默认值。发送正常请求,通过检查后直接创建实例。 - true:发送检查请求,不会创建实例。
      Long getGoodsNum()
      Get 实例数量,单次购买实例数量。具体信息,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。
      String getInstanceName()
      Get 实例名称。命名要求:仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。
      Long getMemSize()
      Get 内存容量,单位为MB, 数值需为1024的整数倍。具体规格,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 - **TypeId**为标准架构时,**MemSize**是实例总内存容量; - **TypeId**为集群架构时,**MemSize**是单分片内存容量。
      Boolean getNoAuth()
      Get 配置实例是否支持免密码访问。 - true:免密访问实例。 - false:非免密访问实例。默认为非免密方式,仅VPC网络的实例支持免密码访问。
      RedisNodeInfo[] getNodeSet()
      Get 实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 目前支持传入节点的类型(主节点或者副本节点),节点的可用区。单可用区部署不需要传递此参数。
      String getPassword()
      Get 访问实例的密码。 - 当输入参数**NoAuth**为**true**时,指设置实例为免密码访问,Password可不用配置,否则Password为必填参数。 - 当实例类型**TypeId**为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.0内存版标准架构或集群架构时,其密码复杂度要求为:8-30个字符,至少包含小写字母、大写字母、数字和字符()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头。 - 当实例类型**TypeId**为CKV 3.2 内存版标准架构或集群架构时,其密码复杂度为:8-30个字符,必须包含字母和数字,且 不包含其他字符。
      Long getPeriod()
      Get 购买实例的时长。 - 若 **BillingMode**为**1**,即计费方式为包年包月时,需设置该参数,指定所购买实例的时长。单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 - 若 **BillingMode**为**0**,即计费方式为按量计费时,该参数配置为1。
      String getProductVersion()
      Get 指定实例的产品版本。 - local:本地盘版。 - cloud:云盘版, - cdc:独享集群版。如果不传默认发货为本地盘版本。
      Long getProjectId()
      Get 项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/),在右上角的账户信息菜单中,选择**项目管理**查询项目 ID。
      String getRedisClusterId()
      Get 独享集群 ID。当**ProductVersion**设置为**cdc**时,该参数必须设置。
      Long getRedisReplicasNum()
      Get 实例副本数量。 - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。 - Redis 2.8标准版、CKV标准版只支持1副本。
      Long getRedisShardNum()
      Get 实例分片数量。 - 标准版实例无需配置该参数。 - 集群版实例,分片数量范围为:[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。
      Boolean getReplicasReadonly()
      Get 标识实例是否需支持副本只读。 - Redis 2.8 标准版、CKV标准版不支持副本只读。 - 开启副本只读,实例将自动读写分离,写请求路由到主节点,读请求路由到副本节点。 - 如需开启副本只读,建议副本数量大于等于2。
      ResourceTag[] getResourceTags()
      Get 给实例设定标签。
      String[] getSecurityGroupIdList()
      Get 安全组 ID 数组。请通过[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)接口获取实例的安全组 ID。
      String getSubnetId()
      Get 私有网络VPC的子网。基础网络下, 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。
      String getTemplateId()
      Get 指定实例相关的参数模板 ID。 - 若不配置该参数,则系统会依据所选择的兼容版本及架构,自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口,查询实例的参数模板列表,获取模板 ID 编号。
      Long getTypeId()
      Get 实例类型。 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 内存版(集群架构)。
      String getVpcId()
      Get 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。
      Long getVPort()
      Get 用户自定义的网络端口。默认为6379,范围为 [1024,65535]。
      Long getZoneId()
      Get 实例所属的可用区ID,可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
      String getZoneName()
      Get 指定实例所属的可用区名称。具体信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
      void setAutoRenew​(Long AutoRenew)
      Set 自动续费标识。 - 0:默认状态(手动续费)。 - 1:自动续费。 - 2:到期不续费。
      void setBillingMode​(Long BillingMode)
      Set 计费方式。 - 0:按量计费。 - 1:包年包月。
      void setDryRun​(Boolean DryRun)
      Set 内部参数,标识创建实例是否需要检查。 - false :默认值。发送正常请求,通过检查后直接创建实例。 - true:发送检查请求,不会创建实例。
      void setGoodsNum​(Long GoodsNum)
      Set 实例数量,单次购买实例数量。具体信息,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。
      void setInstanceName​(String InstanceName)
      Set 实例名称。命名要求:仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。
      void setMemSize​(Long MemSize)
      Set 内存容量,单位为MB, 数值需为1024的整数倍。具体规格,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 - **TypeId**为标准架构时,**MemSize**是实例总内存容量; - **TypeId**为集群架构时,**MemSize**是单分片内存容量。
      void setNoAuth​(Boolean NoAuth)
      Set 配置实例是否支持免密码访问。 - true:免密访问实例。 - false:非免密访问实例。默认为非免密方式,仅VPC网络的实例支持免密码访问。
      void setNodeSet​(RedisNodeInfo[] NodeSet)
      Set 实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 目前支持传入节点的类型(主节点或者副本节点),节点的可用区。单可用区部署不需要传递此参数。
      void setPassword​(String Password)
      Set 访问实例的密码。 - 当输入参数**NoAuth**为**true**时,指设置实例为免密码访问,Password可不用配置,否则Password为必填参数。 - 当实例类型**TypeId**为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.0内存版标准架构或集群架构时,其密码复杂度要求为:8-30个字符,至少包含小写字母、大写字母、数字和字符()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头。 - 当实例类型**TypeId**为CKV 3.2 内存版标准架构或集群架构时,其密码复杂度为:8-30个字符,必须包含字母和数字,且 不包含其他字符。
      void setPeriod​(Long Period)
      Set 购买实例的时长。 - 若 **BillingMode**为**1**,即计费方式为包年包月时,需设置该参数,指定所购买实例的时长。单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 - 若 **BillingMode**为**0**,即计费方式为按量计费时,该参数配置为1。
      void setProductVersion​(String ProductVersion)
      Set 指定实例的产品版本。 - local:本地盘版。 - cloud:云盘版, - cdc:独享集群版。如果不传默认发货为本地盘版本。
      void setProjectId​(Long ProjectId)
      Set 项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/),在右上角的账户信息菜单中,选择**项目管理**查询项目 ID。
      void setRedisClusterId​(String RedisClusterId)
      Set 独享集群 ID。当**ProductVersion**设置为**cdc**时,该参数必须设置。
      void setRedisReplicasNum​(Long RedisReplicasNum)
      Set 实例副本数量。 - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。 - Redis 2.8标准版、CKV标准版只支持1副本。
      void setRedisShardNum​(Long RedisShardNum)
      Set 实例分片数量。 - 标准版实例无需配置该参数。 - 集群版实例,分片数量范围为:[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。
      void setReplicasReadonly​(Boolean ReplicasReadonly)
      Set 标识实例是否需支持副本只读。 - Redis 2.8 标准版、CKV标准版不支持副本只读。 - 开启副本只读,实例将自动读写分离,写请求路由到主节点,读请求路由到副本节点。 - 如需开启副本只读,建议副本数量大于等于2。
      void setResourceTags​(ResourceTag[] ResourceTags)
      Set 给实例设定标签。
      void setSecurityGroupIdList​(String[] SecurityGroupIdList)
      Set 安全组 ID 数组。请通过[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)接口获取实例的安全组 ID。
      void setSubnetId​(String SubnetId)
      Set 私有网络VPC的子网。基础网络下, 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。
      void setTemplateId​(String TemplateId)
      Set 指定实例相关的参数模板 ID。 - 若不配置该参数,则系统会依据所选择的兼容版本及架构,自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口,查询实例的参数模板列表,获取模板 ID 编号。
      void setTypeId​(Long TypeId)
      Set 实例类型。 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 内存版(集群架构)。
      void setVpcId​(String VpcId)
      Set 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。
      void setVPort​(Long VPort)
      Set 用户自定义的网络端口。默认为6379,范围为 [1024,65535]。
      void setZoneId​(Long ZoneId)
      Set 实例所属的可用区ID,可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
      void setZoneName​(String ZoneName)
      Set 指定实例所属的可用区名称。具体信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • CreateInstancesRequest

        public CreateInstancesRequest()
      • CreateInstancesRequest

        public CreateInstancesRequest​(CreateInstancesRequest source)
        NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
    • Method Detail

      • getTypeId

        public Long getTypeId()
        Get 实例类型。
        • 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 内存版(集群架构)。
        Returns:
        TypeId 实例类型。
        • 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 内存版(集群架构)。
      • setTypeId

        public void setTypeId​(Long TypeId)
        Set 实例类型。
        • 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 内存版(集群架构)。
        Parameters:
        TypeId - 实例类型。
        • 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 内存版(集群架构)。
      • getMemSize

        public Long getMemSize()
        Get 内存容量,单位为MB, 数值需为1024的整数倍。具体规格,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 - **TypeId**为标准架构时,**MemSize**是实例总内存容量; - **TypeId**为集群架构时,**MemSize**是单分片内存容量。
        Returns:
        MemSize 内存容量,单位为MB, 数值需为1024的整数倍。具体规格,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 - **TypeId**为标准架构时,**MemSize**是实例总内存容量; - **TypeId**为集群架构时,**MemSize**是单分片内存容量。
      • setMemSize

        public void setMemSize​(Long MemSize)
        Set 内存容量,单位为MB, 数值需为1024的整数倍。具体规格,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 - **TypeId**为标准架构时,**MemSize**是实例总内存容量; - **TypeId**为集群架构时,**MemSize**是单分片内存容量。
        Parameters:
        MemSize - 内存容量,单位为MB, 数值需为1024的整数倍。具体规格,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。 - **TypeId**为标准架构时,**MemSize**是实例总内存容量; - **TypeId**为集群架构时,**MemSize**是单分片内存容量。
      • getGoodsNum

        public Long getGoodsNum()
        Get 实例数量,单次购买实例数量。具体信息,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。
        Returns:
        GoodsNum 实例数量,单次购买实例数量。具体信息,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。
      • setGoodsNum

        public void setGoodsNum​(Long GoodsNum)
        Set 实例数量,单次购买实例数量。具体信息,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。
        Parameters:
        GoodsNum - 实例数量,单次购买实例数量。具体信息,请通过 [DescribeProductInfo](https://cloud.tencent.com/document/api/239/30600) 接口查询全地域的售卖规格。
      • getPeriod

        public Long getPeriod()
        Get 购买实例的时长。 - 若 **BillingMode**为**1**,即计费方式为包年包月时,需设置该参数,指定所购买实例的时长。单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 - 若 **BillingMode**为**0**,即计费方式为按量计费时,该参数配置为1。
        Returns:
        Period 购买实例的时长。 - 若 **BillingMode**为**1**,即计费方式为包年包月时,需设置该参数,指定所购买实例的时长。单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 - 若 **BillingMode**为**0**,即计费方式为按量计费时,该参数配置为1。
      • setPeriod

        public void setPeriod​(Long Period)
        Set 购买实例的时长。 - 若 **BillingMode**为**1**,即计费方式为包年包月时,需设置该参数,指定所购买实例的时长。单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 - 若 **BillingMode**为**0**,即计费方式为按量计费时,该参数配置为1。
        Parameters:
        Period - 购买实例的时长。 - 若 **BillingMode**为**1**,即计费方式为包年包月时,需设置该参数,指定所购买实例的时长。单位:月,取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。 - 若 **BillingMode**为**0**,即计费方式为按量计费时,该参数配置为1。
      • getBillingMode

        public Long getBillingMode()
        Get 计费方式。 - 0:按量计费。 - 1:包年包月。
        Returns:
        BillingMode 计费方式。 - 0:按量计费。 - 1:包年包月。
      • setBillingMode

        public void setBillingMode​(Long BillingMode)
        Set 计费方式。 - 0:按量计费。 - 1:包年包月。
        Parameters:
        BillingMode - 计费方式。 - 0:按量计费。 - 1:包年包月。
      • getZoneId

        public Long getZoneId()
        Get 实例所属的可用区ID,可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
        Returns:
        ZoneId 实例所属的可用区ID,可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
      • setZoneId

        public void setZoneId​(Long ZoneId)
        Set 实例所属的可用区ID,可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
        Parameters:
        ZoneId - 实例所属的可用区ID,可参考[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
      • getPassword

        public String getPassword()
        Get 访问实例的密码。 - 当输入参数**NoAuth**为**true**时,指设置实例为免密码访问,Password可不用配置,否则Password为必填参数。 - 当实例类型**TypeId**为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.0内存版标准架构或集群架构时,其密码复杂度要求为:8-30个字符,至少包含小写字母、大写字母、数字和字符()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头。 - 当实例类型**TypeId**为CKV 3.2 内存版标准架构或集群架构时,其密码复杂度为:8-30个字符,必须包含字母和数字,且 不包含其他字符。
        Returns:
        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个字符,必须包含字母和数字,且 不包含其他字符。
      • setPassword

        public void setPassword​(String Password)
        Set 访问实例的密码。 - 当输入参数**NoAuth**为**true**时,指设置实例为免密码访问,Password可不用配置,否则Password为必填参数。 - 当实例类型**TypeId**为Redis 2.8 内存版标准架构、Redis 4.0、5.0、6.0内存版标准架构或集群架构时,其密码复杂度要求为:8-30个字符,至少包含小写字母、大写字母、数字和字符()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种,不能以"/"开头。 - 当实例类型**TypeId**为CKV 3.2 内存版标准架构或集群架构时,其密码复杂度为:8-30个字符,必须包含字母和数字,且 不包含其他字符。
        Parameters:
        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个字符,必须包含字母和数字,且 不包含其他字符。
      • getVpcId

        public String getVpcId()
        Get 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。
        Returns:
        VpcId 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。
      • setVpcId

        public void setVpcId​(String VpcId)
        Set 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。
        Parameters:
        VpcId - 私有网络ID。如果不配置该参数则默认选择基础网络。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询具体的ID。
      • getSubnetId

        public String getSubnetId()
        Get 私有网络VPC的子网。基础网络下, 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。
        Returns:
        SubnetId 私有网络VPC的子网。基础网络下, 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。
      • setSubnetId

        public void setSubnetId​(String SubnetId)
        Set 私有网络VPC的子网。基础网络下, 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。
        Parameters:
        SubnetId - 私有网络VPC的子网。基础网络下, 该参数无需配置。请登录 [私有网络](https://console.cloud.tencent.com/vpc)控制台查询子网列表获取具体的 ID。
      • getProjectId

        public Long getProjectId()
        Get 项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/),在右上角的账户信息菜单中,选择**项目管理**查询项目 ID。
        Returns:
        ProjectId 项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/),在右上角的账户信息菜单中,选择**项目管理**查询项目 ID。
      • setProjectId

        public void setProjectId​(Long ProjectId)
        Set 项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/),在右上角的账户信息菜单中,选择**项目管理**查询项目 ID。
        Parameters:
        ProjectId - 项目 ID。请登录[Redis控制台](https://console.cloud.tencent.com/redis#/),在右上角的账户信息菜单中,选择**项目管理**查询项目 ID。
      • getAutoRenew

        public Long getAutoRenew()
        Get 自动续费标识。 - 0:默认状态(手动续费)。 - 1:自动续费。 - 2:到期不续费。
        Returns:
        AutoRenew 自动续费标识。 - 0:默认状态(手动续费)。 - 1:自动续费。 - 2:到期不续费。
      • setAutoRenew

        public void setAutoRenew​(Long AutoRenew)
        Set 自动续费标识。 - 0:默认状态(手动续费)。 - 1:自动续费。 - 2:到期不续费。
        Parameters:
        AutoRenew - 自动续费标识。 - 0:默认状态(手动续费)。 - 1:自动续费。 - 2:到期不续费。
      • getSecurityGroupIdList

        public String[] getSecurityGroupIdList()
        Get 安全组 ID 数组。请通过[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)接口获取实例的安全组 ID。
        Returns:
        SecurityGroupIdList 安全组 ID 数组。请通过[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)接口获取实例的安全组 ID。
      • setSecurityGroupIdList

        public void setSecurityGroupIdList​(String[] SecurityGroupIdList)
        Set 安全组 ID 数组。请通过[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)接口获取实例的安全组 ID。
        Parameters:
        SecurityGroupIdList - 安全组 ID 数组。请通过[DescribeInstanceSecurityGroup](https://cloud.tencent.com/document/product/239/34447)接口获取实例的安全组 ID。
      • getVPort

        public Long getVPort()
        Get 用户自定义的网络端口。默认为6379,范围为 [1024,65535]。
        Returns:
        VPort 用户自定义的网络端口。默认为6379,范围为 [1024,65535]。
      • setVPort

        public void setVPort​(Long VPort)
        Set 用户自定义的网络端口。默认为6379,范围为 [1024,65535]。
        Parameters:
        VPort - 用户自定义的网络端口。默认为6379,范围为 [1024,65535]。
      • getRedisShardNum

        public Long getRedisShardNum()
        Get 实例分片数量。 - 标准版实例无需配置该参数。 - 集群版实例,分片数量范围为:[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。
        Returns:
        RedisShardNum 实例分片数量。 - 标准版实例无需配置该参数。 - 集群版实例,分片数量范围为:[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。
      • setRedisShardNum

        public void setRedisShardNum​(Long RedisShardNum)
        Set 实例分片数量。 - 标准版实例无需配置该参数。 - 集群版实例,分片数量范围为:[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。
        Parameters:
        RedisShardNum - 实例分片数量。 - 标准版实例无需配置该参数。 - 集群版实例,分片数量范围为:[1、3、5、8、12、16、24、32、40、48、64、80、96、128]。
      • getRedisReplicasNum

        public Long getRedisReplicasNum()
        Get 实例副本数量。 - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。 - Redis 2.8标准版、CKV标准版只支持1副本。
        Returns:
        RedisReplicasNum 实例副本数量。 - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。 - Redis 2.8标准版、CKV标准版只支持1副本。
      • setRedisReplicasNum

        public void setRedisReplicasNum​(Long RedisReplicasNum)
        Set 实例副本数量。 - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。 - Redis 2.8标准版、CKV标准版只支持1副本。
        Parameters:
        RedisReplicasNum - 实例副本数量。 - Redis 内存版 4.0、5.0、6.2 标准架构和集群架构支持副本数量范围为[1,5]。 - Redis 2.8标准版、CKV标准版只支持1副本。
      • getReplicasReadonly

        public Boolean getReplicasReadonly()
        Get 标识实例是否需支持副本只读。 - Redis 2.8 标准版、CKV标准版不支持副本只读。 - 开启副本只读,实例将自动读写分离,写请求路由到主节点,读请求路由到副本节点。 - 如需开启副本只读,建议副本数量大于等于2。
        Returns:
        ReplicasReadonly 标识实例是否需支持副本只读。 - Redis 2.8 标准版、CKV标准版不支持副本只读。 - 开启副本只读,实例将自动读写分离,写请求路由到主节点,读请求路由到副本节点。 - 如需开启副本只读,建议副本数量大于等于2。
      • setReplicasReadonly

        public void setReplicasReadonly​(Boolean ReplicasReadonly)
        Set 标识实例是否需支持副本只读。 - Redis 2.8 标准版、CKV标准版不支持副本只读。 - 开启副本只读,实例将自动读写分离,写请求路由到主节点,读请求路由到副本节点。 - 如需开启副本只读,建议副本数量大于等于2。
        Parameters:
        ReplicasReadonly - 标识实例是否需支持副本只读。 - Redis 2.8 标准版、CKV标准版不支持副本只读。 - 开启副本只读,实例将自动读写分离,写请求路由到主节点,读请求路由到副本节点。 - 如需开启副本只读,建议副本数量大于等于2。
      • getInstanceName

        public String getInstanceName()
        Get 实例名称。命名要求:仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。
        Returns:
        InstanceName 实例名称。命名要求:仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。
      • setInstanceName

        public void setInstanceName​(String InstanceName)
        Set 实例名称。命名要求:仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。
        Parameters:
        InstanceName - 实例名称。命名要求:仅支持长度小于60的中文、英文或者数字,短划线"-"、下划线"_"。
      • getNoAuth

        public Boolean getNoAuth()
        Get 配置实例是否支持免密码访问。 - true:免密访问实例。 - false:非免密访问实例。默认为非免密方式,仅VPC网络的实例支持免密码访问。
        Returns:
        NoAuth 配置实例是否支持免密码访问。 - true:免密访问实例。 - false:非免密访问实例。默认为非免密方式,仅VPC网络的实例支持免密码访问。
      • setNoAuth

        public void setNoAuth​(Boolean NoAuth)
        Set 配置实例是否支持免密码访问。 - true:免密访问实例。 - false:非免密访问实例。默认为非免密方式,仅VPC网络的实例支持免密码访问。
        Parameters:
        NoAuth - 配置实例是否支持免密码访问。 - true:免密访问实例。 - false:非免密访问实例。默认为非免密方式,仅VPC网络的实例支持免密码访问。
      • getNodeSet

        public RedisNodeInfo[] getNodeSet()
        Get 实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 目前支持传入节点的类型(主节点或者副本节点),节点的可用区。单可用区部署不需要传递此参数。
        Returns:
        NodeSet 实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 目前支持传入节点的类型(主节点或者副本节点),节点的可用区。单可用区部署不需要传递此参数。
      • setNodeSet

        public void setNodeSet​(RedisNodeInfo[] NodeSet)
        Set 实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 目前支持传入节点的类型(主节点或者副本节点),节点的可用区。单可用区部署不需要传递此参数。
        Parameters:
        NodeSet - 实例的节点信息,包含节点 ID、节点类型、节点可用区 ID等。具体信息,请参见[RedisNodeInfo ](https://cloud.tencent.com/document/product/239/20022)。 目前支持传入节点的类型(主节点或者副本节点),节点的可用区。单可用区部署不需要传递此参数。
      • getResourceTags

        public ResourceTag[] getResourceTags()
        Get 给实例设定标签。
        Returns:
        ResourceTags 给实例设定标签。
      • setResourceTags

        public void setResourceTags​(ResourceTag[] ResourceTags)
        Set 给实例设定标签。
        Parameters:
        ResourceTags - 给实例设定标签。
      • getZoneName

        public String getZoneName()
        Get 指定实例所属的可用区名称。具体信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
        Returns:
        ZoneName 指定实例所属的可用区名称。具体信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
      • setZoneName

        public void setZoneName​(String ZoneName)
        Set 指定实例所属的可用区名称。具体信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
        Parameters:
        ZoneName - 指定实例所属的可用区名称。具体信息,请参见[地域和可用区](https://cloud.tencent.com/document/product/239/4106) 。
      • getTemplateId

        public String getTemplateId()
        Get 指定实例相关的参数模板 ID。 - 若不配置该参数,则系统会依据所选择的兼容版本及架构,自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口,查询实例的参数模板列表,获取模板 ID 编号。
        Returns:
        TemplateId 指定实例相关的参数模板 ID。 - 若不配置该参数,则系统会依据所选择的兼容版本及架构,自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口,查询实例的参数模板列表,获取模板 ID 编号。
      • setTemplateId

        public void setTemplateId​(String TemplateId)
        Set 指定实例相关的参数模板 ID。 - 若不配置该参数,则系统会依据所选择的兼容版本及架构,自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口,查询实例的参数模板列表,获取模板 ID 编号。
        Parameters:
        TemplateId - 指定实例相关的参数模板 ID。 - 若不配置该参数,则系统会依据所选择的兼容版本及架构,自动适配对应的默认模板。 - 请通过[DescribeParamTemplates](https://cloud.tencent.com/document/product/239/58750)接口,查询实例的参数模板列表,获取模板 ID 编号。
      • getDryRun

        public Boolean getDryRun()
        Get 内部参数,标识创建实例是否需要检查。 - false :默认值。发送正常请求,通过检查后直接创建实例。 - true:发送检查请求,不会创建实例。
        Returns:
        DryRun 内部参数,标识创建实例是否需要检查。 - false :默认值。发送正常请求,通过检查后直接创建实例。 - true:发送检查请求,不会创建实例。
      • setDryRun

        public void setDryRun​(Boolean DryRun)
        Set 内部参数,标识创建实例是否需要检查。 - false :默认值。发送正常请求,通过检查后直接创建实例。 - true:发送检查请求,不会创建实例。
        Parameters:
        DryRun - 内部参数,标识创建实例是否需要检查。 - false :默认值。发送正常请求,通过检查后直接创建实例。 - true:发送检查请求,不会创建实例。
      • getProductVersion

        public String getProductVersion()
        Get 指定实例的产品版本。 - local:本地盘版。 - cloud:云盘版, - cdc:独享集群版。如果不传默认发货为本地盘版本。
        Returns:
        ProductVersion 指定实例的产品版本。 - local:本地盘版。 - cloud:云盘版, - cdc:独享集群版。如果不传默认发货为本地盘版本。
      • setProductVersion

        public void setProductVersion​(String ProductVersion)
        Set 指定实例的产品版本。 - local:本地盘版。 - cloud:云盘版, - cdc:独享集群版。如果不传默认发货为本地盘版本。
        Parameters:
        ProductVersion - 指定实例的产品版本。 - local:本地盘版。 - cloud:云盘版, - cdc:独享集群版。如果不传默认发货为本地盘版本。
      • getRedisClusterId

        public String getRedisClusterId()
        Get 独享集群 ID。当**ProductVersion**设置为**cdc**时,该参数必须设置。
        Returns:
        RedisClusterId 独享集群 ID。当**ProductVersion**设置为**cdc**时,该参数必须设置。
      • setRedisClusterId

        public void setRedisClusterId​(String RedisClusterId)
        Set 独享集群 ID。当**ProductVersion**设置为**cdc**时,该参数必须设置。
        Parameters:
        RedisClusterId - 独享集群 ID。当**ProductVersion**设置为**cdc**时,该参数必须设置。