ModifyInstanceDeployment - 修改实例部署集

调用ModifyInstanceDeployment修改ECS实例的部署集,或迁移ECS实例至专有宿主机。支持在迁移ECS实例的同时变更实例规格。

接口说明

迁移 ECS 实例至专有宿主机,或在迁移实例同时变更 ECS 实例规格时,必须满足以下条件:

  • ECS 实例必须处于已停止(Stopped)状态,迁移后实例自动重启。
  • 只支持专有网络 VPC 类型的 ECS 实例。
  • ECS 实例与专有宿主机必须属于同一账号、同一地域和可用区。
  • 按量付费 ECS 实例可以迁移到包年包月专有宿主机上。包年包月 ECS 实例只能在包年包月专有宿主机之间迁移,且实例到期时间不能超过目标专有宿主机的到期时间。
  • 将 ECS 实例从共享宿主机迁移至专有宿主机时,实例的计费方式只能是按量付费,不支持包年包月实例和抢占式实例。
  • ECS 实例可以指定专有宿主机集群重新部署。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ecs:ModifyInstanceDeploymentupdate
*DedicatedHost
acs:ecs:{#regionId}:{#accountId}:ddh/{#ddhId}
*Instance
acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

请求参数

名称类型必填描述示例值
RegionIdstring

实例所在的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
InstanceIdstring

实例 ID。

i-bp67acfmxazb4ph***
DedicatedHostIdstring

专有宿主机 ID。调用 DescribeDedicatedHosts 查看可以使用的专有宿主机。

修改 ECS 实例宿主机(即将 ECS 实例从共享宿主机迁移至专有宿主机,或在不同专有宿主机间迁移 ECS 实例)时:

  • 若将实例迁移至指定专有宿主机上,必须设置该参数。
  • 若将实例迁移至系统自动为您选择的专有宿主机上,必须将该参数设置为空,并将参数Tenancy设置为 host。

自动部署功能详情,请参见专有宿主机功能特性

dh-bp67acfmxazb4ph****
DeploymentSetIdstring

部署集 ID。

将 ECS 实例加入一个部署集,或调整 ECS 实例的部署集时,该参数为必填参数。

说明 修改专有宿主机的相关参数(TenancyAffinityDedicatedHostId)时,不可同时修改部署集。
ds-bp67acfmxazb4ph****
DeploymentSetGroupNointeger

当 ECS 实例要加入或调整的部署集策略为部署集组高可用策略(AvailabilityGroup)时,可以通过该参数指定实例在部署集中的分组号。取值范围:1~7。

说明 如果您为 ECS 实例调整部署集,且部署集策略为部署集组高可用策略(AvailablilityGroup),当不指定该参数时,系统会自动在各组之间均衡分配 ECS 实例。如果您为 ECS 实例指定的仍是当前实例所属的部署集,系统也会重新在各组之间均衡分配 ECS 实例。
3
Forceboolean

实例在调整部署集时,是否强制更换实例宿主机。取值范围:

  • true:允许。允许重启运行中(Running)、已停止(Stopped)状态的 ECS 实例。已停止状态的实例不包括启用节省停机模式的按量付费 ECS 实例。

    说明 如果您指定的 ECS 实例搭载了本地盘,则本地盘也会允许强制更换,这可能导致在更换宿主机时本地盘数据丢失,请谨慎操作。
  • false:不允许。只在当前宿主机上加入部署集。这可能导致更换部署集失败。

默认值:false。

false
Affinitystring

实例是否与专有宿主机关联。取值范围:

  • host:关联。已启用节省停机模式的实例停机后再次启动时,仍部署在原专有宿主机上。

  • default:不关联。已启用节省停机模式的实例停机后再次启动时,若原专有宿主机资源不足,可迁移至自动部署资源池中的其它专有宿主机上。

实例从共享宿主机迁移至专有宿主机时,默认值为 default。

host
Tenancystring

实例是否在专有宿主机上部署。取值:host,仅支持实例在专有宿主机上部署。

host
MigrationTypestring

是否先停止实例,再迁移到目标专有宿主机。取值范围:

  • reboot:先停止实例再迁移。

  • live:不停止实例,直接迁移。此时,您必须指定参数 DedicatedHostId。该取值不支持在迁移 ECS 实例的同时变更实例规格。

默认值:reboot。

live
InstanceTypestring

ECS 实例要变更的目标实例规格。调用 DescribeInstanceTypes 接口可获取最新实例规格列表。

修改 ECS 实例宿主机时,可同时变更 ECS 实例规格。目标实例规格必须与指定专有宿主机的规格相匹配,详情请参见宿主机规格

  • 变更实例规格时,必须指定专有宿主机 ID,即设置参数DedicatedHostId的值。
  • 使用自动部署功能迁移 ECS 实例时,不能变更实例规格。
ecs.c6.large
DedicatedHostClusterIdstring

专有宿主机集群 ID。

dc-bp67acfmxazb4ph****
RemoveFromDeploymentSetboolean

是否将所选实例移出所选部署集。取值范围:

  • true:是。

  • false:否。

默认值:false。

说明 当该参数为 true 时,必须指定具有所属关系的 InstanceId 和 DeploymentSetId。
false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

04F0F334-1335-436C-A1D7-6C044FE7****

示例

正常返回示例

JSON格式

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE7****"
}

