Package com.tencentcloudapi.cvm.v20170312.models

Class Instance

    • Constructor Summary

      Constructors 
      Constructor Description
      Instance()  
      Instance​(Instance 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 getCamRoleName()
      Get CAM角色名。 注意：此字段可能返回 null，表示取不到有效值。
      Long getCPU()
      Get 实例的CPU核数，单位：核。
      String getCreatedTime()
      Get 创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。
      DataDisk[] getDataDisks()
      Get 实例数据盘信息。
      String getDedicatedClusterId()
      Get 实例所在的专用集群`ID`。 注意：此字段可能返回 null，表示取不到有效值。
      Long getDefaultLoginPort()
      Get 默认登录端口。
      String getDefaultLoginUser()
      Get 默认登录用户。
      Boolean getDisableApiTermination()
      Get 实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：
      TRUE：表示开启实例保护，不允许通过api接口删除实例
      FALSE：表示关闭实例保护，允许通过api接口删除实例

      默认取值：FALSE。
      String getDisasterRecoverGroupId()
      Get 分散置放群组ID。 注意：此字段可能返回 null，表示取不到有效值。
      String getExpiredTime()
      Get 到期时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。注意：后付费模式本项为null
      GPUInfo getGPUInfo()
      Get GPU信息。如果是gpu类型子机，该值会返回GPU信息，如果是其他类型子机则不返回。 注意：此字段可能返回 null，表示取不到有效值。
      String getHpcClusterId()
      Get 高性能计算集群`ID`。 注意：此字段可能返回 null，表示取不到有效值。
      String getImageId()
      Get 生产实例所使用的镜像`ID`。
      String getInstanceChargeType()
      Get 实例计费模式。取值范围：
      `PREPAID`：表示预付费，即包年包月
      `POSTPAID_BY_HOUR`：表示后付费，即按量计费
      `CDHPAID`：`专用宿主机`付费，即只对`专用宿主机`计费，不对`专用宿主机`上的实例计费。
      `SPOTPAID`：表示竞价实例付费。
      String getInstanceId()
      Get 实例`ID`。
      String getInstanceName()
      Get 实例名称。
      String getInstanceState()
      Get 实例状态。取值范围：
      PENDING：表示创建中
      LAUNCH_FAILED：表示创建失败
      RUNNING：表示运行中
      STOPPED：表示关机
      STARTING：表示开机中
      STOPPING：表示关机中
      REBOOTING：表示重启中
      SHUTDOWN：表示停止待销毁
      TERMINATING：表示销毁中。
      String getInstanceType()
      Get 实例机型。
      InternetAccessible getInternetAccessible()
      Get 实例带宽信息。
      String[] getIPv6Addresses()
      Get 实例的IPv6地址。 注意：此字段可能返回 null，表示取不到有效值。
      String getIsolatedSource()
      Get 实例隔离类型。取值范围：
      ARREAR：表示欠费隔离
      EXPIRE：表示到期隔离
      MANMADE：表示主动退还隔离
      NOTISOLATED：表示未隔离
      注意：此字段可能返回 null，表示取不到有效值。
      String getLatestOperation()
      Get 实例的最新操作。例：StopInstances、ResetInstance。 注意：此字段可能返回 null，表示取不到有效值。
      String getLatestOperationErrorMsg()
      Get 实例的最新操作错误信息。 注意：此字段可能返回 null，表示取不到有效值。
      String getLatestOperationRequestId()
      Get 实例最新操作的唯一请求 ID。 注意：此字段可能返回 null，表示取不到有效值。
      String getLatestOperationState()
      Get 实例的最新操作状态。取值范围：
      SUCCESS：表示操作成功
      OPERATING：表示操作执行中
      FAILED：表示操作失败 注意：此字段可能返回 null，表示取不到有效值。
      String getLicenseType()
      Get 实例的操作系统许可类型，默认为TencentCloud
      LoginSettings getLoginSettings()
      Get 实例登录设置。目前只返回实例所关联的密钥。
      Long getMemory()
      Get 实例内存容量，单位：`GB`。
      String getOsName()
      Get 操作系统名称。
      Placement getPlacement()
      Get 实例所在的位置。
      String[] getPrivateIpAddresses()
      Get 实例主网卡的内网`IP`列表。
      String[] getPublicIpAddresses()
      Get 实例主网卡的公网`IP`列表。 注意：此字段可能返回 null，表示取不到有效值。
      String[] getRdmaIpAddresses()
      Get 高性能计算集群`IP`列表。 注意：此字段可能返回 null，表示取不到有效值。
      String getRenewFlag()
      Get 自动续费标识。取值范围：
      `NOTIFY_AND_MANUAL_RENEW`：表示通知即将过期，但不自动续费
      `NOTIFY_AND_AUTO_RENEW`：表示通知即将过期，而且自动续费
      `DISABLE_NOTIFY_AND_MANUAL_RENEW`：表示不通知即将过期，也不自动续费。
      注意：后付费模式本项为null
      String getRestrictState()
      Get 实例业务状态。取值范围：
      NORMAL：表示正常状态的实例
      EXPIRED：表示过期的实例
      PROTECTIVELY_ISOLATED：表示被安全隔离的实例。
      String[] getSecurityGroupIds()
      Get 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。
      String getStopChargingMode()
      Get 实例的关机计费模式。 取值范围：
      KEEP_CHARGING：关机继续收费
      STOP_CHARGING：关机停止收费NOT_APPLICABLE：实例处于非关机状态或者不适用关机停止计费的条件
      SystemDisk getSystemDisk()
      Get 实例系统盘信息。
      Tag[] getTags()
      Get 实例关联的标签列表。
      String getUuid()
      Get 实例全局唯一ID
      VirtualPrivateCloud getVirtualPrivateCloud()
      Get 实例所属虚拟私有网络信息。
      void setCamRoleName​(String CamRoleName)
      Set CAM角色名。 注意：此字段可能返回 null，表示取不到有效值。
      void setCPU​(Long CPU)
      Set 实例的CPU核数，单位：核。
      void setCreatedTime​(String CreatedTime)
      Set 创建时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。
      void setDataDisks​(DataDisk[] DataDisks)
      Set 实例数据盘信息。
      void setDedicatedClusterId​(String DedicatedClusterId)
      Set 实例所在的专用集群`ID`。 注意：此字段可能返回 null，表示取不到有效值。
      void setDefaultLoginPort​(Long DefaultLoginPort)
      Set 默认登录端口。
      void setDefaultLoginUser​(String DefaultLoginUser)
      Set 默认登录用户。
      void setDisableApiTermination​(Boolean DisableApiTermination)
      Set 实例销毁保护标志，表示是否允许通过api接口删除实例。取值范围：
      TRUE：表示开启实例保护，不允许通过api接口删除实例
      FALSE：表示关闭实例保护，允许通过api接口删除实例

      默认取值：FALSE。
      void setDisasterRecoverGroupId​(String DisasterRecoverGroupId)
      Set 分散置放群组ID。 注意：此字段可能返回 null，表示取不到有效值。
      void setExpiredTime​(String ExpiredTime)
      Set 到期时间。按照`ISO8601`标准表示，并且使用`UTC`时间。格式为：`YYYY-MM-DDThh:mm:ssZ`。注意：后付费模式本项为null
      void setGPUInfo​(GPUInfo GPUInfo)
      Set GPU信息。如果是gpu类型子机，该值会返回GPU信息，如果是其他类型子机则不返回。 注意：此字段可能返回 null，表示取不到有效值。
      void setHpcClusterId​(String HpcClusterId)
      Set 高性能计算集群`ID`。 注意：此字段可能返回 null，表示取不到有效值。
      void setImageId​(String ImageId)
      Set 生产实例所使用的镜像`ID`。
      void setInstanceChargeType​(String InstanceChargeType)
      Set 实例计费模式。取值范围：
      `PREPAID`：表示预付费，即包年包月
      `POSTPAID_BY_HOUR`：表示后付费，即按量计费
      `CDHPAID`：`专用宿主机`付费，即只对`专用宿主机`计费，不对`专用宿主机`上的实例计费。
      `SPOTPAID`：表示竞价实例付费。
      void setInstanceId​(String InstanceId)
      Set 实例`ID`。
      void setInstanceName​(String InstanceName)
      Set 实例名称。
      void setInstanceState​(String InstanceState)
      Set 实例状态。取值范围：
      PENDING：表示创建中
      LAUNCH_FAILED：表示创建失败
      RUNNING：表示运行中
      STOPPED：表示关机
      STARTING：表示开机中
      STOPPING：表示关机中
      REBOOTING：表示重启中
      SHUTDOWN：表示停止待销毁
      TERMINATING：表示销毁中。
      void setInstanceType​(String InstanceType)
      Set 实例机型。
      void setInternetAccessible​(InternetAccessible InternetAccessible)
      Set 实例带宽信息。
      void setIPv6Addresses​(String[] IPv6Addresses)
      Set 实例的IPv6地址。 注意：此字段可能返回 null，表示取不到有效值。
      void setIsolatedSource​(String IsolatedSource)
      Set 实例隔离类型。取值范围：
      ARREAR：表示欠费隔离
      EXPIRE：表示到期隔离
      MANMADE：表示主动退还隔离
      NOTISOLATED：表示未隔离
      注意：此字段可能返回 null，表示取不到有效值。
      void setLatestOperation​(String LatestOperation)
      Set 实例的最新操作。例：StopInstances、ResetInstance。 注意：此字段可能返回 null，表示取不到有效值。
      void setLatestOperationErrorMsg​(String LatestOperationErrorMsg)
      Set 实例的最新操作错误信息。 注意：此字段可能返回 null，表示取不到有效值。
      void setLatestOperationRequestId​(String LatestOperationRequestId)
      Set 实例最新操作的唯一请求 ID。 注意：此字段可能返回 null，表示取不到有效值。
      void setLatestOperationState​(String LatestOperationState)
      Set 实例的最新操作状态。取值范围：
      SUCCESS：表示操作成功
      OPERATING：表示操作执行中
      FAILED：表示操作失败 注意：此字段可能返回 null，表示取不到有效值。
      void setLicenseType​(String LicenseType)
      Set 实例的操作系统许可类型，默认为TencentCloud
      void setLoginSettings​(LoginSettings LoginSettings)
      Set 实例登录设置。目前只返回实例所关联的密钥。
      void setMemory​(Long Memory)
      Set 实例内存容量，单位：`GB`。
      void setOsName​(String OsName)
      Set 操作系统名称。
      void setPlacement​(Placement Placement)
      Set 实例所在的位置。
      void setPrivateIpAddresses​(String[] PrivateIpAddresses)
      Set 实例主网卡的内网`IP`列表。
      void setPublicIpAddresses​(String[] PublicIpAddresses)
      Set 实例主网卡的公网`IP`列表。 注意：此字段可能返回 null，表示取不到有效值。
      void setRdmaIpAddresses​(String[] RdmaIpAddresses)
      Set 高性能计算集群`IP`列表。 注意：此字段可能返回 null，表示取不到有效值。
      void setRenewFlag​(String RenewFlag)
      Set 自动续费标识。取值范围：
      `NOTIFY_AND_MANUAL_RENEW`：表示通知即将过期，但不自动续费
      `NOTIFY_AND_AUTO_RENEW`：表示通知即将过期，而且自动续费
      `DISABLE_NOTIFY_AND_MANUAL_RENEW`：表示不通知即将过期，也不自动续费。
      注意：后付费模式本项为null
      void setRestrictState​(String RestrictState)
      Set 实例业务状态。取值范围：
      NORMAL：表示正常状态的实例
      EXPIRED：表示过期的实例
      PROTECTIVELY_ISOLATED：表示被安全隔离的实例。
      void setSecurityGroupIds​(String[] SecurityGroupIds)
      Set 实例所属安全组。该参数可以通过调用 [DescribeSecurityGroups](https://cloud.tencent.com/document/api/215/15808) 的返回值中的sgId字段来获取。
      void setStopChargingMode​(String StopChargingMode)
      Set 实例的关机计费模式。 取值范围：
      KEEP_CHARGING：关机继续收费
      STOP_CHARGING：关机停止收费NOT_APPLICABLE：实例处于非关机状态或者不适用关机停止计费的条件
      void setSystemDisk​(SystemDisk SystemDisk)
      Set 实例系统盘信息。
      void setTags​(Tag[] Tags)
      Set 实例关联的标签列表。
      void setUuid​(String Uuid)
      Set 实例全局唯一ID
      void setVirtualPrivateCloud​(VirtualPrivateCloud VirtualPrivateCloud)
      Set 实例所属虚拟私有网络信息。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • Constructor Detail

      • Instance

        public Instance()

      • Instance

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

      • getPlacement

        public Placement getPlacement()
        Get 实例所在的位置。
        Returns:
        Placement 实例所在的位置。

      • setPlacement

        public void setPlacement​(Placement Placement)
        Set 实例所在的位置。
        Parameters:
        Placement - 实例所在的位置。

      • getInstanceId

        public String getInstanceId()
        Get 实例`ID`。
        Returns:
        InstanceId 实例`ID`。

      • setInstanceId

        public void setInstanceId​(String InstanceId)
        Set 实例`ID`。
        Parameters:
        InstanceId - 实例`ID`。

      • getInstanceType

        public String getInstanceType()
        Get 实例机型。
        Returns:
        InstanceType 实例机型。

      • setInstanceType

        public void setInstanceType​(String InstanceType)
        Set 实例机型。
        Parameters:
        InstanceType - 实例机型。

      • getCPU

        public Long getCPU()
        Get 实例的CPU核数，单位：核。
        Returns:
        CPU 实例的CPU核数，单位：核。

      • setCPU

        public void setCPU​(Long CPU)
        Set 实例的CPU核数，单位：核。
        Parameters:
        CPU - 实例的CPU核数，单位：核。

      • getMemory

        public Long getMemory()
        Get 实例内存容量，单位：`GB`。
        Returns:
        Memory 实例内存容量，单位：`GB`。

      • setMemory

        public void setMemory​(Long Memory)
        Set 实例内存容量，单位：`GB`。
        Parameters:
        Memory - 实例内存容量，单位：`GB`。

      • getRestrictState

        public String getRestrictState()
        Get 实例业务状态。取值范围：
      • NORMAL：表示正常状态的实例
      • EXPIRED：表示过期的实例
      • PROTECTIVELY_ISOLATED：表示被安全隔离的实例。
Returns:
RestrictState 实例业务状态。取值范围：
  • NORMAL：表示正常状态的实例
  • EXPIRED：表示过期的实例
  • PROTECTIVELY_ISOLATED：表示被安全隔离的实例。
    • Parameters:
    RestrictState - 实例业务状态。取值范围：
  • NORMAL：表示正常状态的实例
  • EXPIRED：表示过期的实例
  • PROTECTIVELY_ISOLATED：表示被安全隔离的实例。