Class ModifyInstancesAttributeRequest


  • public class ModifyInstancesAttributeRequest
    extends AbstractModel
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getCamRoleName()
      Get 给实例绑定用户角色,传空值为解绑操作
      String getCamRoleType()
      Get 角色类别,与CamRoleName搭配使用,该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取,当前只接受user、system和service_linked三种类别。 举例:一般CamRoleName中包含“LinkedRoleIn”(如TKE_QCSLinkedRoleInPrometheusService)时,DescribeRoleList和GetRole返回的RoleType为service_linked,则本参数也需要传递service_linked。 该参数默认值为user,若CameRoleName为非service_linked类型,本参数可不传递。
      Boolean getDisableApiTermination()
      Get 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:
      TRUE:表示开启实例保护,不允许通过api接口删除实例
      FALSE:表示关闭实例保护,允许通过api接口删除实例

      默认取值:FALSE。
      String getHostName()
      Get 实例的主机名。
      点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
      Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
      其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
      注意点:修改主机名后实例会立即重启,重启后新的主机名生效。
      String[] getInstanceIds()
      Get 一个或多个待操作的实例ID。可通过[`DescribeInstances`](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。
      String getInstanceName()
      Get 实例名称。可任意命名,但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置
      String[] getSecurityGroups()
      Get 指定实例的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置
      void setCamRoleName​(String CamRoleName)
      Set 给实例绑定用户角色,传空值为解绑操作
      void setCamRoleType​(String CamRoleType)
      Set 角色类别,与CamRoleName搭配使用,该值可从CAM DescribeRoleList, GetRole接口返回RoleType字段获取,当前只接受user、system和service_linked三种类别。 举例:一般CamRoleName中包含“LinkedRoleIn”(如TKE_QCSLinkedRoleInPrometheusService)时,DescribeRoleList和GetRole返回的RoleType为service_linked,则本参数也需要传递service_linked。 该参数默认值为user,若CameRoleName为非service_linked类型,本参数可不传递。
      void setDisableApiTermination​(Boolean DisableApiTermination)
      Set 实例销毁保护标志,表示是否允许通过api接口删除实例。取值范围:
      TRUE:表示开启实例保护,不允许通过api接口删除实例
      FALSE:表示关闭实例保护,允许通过api接口删除实例

      默认取值:FALSE。
      void setHostName​(String HostName)
      Set 实例的主机名。
      点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
      Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
      其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
      注意点:修改主机名后实例会立即重启,重启后新的主机名生效。
      void setInstanceIds​(String[] InstanceIds)
      Set 一个或多个待操作的实例ID。可通过[`DescribeInstances`](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。
      void setInstanceName​(String InstanceName)
      Set 实例名称。可任意命名,但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置
      void setSecurityGroups​(String[] SecurityGroups)
      Set 指定实例的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • ModifyInstancesAttributeRequest

        public ModifyInstancesAttributeRequest()
      • ModifyInstancesAttributeRequest

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

      • getInstanceIds

        public String[] getInstanceIds()
        Get 一个或多个待操作的实例ID。可通过[`DescribeInstances`](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。
        Returns:
        InstanceIds 一个或多个待操作的实例ID。可通过[`DescribeInstances`](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。
      • setInstanceIds

        public void setInstanceIds​(String[] InstanceIds)
        Set 一个或多个待操作的实例ID。可通过[`DescribeInstances`](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。
        Parameters:
        InstanceIds - 一个或多个待操作的实例ID。可通过[`DescribeInstances`](https://cloud.tencent.com/document/api/213/15728) API返回值中的`InstanceId`获取。每次请求允许操作的实例数量上限是100。
      • getInstanceName

        public String getInstanceName()
        Get 实例名称。可任意命名,但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置
        Returns:
        InstanceName 实例名称。可任意命名,但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置
      • setInstanceName

        public void setInstanceName​(String InstanceName)
        Set 实例名称。可任意命名,但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置
        Parameters:
        InstanceName - 实例名称。可任意命名,但不得超过60个字符。 必须指定InstanceName与SecurityGroups的其中一个,但不能同时设置
      • getSecurityGroups

        public String[] getSecurityGroups()
        Get 指定实例的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置
        Returns:
        SecurityGroups 指定实例的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置
      • setSecurityGroups

        public void setSecurityGroups​(String[] SecurityGroups)
        Set 指定实例的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置
        Parameters:
        SecurityGroups - 指定实例的安全组Id列表,子机将重新关联指定列表的安全组,原本关联的安全组会被解绑。必须指定SecurityGroups与InstanceName的其中一个,但不能同时设置
      • getCamRoleName

        public String getCamRoleName()
        Get 给实例绑定用户角色,传空值为解绑操作
        Returns:
        CamRoleName 给实例绑定用户角色,传空值为解绑操作
      • setCamRoleName

        public void setCamRoleName​(String CamRoleName)
        Set 给实例绑定用户角色,传空值为解绑操作
        Parameters:
        CamRoleName - 给实例绑定用户角色,传空值为解绑操作
      • getHostName

        public String getHostName()
        Get 实例的主机名。
      • 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
      • Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
      • 其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
        注意点:修改主机名后实例会立即重启,重启后新的主机名生效。
Returns:
HostName 实例的主机名。
  • 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
  • Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
  • 其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
    注意点:修改主机名后实例会立即重启,重启后新的主机名生效。
  • Parameters:
    HostName - 实例的主机名。
  • 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
  • Windows 实例:主机名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
  • 其他类型(Linux 等)实例:主机名字符长度为[2, 60],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
    注意点:修改主机名后实例会立即重启,重启后新的主机名生效。