You need to enable JavaScript to run this app.
导航

ModifyInstancePlacement

最近更新时间2024.02.27 14:17:41

首次发布时间2023.09.08 16:31:01

调用 ModifyInstancePlacement 接口在专有宿主机之间迁移实例。

接口说明

  • 目标专有宿主机与待迁移的实例属于同一账号、同一地域和可用区。
  • 待迁移的实例需处于“已停止”状态,请先调用StopInstances接口停止实例。
  • 调用该接口时,如不传入可选参数,则保持原有配置。

请求参数

名称
类型是否必填
示例值
描述
ActionStringModifyInstancePlacement要执行的操作,取值:ModifyInstancePlacement。
VersionString2020-04-01API的版本,取值:2020-04-01。
InstanceIdStringi-ycjls76kfam0tptz****待迁移的实例ID。

Affinity

String

Host

针对节省停机模式的ECS实例,停止后会释放部分资源,本参数用于选择ECS实例重新启动时是否仍固定部署在原宿主机上。取值:

  • Host:启用节省停机模式的实例重新启动时,仍会部署在原宿主机上。

  • Default(默认):启用节省停机模式的实例重新启动时,会优先迁移到支持自动部署的宿主机;若支持自动部署的宿主机资源不足,则在原宿主机上进行启动。

DedicatedHostId

String

dh-ycje2rquioh9l3bn****

目标专有宿主机ID,可以调用DescribeDedicatedHosts接口查看可以使用的专有宿主机。

  • 若将实例迁移至指定专有宿主机上,必须传入该参数。

  • 若将实例迁移至系统自动部署资源池中的专有宿主机上,必须将该参数设置为空,并设置Affinity为Host。自动部署功能请参见功能特性

MigrationType

String

ColdMigration

指定调整宿主机部署的实例迁移方式,取值:

  • LiveMigration:热迁移,即不停机迁移,待迁移的实例需处于“已停止”状态;同时支持更改实例规格。

  • ColdMigration:冷迁移,即停机迁移,不支持更改实例规格。

InstanceTypeId

String

ecs.ddhr2s.define.c4m16

ECS实例要变更的目标实例规格。
调整实例宿主机时,可同时变更实例规格。目标规格必须与指定专有宿主机的规格相匹配。

  • 变更实例规格时,必须指定专有宿主机ID,即设置参数DedicatedHostId的值。

  • 使用热迁移方式迁移ECS实例时,不能变更实例规格。

Tenancy

String

Host

实例是否在专有宿主机上部署。取值

  • Host:仅支持实例在专有宿主机上部署。

DryRun

Boolean

false

是否只预检此次请求。取值:

  • true:发送检查请求,不会调整实例的宿主机部署。检查项包括是否填写了必需参数、请求格式、业务限制和ECS库存。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation

  • false(默认):发送正常请求,通过检查后直接调整实例的宿主机部署。

ClientToken

String

23fa21A8823nfasd7f****

保证请求幂等性。由客户端自动生成一个参数值,确保不同请求间该参数值唯一,避免当调用API超时或服务器内部错误时,客户端多次重试导致重复性操作。
取值:仅支持ASCII字符,且不能超过64个字符。

返回数据

操作接口仅返回公共参数及错误码。

请求示例

GET /?Action=ModifyInstancePlacement&Version=2020-04-01&DedicatedHostId=dh-ycje2rquioh9l3bn****&InstanceId=i-ycjls76kfam0tptz**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202307171626144175A80ADCCEEBB8****",
        "Action": "ModifyInstancePlacement",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {}
}

错误码

HttpCode错误码错误信息描述
400MissingParameter.AffinityThe required parameter Affinity is not supplied.参数Affinity不能为空。
400InvalidInstanceHostStatusThe specified instance host is not in the correct status for the request.当前宿主机的状态不支持此操作。
400InvalidInstanceStatusThe status of the specified instance does not support this request.当前实例的状态不支持此操作。
400InvalidPlacementAffinity.MalformedThe specified placement affinity is malformed.指定的Placement.Affinity不合法。

400

InvalidStoppedModeForMigrateInstance.Unsupported

The specified StoppedMode instance does not support migration.

指定的停机模式不支持迁移。

400MissingParameter.InstanceIdThe required parameter InstanceId is not supplied.实例ID不能为空。
400InvalidInstanceTypeForLiveMigration.UnsupportedThe specified InstanceType does not support live migration.指定的实例规格不支持热迁移。
400InvalidDedicatedHostForMigrate.UnsupportedThe specified dedicated host does not support migrate.指定的专有物理机不支持迁移操作。
400InvalidArgumentThe specified argument is invalid.指定的参数不合法。
400InvalidClientToken.MalformedThe specified ClientToken is malformed.指定的ClientToken不合法。
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.幂等参数不一致。
400OperationDenied.InstanceTempUnSupportedLiveMigrationThe specified instance does not currently support live migration.指定的实例暂时不支持热迁移。
404InvalidDedicatedHost.NotFoundThe specified dedicated host does not exist.指定的专有宿主机不存在。

404

InvalidInstance.NotFound

The specified instance does not exist.

指定的实例不存在。

404InvalidInstanceType.NotFoundThe specified InstanceType does not exist.指定的实例规格不存在。
412IdempotentProcessingThe request uses the same client token as a previous one that is still in process.先前的幂等请求仍在处理中,请稍后重试。
412DryRunOperationYour request has been validated by the DryRunOperation.通过“DryRun”校验,您的请求已通过验证。
500Insufficient.InstanceCapacityThere is not enough capacity to fulfill your request.当前资源不足,请稍后重试或选择其它实例规格。
500InternalErrorAn internal error has occurred.内部错误,请重试。如果多次尝试失败,请提交工单。