ReplaceSystemDisk_云服务器 ECS_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

调用该接口前请您仔细阅读更换系统盘(更换操作系统)

更换系统盘时,您需要注意:

  • 不支持变更系统盘计费方式。

  • 不支持更换系统盘的云盘类型。

  • 系统盘挂载的 ECS 实例不能有未支付的订单。

  • 实例的状态必须为已停止(Stopped)状态。

    说明 仅适用于专有网络 VPC 类型实例。如果 ECS 实例为按量付费计费模式,且开启默认启用节省停机模式,为防止地域范围内的 ECS 实例库存不足,引起的更换系统盘后无法重启实例。您需要在停止该实例时设置为普通停机模式。具体操作,请参见 StopInstance
  • ECS 实例不能被安全锁定,即实例的OperationLocks参数值包含"LockReason": "security"。更多信息,请参见安全锁定时的 API 行为

  • 您可以通过参数SystemDisk.Size重新指定系统盘的容量大小。

更换系统盘后,建议您通过以下任一方式验证是否更换成功:

  • 通过 DescribeDisks 接口查询新系统盘的状态。如果已挂载实例,则表示更换系统盘的操作已完成。

  • 通过 DescribeInstances 接口查询更换系统盘的实例的状态。如果返回值OperationLocks为空,则表示更换系统盘的操作已完成。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
ecs:ReplaceSystemDisk
Update
Disk
acs:ecs:{#regionId}:{#accountId}:disk/{#diskId}
Image
acs:ecs:{#regionId}:{#accountId}:image/{#imageId}
Instance
acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}
ecs:IsDiskEncrypted
ecs:IsSystemDiskEncrypted
ecs:PasswordInherit
ecs:PasswordCustomized
ecs:IsDiskByokEncrypted
ecs:IsSystemDiskByokEncrypted
ecs:LoginAsNonRoot
ecs:ImagePlatform

请求参数

字段名称字段详情
InstanceIdstring

指定实例的 ID。展开详情

示例值:i-bp67acfmxazb4ph****参考取值来源:
    RunInstances
    StopInstances
    StartInstances
    CreateInstance
    RebootInstances
    DescribeInstances
    ModifyManagedInstance
    RenewReservedInstances
    AttachInstanceRamRole
    DetachInstanceRamRole
    DeregisterManagedInstance
    PurchaseReservedInstancesOffering
ImageIdstring

重置系统时使用的镜像 ID。展开详情

示例值:m-bp67acfmxazb4ph****参考取值来源:
    ImportImage
    CopyImage
    CreateImage
    ExportImage
    DescribeImages
SystemDisk.Sizeinteger<int32>

新的系统盘容量,单位为 GiB。取值范围:展开详情

示例值:80
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。更多信息,请参见如何保证幂等性

示例值:123e4567-e89b-12d3-a456-426655440000
UseAdditionalServiceboolean

是否使用阿里云提供的虚拟机系统配置(Windows:NTP、KMS;Linux:NTP、YUM)。展开详情

示例值:true
Passwordstring

是否重置 ECS 实例的用户名密码。长度为 8 至 30 个字符,必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是:展开详情

示例值:EcsV587!
PasswordInheritboolean

是否使用镜像预设的密码。展开详情

示例值:false
KeyPairNamestring

密钥对名称。 展开详情

示例值:testKeyPairName参考取值来源:
    DetachKeyPair
    CreateKeyPair
    ImportKeyPair
    AttachKeyPair
    DescribeKeyPairs
DiskIdstring
说明 该参数已废弃,为提高兼容性,建议您使用 ImageId
示例值:d-bp67acfmxazb4ph****参考取值来源:
    CreateDisk
    DescribeDisks
Platformstring
说明 已弃用。
示例值:CentOS
Architecturestring
说明 已弃用。
示例值:i386
SecurityEnhancementStrategystring

更换系统盘后,是否免费使用云安全中心服务。取值范围: 展开详情

示例值:Active
Encryptedboolean

是否加密云盘。取值范围:展开详情

示例值:false
KMSKeyIdstring

系统盘对应的 KMS 密钥 ID。

示例值:e522b26d-abf6-4e0d-b5da-04b7******3c参考取值来源:
    DescribeDiskDefaultKMSKeyId
字符长度 <= 64
EncryptAlgorithmstring
说明 该参数暂未开放使用。
示例值:hide
Arnarray<object>

该参数暂未开放使用。

子级条数 <= 10

返回参数

字段名称字段详情
DiskIdstring

新系统盘的云盘 ID。

示例值:d-bp67acfmxazb4ph****
RequestIdstring

请求 ID。

示例值:473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

返回示例

错误返回示例

变更历史

暂无变更历史

相关示例