错误码

HTTP status code错误码错误信息描述
400OperationDenied.UnstoppedInstanceOperation denied due to unstopped instance.当前操作无效,请确认实例是否已停止。
400InvalidDedicatedHostStatus.NotSupportOperation denied due to dedicated host status.专有宿主机当前的状态不支持此操作。
400InvalidPeriod.ExceededDedicatedHostInstance expired date can't exceed dedicated host expired date.-
400NoAvaliableDedicatedHostThere's no enough resource on the specified dedicated host.指定的专属主机上没有足够的资源
400OperationDenied.LocalDiskInstanceOperation denied due to instance has local disk.-
400NoAvaliableDedicatedHostThere's no enough dedicated host resource.没有可用资源的专有宿主机
400InvalidParameter.ParamRequested param is invalid.-
400InvalidParam.TenancyThe specified Tenancy is invalid.您指定的参数 Tenancy 无效。
400InvalidParam.DedicatedHostIdThe specified dedicated host id is the same with present host id!-
400InvalidDedicatedHost.NotEnoughResourceThere's no available dedicated host to perform the operation.-
400OperationDenied.InvalidInstanceThe specified instance is not dedicated instance.指定的实例不是部署在专有宿主机的实例。
400ChargeTypeViolation.PostPaidDedicatedHostPrepaid instance onto postpaid dedicated host is not allowed.包年包月的实例无法添加到按量付费的专有宿主机上。
400OperationDenied.NotSupportEcs on dedicatedHost has been migrated.-
400InvalidDedicatedHostId.NotFoundThe specified DedicatedHostId does not exist.指定的专有宿主机不存在。
400InvalidParam.DedicatedHostIdParameter dedicated host id must been provided in such operation.-
400OperationDenied.CannotPerformLive migration cannot be performed.热迁移无法执行。
400InvalidInstanceType.ValueNotSupportedThe specified InstanceType does not exist or beyond the permitted range.您指定的实例规格不存在,或者您没有权限操作此规格的实例。
400InvalidParameter.TenancyThe specified Tenancy is invalid.-
400InvalidParameter.AffinityThe specified Affinity is invalid.-
400InvalidInstanceType.NotSupportThe parameter EcsMigrationType conflict with InstanceType, live migration do not support InstanceType alter on ddh.-
400InvalidParam.InstanceIdThe specified InstanceId should be on dedicatedHost.所指定的实例应处于专有宿主机上
400InvalidDedicatedHostClusterId.NotFoundThe specified DedicatedHostClusterId does not exist.-
400InvalidDedicatedHostClusterId.InvalidThe specified Dedicated Host Cluster is invalid.-
400InvalidDestinationZone.DeploymentSetMismatchError happened, %s.如果实例加入的部署集是Lowlatency策略,且此部署集已有实例加入,此实例必须在已有实例所在可用区
403IncorrectInstanceStatus%s当前实例的状态不支持此操作。
403OperationDenied.NoStockThe resource is out of usage.该实例不在运行状态,请您启动实例或检查操作是否合理。
403InvalidDeploymentSetId.NoAvailableResourcesThere are no available resources for the specified deployment, you can set the parameter force to true to retry, or wait for additional resource to become available.没有足够的资源进行此部署,可以将参数force设置为true或者等待更多资源变为可用状态。
404InvalidDeploymentSetId.NotFoundThe specified deployment set does not exist.-
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的InstanceId不存在。
404InvalidInstanceNetworkType.NotSupportThe specified Instance network type not support.当前实例的网络类型不支持此操作。
404InvalidInstanceChargeType.NotSupportThe Dedicated host not support the specified instance charge type.此专有宿主机不支持指定的付费类型的实例。
404InvalidInstanceType.NotSupportThe Dedicated host not support the specified instance type.当前宿主机不支持指定的实例规格。
404InvalidParameter.DeploymentSetGroupNoParameter DeploymentSetGroupNo is invalid.-
404InvalidDedicatedHostId.NotSupportCannot choose instance present host as destination host.-
404InvalidDedicatedHost.NotFoundNo available host.-
404InvalidDedicatedHost.ZoneNotMatchThe specify dedicated host zone location not match the instance zone location.-
404InvalidOperation.NotSupportThe specified DedicatedHost operation not supported on MPS.-

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-01-30OpenAPI 错误码发生变更查看变更详情
2023-06-20OpenAPI 错误码发生变更查看变更详情
2022-06-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情