操作指南

最佳实践

运维指南

故障处理

API 文档

扩容实例磁盘

最近更新时间:2019-10-08 14:59:22

说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

本接口 (ResizeInstanceDisks) 用于扩容实例的数据盘。
接口请求域名:cvm.api.qcloud.com

  • 目前只支持扩容随实例购买的数据盘,且数据盘类型为:CLOUD_BASICCLOUD_PREMIUMCLOUD_SSD
  • 目前不支持 CDH 实例使用该接口扩容数据盘。
  • 对于包年包月实例,使用该接口会涉及扣费,请确保账户余额充足。可通过 DescribeAccountBalance 接口查询账户余额。
  • 目前只支持扩容一块数据盘。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数 页面。

名称 类型 是否必选 描述
Version String 表示API版本号,主要用于标识请求的不同API版本。 本接口第一版本可传:2017-03-12。
InstanceId String 待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。
DataDisks.N array of DataDisk objects 待扩容的数据盘配置信息。只支持扩容随实例购买的数据盘,且数据盘类型为:CLOUD_BASICCLOUD_PREMIUMCLOUD_SSD。数据盘容量单位:GB。最小扩容步长:10G。关于数据盘类型的选择请参考硬盘产品简介。可选数据盘类型受到实例类型InstanceType限制。另外允许扩容的最大容量也因数据盘类型的不同而有所差异。
ForceStop Boolean 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机,然后再重置用户密码。取值范围:
  • TRUE:表示在正常关机失败后进行强制关机
  • FALSE:表示在正常关机失败后不进行强制关机

    默认取值:FALSE。

  • 强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求ID。每次请求都会返回一个唯一的requestId,当客户调用接口失败找后台研发人员处理时需提供该requestId具体值。

    4. 错误码

    以下错误码表仅列出了该接口的业务逻辑错误码,更多错误码详见 公共错误码

    错误码 描述
    MissingParameter 参数缺失。请求没有带必选参数。
    InvalidInstanceId.NotFound 无效实例ID。指定的实例ID不存在。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如ID长度错误ins-1122
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidInstance.NotSupported 实例不支持该操作。
    InvalidAccount.InsufficientBalance 账户余额不足。
    InvalidAccount.UnpaidOrder 账户有未支付订单。
    InternalServerError 操作内部错误。

    5. 示例

    输入

    https://cvm.api.qcloud.com/v2/index.php?Action=ResizeInstanceDisks
    &Version=2017-03-12
    &InstanceId=ins-r8hr2upy
    &DataDisks.0.DiskSize=100
    &<公共请求参数>
    

    输出

    {
        "Response": {
            "RequestId": "d39d6c09-44e9-4e80-8661-77b5ff3cbc15"
        }
    }
    
    目录