Class UpgradeDBInstanceRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getBackupZone()
      Get 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      Long getCpu()
      Get 升级后的实例cpu核数,如果不传将根据 Memory 指定的内存值自动填充最小允许规格的cpu值。
      Long getCrossCluster()
      Get 是否跨区迁移。0-普通迁移,1-跨区迁移,默认值为0。该值为1时支持变更实例主节点可用区。
      Long getDeployMode()
      Get 部署模式,默认为 0,支持值包括:0 - 单可用区部署,1 - 多可用区部署,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      String getDeviceType()
      Get 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC" - 基础版实例。
      String getEngineVersion()
      Get 主实例数据库引擎版本,支持值包括:5.5、5.6 和 5.7。
      Long getFastUpgrade()
      Get 是否极速变配。0-普通升级,1-极速变配,2 极速优先。选择极速变配会根据资源状况校验是否可以进行极速变配,满足条件则进行极速变配,不满足条件会返回报错信息。
      String getInstanceId()
      Get 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
      String getInstanceRole()
      Get 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
      Long getMaxDelayTime()
      Get 延迟阈值。取值范围1~10,默认值为10。
      Long getMemory()
      Get 升级后的内存大小,单位:MB,为保证传入 Memory 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。
      Long getProtectMode()
      Get 数据复制方式,支持值包括:0 - 异步复制,1 - 半同步复制,2 - 强同步复制,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      String getRoTransType()
      Get 针对跨集群搬迁场景,选择同可用区RO的处理逻辑。together-同可用区RO跟随主实例迁移至目标可用区(默认选项),severally-同可用区RO保持原部署模式、不迁移至目标可用区。
      String getSlaveZone()
      Get 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
      Long getVolume()
      Get 升级后的硬盘大小,单位:GB,为保证传入 Volume 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。
      Long getWaitSwitch()
      Get 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
      String getZoneId()
      Get 主节点可用区,该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。
      void setBackupZone​(String BackupZone)
      Set 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      void setCpu​(Long Cpu)
      Set 升级后的实例cpu核数,如果不传将根据 Memory 指定的内存值自动填充最小允许规格的cpu值。
      void setCrossCluster​(Long CrossCluster)
      Set 是否跨区迁移。0-普通迁移,1-跨区迁移,默认值为0。该值为1时支持变更实例主节点可用区。
      void setDeployMode​(Long DeployMode)
      Set 部署模式,默认为 0,支持值包括:0 - 单可用区部署,1 - 多可用区部署,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      void setDeviceType​(String DeviceType)
      Set 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC" - 基础版实例。
      void setEngineVersion​(String EngineVersion)
      Set 主实例数据库引擎版本,支持值包括:5.5、5.6 和 5.7。
      void setFastUpgrade​(Long FastUpgrade)
      Set 是否极速变配。0-普通升级,1-极速变配,2 极速优先。选择极速变配会根据资源状况校验是否可以进行极速变配,满足条件则进行极速变配,不满足条件会返回报错信息。
      void setInstanceId​(String InstanceId)
      Set 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
      void setInstanceRole​(String InstanceRole)
      Set 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
      void setMaxDelayTime​(Long MaxDelayTime)
      Set 延迟阈值。取值范围1~10,默认值为10。
      void setMemory​(Long Memory)
      Set 升级后的内存大小,单位:MB,为保证传入 Memory 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。
      void setProtectMode​(Long ProtectMode)
      Set 数据复制方式,支持值包括:0 - 异步复制,1 - 半同步复制,2 - 强同步复制,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      void setRoTransType​(String RoTransType)
      Set 针对跨集群搬迁场景,选择同可用区RO的处理逻辑。together-同可用区RO跟随主实例迁移至目标可用区(默认选项),severally-同可用区RO保持原部署模式、不迁移至目标可用区。
      void setSlaveZone​(String SlaveZone)
      Set 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
      void setVolume​(Long Volume)
      Set 升级后的硬盘大小,单位:GB,为保证传入 Volume 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。
      void setWaitSwitch​(Long WaitSwitch)
      Set 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
      void setZoneId​(String ZoneId)
      Set 主节点可用区,该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • UpgradeDBInstanceRequest

        public UpgradeDBInstanceRequest()
      • UpgradeDBInstanceRequest

        public UpgradeDBInstanceRequest​(UpgradeDBInstanceRequest 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

      • getInstanceId

        public String getInstanceId()
        Get 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
        Returns:
        InstanceId 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
      • setInstanceId

        public void setInstanceId​(String InstanceId)
        Set 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
        Parameters:
        InstanceId - 实例 ID,格式如:cdb-c1nl9rpv 或者 cdbro-c1nl9rpv。与云数据库控制台页面中显示的实例 ID 相同,可使用 [查询实例列表](https://cloud.tencent.com/document/api/236/15872) 接口获取,其值为输出参数中字段 InstanceId 的值。
      • getMemory

        public Long getMemory()
        Get 升级后的内存大小,单位:MB,为保证传入 Memory 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。
        Returns:
        Memory 升级后的内存大小,单位:MB,为保证传入 Memory 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。
      • setMemory

        public void setMemory​(Long Memory)
        Set 升级后的内存大小,单位:MB,为保证传入 Memory 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。
        Parameters:
        Memory - 升级后的内存大小,单位:MB,为保证传入 Memory 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的内存规格。
      • getVolume

        public Long getVolume()
        Get 升级后的硬盘大小,单位:GB,为保证传入 Volume 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。
        Returns:
        Volume 升级后的硬盘大小,单位:GB,为保证传入 Volume 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。
      • setVolume

        public void setVolume​(Long Volume)
        Set 升级后的硬盘大小,单位:GB,为保证传入 Volume 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。
        Parameters:
        Volume - 升级后的硬盘大小,单位:GB,为保证传入 Volume 值有效,请使用 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口获取可升级的硬盘范围。
      • getProtectMode

        public Long getProtectMode()
        Get 数据复制方式,支持值包括:0 - 异步复制,1 - 半同步复制,2 - 强同步复制,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
        Returns:
        ProtectMode 数据复制方式,支持值包括:0 - 异步复制,1 - 半同步复制,2 - 强同步复制,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      • setProtectMode

        public void setProtectMode​(Long ProtectMode)
        Set 数据复制方式,支持值包括:0 - 异步复制,1 - 半同步复制,2 - 强同步复制,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
        Parameters:
        ProtectMode - 数据复制方式,支持值包括:0 - 异步复制,1 - 半同步复制,2 - 强同步复制,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      • getDeployMode

        public Long getDeployMode()
        Get 部署模式,默认为 0,支持值包括:0 - 单可用区部署,1 - 多可用区部署,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
        Returns:
        DeployMode 部署模式,默认为 0,支持值包括:0 - 单可用区部署,1 - 多可用区部署,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      • setDeployMode

        public void setDeployMode​(Long DeployMode)
        Set 部署模式,默认为 0,支持值包括:0 - 单可用区部署,1 - 多可用区部署,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
        Parameters:
        DeployMode - 部署模式,默认为 0,支持值包括:0 - 单可用区部署,1 - 多可用区部署,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      • getSlaveZone

        public String getSlaveZone()
        Get 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
        Returns:
        SlaveZone 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
      • setSlaveZone

        public void setSlaveZone​(String SlaveZone)
        Set 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
        Parameters:
        SlaveZone - 备库1的可用区信息,默认和实例的 Zone 参数一致,升级主实例为多可用区部署时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。可通过 [获取云数据库可售卖规格](https://cloud.tencent.com/document/product/236/17229) 接口查询支持的可用区。
      • getEngineVersion

        public String getEngineVersion()
        Get 主实例数据库引擎版本,支持值包括:5.5、5.6 和 5.7。
        Returns:
        EngineVersion 主实例数据库引擎版本,支持值包括:5.5、5.6 和 5.7。
      • setEngineVersion

        public void setEngineVersion​(String EngineVersion)
        Set 主实例数据库引擎版本,支持值包括:5.5、5.6 和 5.7。
        Parameters:
        EngineVersion - 主实例数据库引擎版本,支持值包括:5.5、5.6 和 5.7。
      • getWaitSwitch

        public Long getWaitSwitch()
        Get 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
        Returns:
        WaitSwitch 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
      • setWaitSwitch

        public void setWaitSwitch​(Long WaitSwitch)
        Set 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
        Parameters:
        WaitSwitch - 切换访问新实例的方式,默认为 0。支持值包括:0 - 立刻切换,1 - 时间窗切换;当该值为 1 时,升级过程中,切换访问新实例的流程将会在时间窗内进行,或者用户主动调用接口 [切换访问新实例](https://cloud.tencent.com/document/product/236/15864) 触发该流程。
      • getBackupZone

        public String getBackupZone()
        Get 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
        Returns:
        BackupZone 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      • setBackupZone

        public void setBackupZone​(String BackupZone)
        Set 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
        Parameters:
        BackupZone - 备库 2 的可用区信息,默认为空,升级主实例时可指定该参数,升级只读实例或者灾备实例时指定该参数无意义。
      • getInstanceRole

        public String getInstanceRole()
        Get 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
        Returns:
        InstanceRole 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
      • setInstanceRole

        public void setInstanceRole​(String InstanceRole)
        Set 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
        Parameters:
        InstanceRole - 实例类型,默认为 master,支持值包括:master - 表示主实例,dr - 表示灾备实例,ro - 表示只读实例。
      • getDeviceType

        public String getDeviceType()
        Get 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC" - 基础版实例。
        Returns:
        DeviceType 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC" - 基础版实例。
      • setDeviceType

        public void setDeviceType​(String DeviceType)
        Set 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC" - 基础版实例。
        Parameters:
        DeviceType - 实例隔离类型。支持值包括: "UNIVERSAL" - 通用型实例, "EXCLUSIVE" - 独享型实例, "BASIC" - 基础版实例。
      • getCpu

        public Long getCpu()
        Get 升级后的实例cpu核数,如果不传将根据 Memory 指定的内存值自动填充最小允许规格的cpu值。
        Returns:
        Cpu 升级后的实例cpu核数,如果不传将根据 Memory 指定的内存值自动填充最小允许规格的cpu值。
      • setCpu

        public void setCpu​(Long Cpu)
        Set 升级后的实例cpu核数,如果不传将根据 Memory 指定的内存值自动填充最小允许规格的cpu值。
        Parameters:
        Cpu - 升级后的实例cpu核数,如果不传将根据 Memory 指定的内存值自动填充最小允许规格的cpu值。
      • getFastUpgrade

        public Long getFastUpgrade()
        Get 是否极速变配。0-普通升级,1-极速变配,2 极速优先。选择极速变配会根据资源状况校验是否可以进行极速变配,满足条件则进行极速变配,不满足条件会返回报错信息。
        Returns:
        FastUpgrade 是否极速变配。0-普通升级,1-极速变配,2 极速优先。选择极速变配会根据资源状况校验是否可以进行极速变配,满足条件则进行极速变配,不满足条件会返回报错信息。
      • setFastUpgrade

        public void setFastUpgrade​(Long FastUpgrade)
        Set 是否极速变配。0-普通升级,1-极速变配,2 极速优先。选择极速变配会根据资源状况校验是否可以进行极速变配,满足条件则进行极速变配,不满足条件会返回报错信息。
        Parameters:
        FastUpgrade - 是否极速变配。0-普通升级,1-极速变配,2 极速优先。选择极速变配会根据资源状况校验是否可以进行极速变配,满足条件则进行极速变配,不满足条件会返回报错信息。
      • getMaxDelayTime

        public Long getMaxDelayTime()
        Get 延迟阈值。取值范围1~10,默认值为10。
        Returns:
        MaxDelayTime 延迟阈值。取值范围1~10,默认值为10。
      • setMaxDelayTime

        public void setMaxDelayTime​(Long MaxDelayTime)
        Set 延迟阈值。取值范围1~10,默认值为10。
        Parameters:
        MaxDelayTime - 延迟阈值。取值范围1~10,默认值为10。
      • getCrossCluster

        public Long getCrossCluster()
        Get 是否跨区迁移。0-普通迁移,1-跨区迁移,默认值为0。该值为1时支持变更实例主节点可用区。
        Returns:
        CrossCluster 是否跨区迁移。0-普通迁移,1-跨区迁移,默认值为0。该值为1时支持变更实例主节点可用区。
      • setCrossCluster

        public void setCrossCluster​(Long CrossCluster)
        Set 是否跨区迁移。0-普通迁移,1-跨区迁移,默认值为0。该值为1时支持变更实例主节点可用区。
        Parameters:
        CrossCluster - 是否跨区迁移。0-普通迁移,1-跨区迁移,默认值为0。该值为1时支持变更实例主节点可用区。
      • getZoneId

        public String getZoneId()
        Get 主节点可用区,该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。
        Returns:
        ZoneId 主节点可用区,该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。
      • setZoneId

        public void setZoneId​(String ZoneId)
        Set 主节点可用区,该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。
        Parameters:
        ZoneId - 主节点可用区,该值仅在跨区迁移时生效。仅支持同地域下的可用区进行迁移。
      • getRoTransType

        public String getRoTransType()
        Get 针对跨集群搬迁场景,选择同可用区RO的处理逻辑。together-同可用区RO跟随主实例迁移至目标可用区(默认选项),severally-同可用区RO保持原部署模式、不迁移至目标可用区。
        Returns:
        RoTransType 针对跨集群搬迁场景,选择同可用区RO的处理逻辑。together-同可用区RO跟随主实例迁移至目标可用区(默认选项),severally-同可用区RO保持原部署模式、不迁移至目标可用区。
      • setRoTransType

        public void setRoTransType​(String RoTransType)
        Set 针对跨集群搬迁场景,选择同可用区RO的处理逻辑。together-同可用区RO跟随主实例迁移至目标可用区(默认选项),severally-同可用区RO保持原部署模式、不迁移至目标可用区。
        Parameters:
        RoTransType - 针对跨集群搬迁场景,选择同可用区RO的处理逻辑。together-同可用区RO跟随主实例迁移至目标可用区(默认选项),severally-同可用区RO保持原部署模式、不迁移至目标可用区。