Package com.tencentcloudapi.postgres.v20170312.models

Class CreateInstancesRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Long getActivityId()
      Get 活动ID。
      String getAdminName()
      Get 实例根账号用户名，具体规范如下： 用户名需要1-16个字符，只能由字母、数字或下划线组成 不能为postgres 不能由数字和pg_开头 所有规则均不区分大小写
      String getAdminPassword()
      Get 实例根账号用户名对应的密码，长度8 ~ 32位，推荐使用12位以上的密码;不能以" / "开头; 必须包含以下四项，字符种类: 小写字母： [a ~ z] 大写字母：[A ～ Z] 数字：0 - 9 特殊字符：()`~!@#$%^&*-+=_|{}[]:;'<>,.?/
      Long getAutoRenewFlag()
      Get 续费标记： 0：手动续费 1：自动续费 默认值：0
      Long getAutoVoucher()
      Get 是否自动使用代金券： 0：否 1：是 默认值：0
      String getCharset()
      Get 实例字符集，目前只支持： UTF8 LATIN1
      String getDBEngine()
      Get 数据库引擎，支持： postgresql：云数据库PostgreSQL mssql_compatible：MSSQL兼容-云数据库PostgreSQL 默认值：postgresql
      String getDBEngineConfig()
      Get 数据库引擎的配置信息，配置格式如下： {"$key1":"$value1", "$key2":"$value2"} 各引擎支持如下： mssql_compatible引擎： migrationMode：数据库模式，可选参数，可取值：single-db（单数据库模式），multi-db（多数据库模式）。默认为single-db。 defaultLocale：排序区域规则，可选参数，在初始化后不可修改，默认为en_US，可选值如下： "af_ZA", "sq_AL", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy_AM", "az_Cyrl_AZ", "az_Latn_AZ", "eu_ES", "be_BY", "bg_BG", "ca_ES", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_BZ", "en_CA", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_GB", "en_US", "en_ZW", "et_EE", "fo_FO", "fa_IR", "fi_FI", "fr_BE", "fr_CA", "fr_FR", "fr_LU", "fr_MC", "fr_CH", "mk_MK", "ka_GE", "de_AT", "de_DE", "de_LI", "de_LU", "de_CH", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "it_IT", "it_CH", "ja_JP", "kn_IN", "kok_IN", "ko_KR", "ky_KG", "lv_LV", "lt_LT", "ms_BN", "ms_MY", "mr_IN", "mn_MN", "nb_NO", "nn_NO", "pl_PL", "pt_BR", "pt_PT", "pa_IN", "ro_RO", "ru_RU", "sa_IN", "sr_Cyrl_RS", "sr_Latn_RS", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY","es_PE", "es_PR", "es_ES", "es_TRADITIONAL", "es_UY", "es_VE", "sw_KE", "sv_FI", "sv_SE", "tt_RU", "te_IN", "th_TH", "tr_TR", "uk_UA", "ur_IN", "ur_PK", "uz_Cyrl_UZ", "uz_Latn_UZ", "vi_VN"。 serverCollationName：排序规则名称，可选参数，在初始化后不可修改，默认为sql_latin1_general_cp1_ci_as，可选值如下："bbf_unicode_general_ci_as", "bbf_unicode_cp1_ci_as", "bbf_unicode_CP1250_ci_as", "bbf_unicode_CP1251_ci_as", "bbf_unicode_cp1253_ci_as", "bbf_unicode_cp1254_ci_as", "bbf_unicode_cp1255_ci_as", "bbf_unicode_cp1256_ci_as", "bbf_unicode_cp1257_ci_as", "bbf_unicode_cp1258_ci_as", "bbf_unicode_cp874_ci_as", "sql_latin1_general_cp1250_ci_as", "sql_latin1_general_cp1251_ci_as", "sql_latin1_general_cp1_ci_as", "sql_latin1_general_cp1253_ci_as", "sql_latin1_general_cp1254_ci_as", "sql_latin1_general_cp1255_ci_as","sql_latin1_general_cp1256_ci_as", "sql_latin1_general_cp1257_ci_as", "sql_latin1_general_cp1258_ci_as", "chinese_prc_ci_as", "cyrillic_general_ci_as", "finnish_swedish_ci_as", "french_ci_as", "japanese_ci_as", "korean_wansung_ci_as", "latin1_general_ci_as", "modern_spanish_ci_as", "polish_ci_as", "thai_ci_as", "traditional_spanish_ci_as", "turkish_ci_as", "ukrainian_ci_as", "vietnamese_ci_as"。
      String getDBKernelVersion()
      Get PostgreSQL内核版本号。 一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新内核版本号。
      String getDBMajorVersion()
      Get PostgreSQL大版本号（该参数当前必传），版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。目前支持10，11，12，13，14，15这几个大版本，详情见[内核版本概述](https://cloud.tencent.com/document/product/409/67018)。 输入该参数时，会基于此大版本号创建对应的最新小版本的最新内核版本号实例。
      DBNode[] getDBNodeSet()
      Get 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
      String getDBVersion()
      Get PostgreSQL社区大版本+小版本号。 一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新小版本号。
      String getInstanceChargeType()
      Get 实例计费类型，目前支持： PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：后付费，即按量计费 默认值：PREPAID
      Long getInstanceCount()
      Get 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。
      String getKMSKeyId()
      Get 自定义密钥的KeyId，若选择自定义密匙加密，则需要传入自定义密匙的KeyId，KeyId是CMK的唯一标识。 KeyId创建获取相关参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)
      String getKMSRegion()
      Get 使用KMS服务的地域，KMSRegion为空默认使用本地域的KMS，本地域不支持的情况下需自选其他KMS支持的地域。 KMSRegion相关介绍参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)
      String getName()
      Get 实例名称，仅支持长度小于60的中文/英文/数字/"_"/"-"，不指定实例名称则默认显示"未命名"。
      Long getNeedSupportIpv6()
      Get 是否需要支持Ipv6： 0：否 1：是 默认值：0
      Long getNeedSupportTDE()
      Get 是否需要支持数据透明加密： 0：否 1：是 默认值：0 参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)
      Long getPeriod()
      Get 购买时长，单位：月。 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36 后付费：只支持1
      Long getProjectId()
      Get 项目ID。
      String[] getSecurityGroupIds()
      Get 实例所属安全组，该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。
      String getSpecCode()
      Get 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
      Long getStorage()
      Get 实例容量大小，单位：GB。
      String getSubnetId()
      Get 私有网络子网ID，形如subnet-xxxxxxxx（该参数当前必传）。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784)，从接口返回中的unSubnetId字段获取。
      String getSyncMode()
      Get 主从同步方式，支持： Semi-sync：半同步 Async：异步 主实例默认值：Semi-sync 只读实例默认值：Async
      Tag[] getTagList()
      Get 实例需要绑定的Tag信息，默认为空；可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。
      String[] getVoucherIds()
      Get 代金券ID列表，目前仅支持指定一张代金券。
      String getVpcId()
      Get 私有网络ID，形如vpc-xxxxxxxx（该参数当前必传）。有效的VpcId可通过登录控制台查询；也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ，从接口返回中的unVpcId字段获取。
      String getZone()
      Get 实例所属主可用区， 如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息； 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
      void setActivityId​(Long ActivityId)
      Set 活动ID。
      void setAdminName​(String AdminName)
      Set 实例根账号用户名，具体规范如下： 用户名需要1-16个字符，只能由字母、数字或下划线组成 不能为postgres 不能由数字和pg_开头 所有规则均不区分大小写
      void setAdminPassword​(String AdminPassword)
      Set 实例根账号用户名对应的密码，长度8 ~ 32位，推荐使用12位以上的密码;不能以" / "开头; 必须包含以下四项，字符种类: 小写字母： [a ~ z] 大写字母：[A ～ Z] 数字：0 - 9 特殊字符：()`~!@#$%^&*-+=_|{}[]:;'<>,.?/
      void setAutoRenewFlag​(Long AutoRenewFlag)
      Set 续费标记： 0：手动续费 1：自动续费 默认值：0
      void setAutoVoucher​(Long AutoVoucher)
      Set 是否自动使用代金券： 0：否 1：是 默认值：0
      void setCharset​(String Charset)
      Set 实例字符集，目前只支持： UTF8 LATIN1
      void setDBEngine​(String DBEngine)
      Set 数据库引擎，支持： postgresql：云数据库PostgreSQL mssql_compatible：MSSQL兼容-云数据库PostgreSQL 默认值：postgresql
      void setDBEngineConfig​(String DBEngineConfig)
      Set 数据库引擎的配置信息，配置格式如下： {"$key1":"$value1", "$key2":"$value2"} 各引擎支持如下： mssql_compatible引擎： migrationMode：数据库模式，可选参数，可取值：single-db（单数据库模式），multi-db（多数据库模式）。默认为single-db。 defaultLocale：排序区域规则，可选参数，在初始化后不可修改，默认为en_US，可选值如下： "af_ZA", "sq_AL", "ar_DZ", "ar_BH", "ar_EG", "ar_IQ", "ar_JO", "ar_KW", "ar_LB", "ar_LY", "ar_MA", "ar_OM", "ar_QA", "ar_SA", "ar_SY", "ar_TN", "ar_AE", "ar_YE", "hy_AM", "az_Cyrl_AZ", "az_Latn_AZ", "eu_ES", "be_BY", "bg_BG", "ca_ES", "zh_HK", "zh_MO", "zh_CN", "zh_SG", "zh_TW", "hr_HR", "cs_CZ", "da_DK", "nl_BE", "nl_NL", "en_AU", "en_BZ", "en_CA", "en_IE", "en_JM", "en_NZ", "en_PH", "en_ZA", "en_TT", "en_GB", "en_US", "en_ZW", "et_EE", "fo_FO", "fa_IR", "fi_FI", "fr_BE", "fr_CA", "fr_FR", "fr_LU", "fr_MC", "fr_CH", "mk_MK", "ka_GE", "de_AT", "de_DE", "de_LI", "de_LU", "de_CH", "el_GR", "gu_IN", "he_IL", "hi_IN", "hu_HU", "is_IS", "id_ID", "it_IT", "it_CH", "ja_JP", "kn_IN", "kok_IN", "ko_KR", "ky_KG", "lv_LV", "lt_LT", "ms_BN", "ms_MY", "mr_IN", "mn_MN", "nb_NO", "nn_NO", "pl_PL", "pt_BR", "pt_PT", "pa_IN", "ro_RO", "ru_RU", "sa_IN", "sr_Cyrl_RS", "sr_Latn_RS", "sk_SK", "sl_SI", "es_AR", "es_BO", "es_CL", "es_CO", "es_CR", "es_DO", "es_EC", "es_SV", "es_GT", "es_HN", "es_MX", "es_NI", "es_PA", "es_PY","es_PE", "es_PR", "es_ES", "es_TRADITIONAL", "es_UY", "es_VE", "sw_KE", "sv_FI", "sv_SE", "tt_RU", "te_IN", "th_TH", "tr_TR", "uk_UA", "ur_IN", "ur_PK", "uz_Cyrl_UZ", "uz_Latn_UZ", "vi_VN"。 serverCollationName：排序规则名称，可选参数，在初始化后不可修改，默认为sql_latin1_general_cp1_ci_as，可选值如下："bbf_unicode_general_ci_as", "bbf_unicode_cp1_ci_as", "bbf_unicode_CP1250_ci_as", "bbf_unicode_CP1251_ci_as", "bbf_unicode_cp1253_ci_as", "bbf_unicode_cp1254_ci_as", "bbf_unicode_cp1255_ci_as", "bbf_unicode_cp1256_ci_as", "bbf_unicode_cp1257_ci_as", "bbf_unicode_cp1258_ci_as", "bbf_unicode_cp874_ci_as", "sql_latin1_general_cp1250_ci_as", "sql_latin1_general_cp1251_ci_as", "sql_latin1_general_cp1_ci_as", "sql_latin1_general_cp1253_ci_as", "sql_latin1_general_cp1254_ci_as", "sql_latin1_general_cp1255_ci_as","sql_latin1_general_cp1256_ci_as", "sql_latin1_general_cp1257_ci_as", "sql_latin1_general_cp1258_ci_as", "chinese_prc_ci_as", "cyrillic_general_ci_as", "finnish_swedish_ci_as", "french_ci_as", "japanese_ci_as", "korean_wansung_ci_as", "latin1_general_ci_as", "modern_spanish_ci_as", "polish_ci_as", "thai_ci_as", "traditional_spanish_ci_as", "turkish_ci_as", "ukrainian_ci_as", "vietnamese_ci_as"。
      void setDBKernelVersion​(String DBKernelVersion)
      Set PostgreSQL内核版本号。 一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新内核版本号。
      void setDBMajorVersion​(String DBMajorVersion)
      Set PostgreSQL大版本号（该参数当前必传），版本信息可从[DescribeDBVersions](https://cloud.tencent.com/document/api/409/89018)获取。目前支持10，11，12，13，14，15这几个大版本，详情见[内核版本概述](https://cloud.tencent.com/document/product/409/67018)。 输入该参数时，会基于此大版本号创建对应的最新小版本的最新内核版本号实例。
      void setDBNodeSet​(DBNode[] DBNodeSet)
      Set 实例节点部署信息，支持多可用区部署时需要指定每个节点的部署可用区信息。 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
      void setDBVersion​(String DBVersion)
      Set PostgreSQL社区大版本+小版本号。 一般场景不推荐传入该参数。如需指定，只能传当前大版本号下最新小版本号。
      void setInstanceChargeType​(String InstanceChargeType)
      Set 实例计费类型，目前支持： PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：后付费，即按量计费 默认值：PREPAID
      void setInstanceCount​(Long InstanceCount)
      Set 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。
      void setKMSKeyId​(String KMSKeyId)
      Set 自定义密钥的KeyId，若选择自定义密匙加密，则需要传入自定义密匙的KeyId，KeyId是CMK的唯一标识。 KeyId创建获取相关参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)
      void setKMSRegion​(String KMSRegion)
      Set 使用KMS服务的地域，KMSRegion为空默认使用本地域的KMS，本地域不支持的情况下需自选其他KMS支持的地域。 KMSRegion相关介绍参考[开启透明数据加密](https://cloud.tencent.com/document/product/409/71749)
      void setName​(String Name)
      Set 实例名称，仅支持长度小于60的中文/英文/数字/"_"/"-"，不指定实例名称则默认显示"未命名"。
      void setNeedSupportIpv6​(Long NeedSupportIpv6)
      Set 是否需要支持Ipv6： 0：否 1：是 默认值：0
      void setNeedSupportTDE​(Long NeedSupportTDE)
      Set 是否需要支持数据透明加密： 0：否 1：是 默认值：0 参考[数据透明加密概述](https://cloud.tencent.com/document/product/409/71748)
      void setPeriod​(Long Period)
      Set 购买时长，单位：月。 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36 后付费：只支持1
      void setProjectId​(Long ProjectId)
      Set 项目ID。
      void setSecurityGroupIds​(String[] SecurityGroupIds)
      Set 实例所属安全组，该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。若不指定该参数，则绑定默认安全组。
      void setSpecCode​(String SpecCode)
      Set 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
      void setStorage​(Long Storage)
      Set 实例容量大小，单位：GB。
      void setSubnetId​(String SubnetId)
      Set 私有网络子网ID，形如subnet-xxxxxxxx（该参数当前必传）。有效的私有网络子网ID可通过登录控制台查询；也可以调用接口 [DescribeSubnets ](https://cloud.tencent.com/document/api/215/15784)，从接口返回中的unSubnetId字段获取。
      void setSyncMode​(String SyncMode)
      Set 主从同步方式，支持： Semi-sync：半同步 Async：异步 主实例默认值：Semi-sync 只读实例默认值：Async
      void setTagList​(Tag[] TagList)
      Set 实例需要绑定的Tag信息，默认为空；可以通过调用 [DescribeTags](https://cloud.tencent.com/document/api/651/35316) 返回值中的 Tags 字段来获取。
      void setVoucherIds​(String[] VoucherIds)
      Set 代金券ID列表，目前仅支持指定一张代金券。
      void setVpcId​(String VpcId)
      Set 私有网络ID，形如vpc-xxxxxxxx（该参数当前必传）。有效的VpcId可通过登录控制台查询；也可以调用接口 [DescribeVpcEx](https://cloud.tencent.com/document/api/215/1372) ，从接口返回中的unVpcId字段获取。
      void setZone​(String Zone)
      Set 实例所属主可用区， 如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息； 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
      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

      • getZone

        public String getZone()
        Get 实例所属主可用区， 如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息； 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
        Returns:
        Zone 实例所属主可用区， 如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息； 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。

      • setZone

        public void setZone​(String Zone)
        Set 实例所属主可用区， 如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息； 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。
        Parameters:
        Zone - 实例所属主可用区， 如：ap-guangzhou-3；若需要支持多可用区，在DBNodeSet.N字段中进行添加主可用区和备可用区信息； 可用区信息可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/409/16769) 接口的返回值中的Zone字段来获取。

      • getSpecCode

        public String getSpecCode()
        Get 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
        Returns:
        SpecCode 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。

      • setSpecCode

        public void setSpecCode​(String SpecCode)
        Set 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。
        Parameters:
        SpecCode - 售卖规格码。该参数可以通过调用[DescribeClasses](https://cloud.tencent.com/document/api/409/89019)的返回值中的SpecCode字段来获取。

      • getStorage

        public Long getStorage()
        Get 实例容量大小，单位：GB。
        Returns:
        Storage 实例容量大小，单位：GB。

      • setStorage

        public void setStorage​(Long Storage)
        Set 实例容量大小，单位：GB。
        Parameters:
        Storage - 实例容量大小，单位：GB。

      • getInstanceCount

        public Long getInstanceCount()
        Get 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。
        Returns:
        InstanceCount 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。

      • setInstanceCount

        public void setInstanceCount​(Long InstanceCount)
        Set 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。
        Parameters:
        InstanceCount - 购买实例数量，取值范围：[1-10]。一次性购买支持最大数量10个，若超过该数量，可进行多次调用进行购买。

      • getPeriod

        public Long getPeriod()
        Get 购买时长，单位：月。
      • 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
      • 后付费：只支持1
Returns:
Period 购买时长，单位：月。
  • 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
  • 后付费：只支持1
    • Parameters:
    Period - 购买时长，单位：月。
  • 预付费：支持1,2,3,4,5,6,7,8,9,10,11,12,24,36
  • 后付费：只支持1