Class DBInstance

    • Constructor Summary

      Constructors 
      Constructor Description
      DBInstance()  
      DBInstance​(DBInstance 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 Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getArchitecture()
      Get 架构标识,SINGLE-单节点 DOUBLE-双节点 注意:此字段可能返回 null,表示取不到有效值。
      Long[] getBackupCycle()
      Get 备份周期
      String getBackupCycleType()
      Get 备份周期类型,[daily、weekly、monthly]
      String getBackupModel()
      Get 备份模式,master_pkg-主节点打包备份(默认) ;master_no_pkg-主节点不打包备份;slave_pkg-从节点打包备份(always on集群有效);slave_no_pkg-从节点不打包备份(always on集群有效);只读副本对该值无效。 注意:此字段可能返回 null,表示取不到有效值。
      Long getBackupSaveDays()
      Get 数据(日志)备份保留时间
      String getBackupTime()
      Get 备份时间点
      String getCollation()
      Get 系统字符集排序规则,默认:Chinese_PRC_CI_AS
      Long getCpu()
      Get 实例cpu核心数
      String getCreateTime()
      Get 实例创建时间
      String getCrossBackupEnabled()
      Get 跨地域备份状态 enable-开启,disable-关闭
      Long getCrossBackupSaveDays()
      Get 跨地域备份保留天数,则默认7天
      String[] getCrossRegions()
      Get 跨地域备份目的地域,如果为空,则表示未开启跨地域备份
      String getDnsPodDomain()
      Get 外网地址域名
      String getEndTime()
      Get 实例计费结束时间
      String getHAFlag()
      Get 容灾类型,MIRROR-镜像,ALWAYSON-AlwaysOn, SINGLE-单例 注意:此字段可能返回 null,表示取不到有效值。
      String getInstanceId()
      Get 实例ID
      String getInstanceNote()
      Get 实例备份信息 注意:此字段可能返回 null,表示取不到有效值。
      String getInstanceType()
      Get 实例类型 HA-高可用 RO-只读实例 SI-基础版 BI-商业智能服务
      Boolean getIsDrZone()
      Get 是否跨AZ
      String getIsolateOperator()
      Get 实例隔离操作 注意:此字段可能返回 null,表示取不到有效值。
      String getIsolateTime()
      Get 实例隔离时间
      Long getMemory()
      Get 实例内存大小,单位G
      Long getModel()
      Get 实例高可用, 1-双机高可用,2-单机,3-跨可用区,4-集群跨可用区,5-集群,9-自研机房
      String getName()
      Get 实例名称
      Long getPayMode()
      Get 实例付费模式, 0-按量计费,1-包年包月
      Long getPid()
      Get 计费ID
      Long getProjectId()
      Get 实例所在项目ID
      String getRegion()
      Get 实例所在地域名称,如 ap-guangzhou
      Long getRegionId()
      Get 实例所在地域ID
      Long getRenewFlag()
      Get 实例续费标记,0-正常续费,1-自动续费,2-到期不续费
      ResourceTag[] getResourceTags()
      Get 实例绑定的标签列表 注意:此字段可能返回 null,表示取不到有效值。
      String getROFlag()
      Get 只读标识,RO-只读实例,MASTER-有RO实例的主实例,空值-没有只读组的非RO实例 注意:此字段可能返回 null,表示取不到有效值。
      SlaveZones getSlaveZones()
      Get 备可用区信息 注意:此字段可能返回 null,表示取不到有效值。
      String getStartTime()
      Get 实例计费开始时间
      Long getStatus()
      Get 实例状态。取值范围: 1:申请中 2:运行中 3:受限运行中 (主备切换中) 4:已隔离 5:回收中 6:已回收 7:任务执行中 (实例做备份、回档等操作) 8:已下线 9:实例扩容中 10:实例迁移中 11:只读 12:重启中 13:实例修改中且待切换 14:订阅发布创建中 15:订阅发布修改中 16:实例修改中且切换中 17:创建RO副本中
      Long getStorage()
      Get 实例存储空间大小,单位G
      String getStyle()
      Get 类型标识,EXCLUSIVE-独享型,SHARED-共享型 注意:此字段可能返回 null,表示取不到有效值。
      String getSubFlag()
      Get 发布订阅标识,SUB-订阅实例,PUB-发布实例,空值-没有发布订阅的普通实例 注意:此字段可能返回 null,表示取不到有效值。
      Long getSubnetId()
      Get 实例所在私有网络子网ID,基础网络时为 0
      Long getTgwWanVPort()
      Get 外网端口号
      String getTimeZone()
      Get 系统时区,默认:China Standard Time
      String getType()
      Get 实例类型代号:"TS85"-物理机,本地SSD硬盘;"Z3"-物理机早期版本,本地SSD硬盘;"CLOUD_BASIC"-虚拟机,普通云硬盘;"CLOUD_PREMIUM"-虚拟机,高性能云硬盘;"CLOUD_SSD"-虚拟机,云SSD硬盘;"CLOUD_HSSD"-虚拟机,增强型SSD云硬盘;"CLOUD_TSSD"-虚拟机,极速型SSD云硬盘;"CLOUD_BSSD"-虚拟机,通用型SSD云硬盘
      String getUid()
      Get 实例唯一UID
      String getUniqSubnetId()
      Get 实例所属子网的唯一字符串ID,格式如: subnet-xxx,基础网络时为空字符串
      String getUniqVpcId()
      Get 实例所属VPC的唯一字符串ID,格式如:vpc-xxx,基础网络时为空字符串
      String getUpdateTime()
      Get 实例更新时间
      Long getUsedStorage()
      Get 实例已经使用存储空间大小,单位G
      String getVersion()
      Get 实例版本代号
      String getVersionName()
      Get 实例版本
      String getVip()
      Get 实例访问IP
      Long getVpcId()
      Get 实例所在私有网络ID,基础网络时为 0
      Long getVport()
      Get 实例访问端口
      String getZone()
      Get 实例所在可用区名称,如 ap-guangzhou-1
      Long getZoneId()
      Get 实例所在可用区ID
      void setArchitecture​(String Architecture)
      Set 架构标识,SINGLE-单节点 DOUBLE-双节点 注意:此字段可能返回 null,表示取不到有效值。
      void setBackupCycle​(Long[] BackupCycle)
      Set 备份周期
      void setBackupCycleType​(String BackupCycleType)
      Set 备份周期类型,[daily、weekly、monthly]
      void setBackupModel​(String BackupModel)
      Set 备份模式,master_pkg-主节点打包备份(默认) ;master_no_pkg-主节点不打包备份;slave_pkg-从节点打包备份(always on集群有效);slave_no_pkg-从节点不打包备份(always on集群有效);只读副本对该值无效。 注意:此字段可能返回 null,表示取不到有效值。
      void setBackupSaveDays​(Long BackupSaveDays)
      Set 数据(日志)备份保留时间
      void setBackupTime​(String BackupTime)
      Set 备份时间点
      void setCollation​(String Collation)
      Set 系统字符集排序规则,默认:Chinese_PRC_CI_AS
      void setCpu​(Long Cpu)
      Set 实例cpu核心数
      void setCreateTime​(String CreateTime)
      Set 实例创建时间
      void setCrossBackupEnabled​(String CrossBackupEnabled)
      Set 跨地域备份状态 enable-开启,disable-关闭
      void setCrossBackupSaveDays​(Long CrossBackupSaveDays)
      Set 跨地域备份保留天数,则默认7天
      void setCrossRegions​(String[] CrossRegions)
      Set 跨地域备份目的地域,如果为空,则表示未开启跨地域备份
      void setDnsPodDomain​(String DnsPodDomain)
      Set 外网地址域名
      void setEndTime​(String EndTime)
      Set 实例计费结束时间
      void setHAFlag​(String HAFlag)
      Set 容灾类型,MIRROR-镜像,ALWAYSON-AlwaysOn, SINGLE-单例 注意:此字段可能返回 null,表示取不到有效值。
      void setInstanceId​(String InstanceId)
      Set 实例ID
      void setInstanceNote​(String InstanceNote)
      Set 实例备份信息 注意:此字段可能返回 null,表示取不到有效值。
      void setInstanceType​(String InstanceType)
      Set 实例类型 HA-高可用 RO-只读实例 SI-基础版 BI-商业智能服务
      void setIsDrZone​(Boolean IsDrZone)
      Set 是否跨AZ
      void setIsolateOperator​(String IsolateOperator)
      Set 实例隔离操作 注意:此字段可能返回 null,表示取不到有效值。
      void setIsolateTime​(String IsolateTime)
      Set 实例隔离时间
      void setMemory​(Long Memory)
      Set 实例内存大小,单位G
      void setModel​(Long Model)
      Set 实例高可用, 1-双机高可用,2-单机,3-跨可用区,4-集群跨可用区,5-集群,9-自研机房
      void setName​(String Name)
      Set 实例名称
      void setPayMode​(Long PayMode)
      Set 实例付费模式, 0-按量计费,1-包年包月
      void setPid​(Long Pid)
      Set 计费ID
      void setProjectId​(Long ProjectId)
      Set 实例所在项目ID
      void setRegion​(String Region)
      Set 实例所在地域名称,如 ap-guangzhou
      void setRegionId​(Long RegionId)
      Set 实例所在地域ID
      void setRenewFlag​(Long RenewFlag)
      Set 实例续费标记,0-正常续费,1-自动续费,2-到期不续费
      void setResourceTags​(ResourceTag[] ResourceTags)
      Set 实例绑定的标签列表 注意:此字段可能返回 null,表示取不到有效值。
      void setROFlag​(String ROFlag)
      Set 只读标识,RO-只读实例,MASTER-有RO实例的主实例,空值-没有只读组的非RO实例 注意:此字段可能返回 null,表示取不到有效值。
      void setSlaveZones​(SlaveZones SlaveZones)
      Set 备可用区信息 注意:此字段可能返回 null,表示取不到有效值。
      void setStartTime​(String StartTime)
      Set 实例计费开始时间
      void setStatus​(Long Status)
      Set 实例状态。取值范围: 1:申请中 2:运行中 3:受限运行中 (主备切换中) 4:已隔离 5:回收中 6:已回收 7:任务执行中 (实例做备份、回档等操作) 8:已下线 9:实例扩容中 10:实例迁移中 11:只读 12:重启中 13:实例修改中且待切换 14:订阅发布创建中 15:订阅发布修改中 16:实例修改中且切换中 17:创建RO副本中
      void setStorage​(Long Storage)
      Set 实例存储空间大小,单位G
      void setStyle​(String Style)
      Set 类型标识,EXCLUSIVE-独享型,SHARED-共享型 注意:此字段可能返回 null,表示取不到有效值。
      void setSubFlag​(String SubFlag)
      Set 发布订阅标识,SUB-订阅实例,PUB-发布实例,空值-没有发布订阅的普通实例 注意:此字段可能返回 null,表示取不到有效值。
      void setSubnetId​(Long SubnetId)
      Set 实例所在私有网络子网ID,基础网络时为 0
      void setTgwWanVPort​(Long TgwWanVPort)
      Set 外网端口号
      void setTimeZone​(String TimeZone)
      Set 系统时区,默认:China Standard Time
      void setType​(String Type)
      Set 实例类型代号:"TS85"-物理机,本地SSD硬盘;"Z3"-物理机早期版本,本地SSD硬盘;"CLOUD_BASIC"-虚拟机,普通云硬盘;"CLOUD_PREMIUM"-虚拟机,高性能云硬盘;"CLOUD_SSD"-虚拟机,云SSD硬盘;"CLOUD_HSSD"-虚拟机,增强型SSD云硬盘;"CLOUD_TSSD"-虚拟机,极速型SSD云硬盘;"CLOUD_BSSD"-虚拟机,通用型SSD云硬盘
      void setUid​(String Uid)
      Set 实例唯一UID
      void setUniqSubnetId​(String UniqSubnetId)
      Set 实例所属子网的唯一字符串ID,格式如: subnet-xxx,基础网络时为空字符串
      void setUniqVpcId​(String UniqVpcId)
      Set 实例所属VPC的唯一字符串ID,格式如:vpc-xxx,基础网络时为空字符串
      void setUpdateTime​(String UpdateTime)
      Set 实例更新时间
      void setUsedStorage​(Long UsedStorage)
      Set 实例已经使用存储空间大小,单位G
      void setVersion​(String Version)
      Set 实例版本代号
      void setVersionName​(String VersionName)
      Set 实例版本
      void setVip​(String Vip)
      Set 实例访问IP
      void setVpcId​(Long VpcId)
      Set 实例所在私有网络ID,基础网络时为 0
      void setVport​(Long Vport)
      Set 实例访问端口
      void setZone​(String Zone)
      Set 实例所在可用区名称,如 ap-guangzhou-1
      void setZoneId​(Long ZoneId)
      Set 实例所在可用区ID
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • DBInstance

        public DBInstance()
      • DBInstance

        public DBInstance​(DBInstance 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
        Returns:
        InstanceId 实例ID
      • setInstanceId

        public void setInstanceId​(String InstanceId)
        Set 实例ID
        Parameters:
        InstanceId - 实例ID
      • getName

        public String getName()
        Get 实例名称
        Returns:
        Name 实例名称
      • setName

        public void setName​(String Name)
        Set 实例名称
        Parameters:
        Name - 实例名称
      • getProjectId

        public Long getProjectId()
        Get 实例所在项目ID
        Returns:
        ProjectId 实例所在项目ID
      • setProjectId

        public void setProjectId​(Long ProjectId)
        Set 实例所在项目ID
        Parameters:
        ProjectId - 实例所在项目ID
      • getRegionId

        public Long getRegionId()
        Get 实例所在地域ID
        Returns:
        RegionId 实例所在地域ID
      • setRegionId

        public void setRegionId​(Long RegionId)
        Set 实例所在地域ID
        Parameters:
        RegionId - 实例所在地域ID
      • getZoneId

        public Long getZoneId()
        Get 实例所在可用区ID
        Returns:
        ZoneId 实例所在可用区ID
      • setZoneId

        public void setZoneId​(Long ZoneId)
        Set 实例所在可用区ID
        Parameters:
        ZoneId - 实例所在可用区ID
      • getVpcId

        public Long getVpcId()
        Get 实例所在私有网络ID,基础网络时为 0
        Returns:
        VpcId 实例所在私有网络ID,基础网络时为 0
      • setVpcId

        public void setVpcId​(Long VpcId)
        Set 实例所在私有网络ID,基础网络时为 0
        Parameters:
        VpcId - 实例所在私有网络ID,基础网络时为 0
      • getSubnetId

        public Long getSubnetId()
        Get 实例所在私有网络子网ID,基础网络时为 0
        Returns:
        SubnetId 实例所在私有网络子网ID,基础网络时为 0
      • setSubnetId

        public void setSubnetId​(Long SubnetId)
        Set 实例所在私有网络子网ID,基础网络时为 0
        Parameters:
        SubnetId - 实例所在私有网络子网ID,基础网络时为 0
      • getStatus

        public Long getStatus()
        Get 实例状态。取值范围:
      • 1:申请中
      • 2:运行中
      • 3:受限运行中 (主备切换中)
      • 4:已隔离
      • 5:回收中
      • 6:已回收
      • 7:任务执行中 (实例做备份、回档等操作)
      • 8:已下线
      • 9:实例扩容中
      • 10:实例迁移中
      • 11:只读
      • 12:重启中
      • 13:实例修改中且待切换
      • 14:订阅发布创建中
      • 15:订阅发布修改中
      • 16:实例修改中且切换中
      • 17:创建RO副本中
Returns:
Status 实例状态。取值范围:
  • 1:申请中
  • 2:运行中
  • 3:受限运行中 (主备切换中)
  • 4:已隔离
  • 5:回收中
  • 6:已回收
  • 7:任务执行中 (实例做备份、回档等操作)
  • 8:已下线
  • 9:实例扩容中
  • 10:实例迁移中
  • 11:只读
  • 12:重启中
  • 13:实例修改中且待切换
  • 14:订阅发布创建中
  • 15:订阅发布修改中
  • 16:实例修改中且切换中
  • 17:创建RO副本中
  • Parameters:
    Status - 实例状态。取值范围:
  • 1:申请中
  • 2:运行中
  • 3:受限运行中 (主备切换中)
  • 4:已隔离
  • 5:回收中
  • 6:已回收
  • 7:任务执行中 (实例做备份、回档等操作)
  • 8:已下线
  • 9:实例扩容中
  • 10:实例迁移中
  • 11:只读
  • 12:重启中
  • 13:实例修改中且待切换
  • 14:订阅发布创建中
  • 15:订阅发布修改中
  • 16:实例修改中且切换中
  • 17:创建RO副本中