扩容实例磁盘

最近更新时间:2024-03-12 01:19:21

我的收藏

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口 (ResizeInstanceDisks) 用于扩容实例的磁盘。

  • 目前只支持扩容非弹性盘( DescribeDisks 接口返回值中的Portablefalse表示非弹性)。
  • 对于包年包月实例,使用该接口会涉及扣费,请确保账户余额充足。可通过 DescribeAccountBalance 接口查询账户余额。
  • 目前只支持扩容一块数据盘。
  • 默认扩容方式为关机后扩容。
  • 实例操作结果可以通过调用 DescribeInstances 接口查询,如果实例的最新操作状态(LatestOperationState)为“SUCCESS”,则代表操作成功。
  • 如果是系统盘,目前只支持扩容,不支持缩容。

默认接口请求频率限制:10次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ResizeInstanceDisks。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。
示例值:ins-r8hr2upy
DataDisks.N Array of DataDisk 待扩容的数据盘配置信息。只支持扩容非弹性数据盘(DescribeDisks接口返回值中的Portablefalse表示非弹性)。数据盘容量单位:GB。最小扩容步长:10G。关于数据盘类型的选择请参考硬盘产品简介。可选数据盘类型受到实例类型InstanceType限制。另外允许扩容的最大容量也因数据盘类型的不同而有所差异。
说明

您必须指定参数DataDisks与SystemDisk的其中一个,但不能同时指定。

ForceStop Boolean 是否对运行中的实例选择强制关机。建议对运行中的实例先手动关机,然后再重置用户密码。取值范围:
  • true:表示在正常关机失败后进行强制关机

  • false:表示在正常关机失败后不进行强制关机


  • 默认取值:false。

    强制关机的效果等同于关闭物理计算机的电源开关。强制关机可能会导致数据丢失或文件系统损坏,请仅在服务器不能正常关机时使用。
    示例值:true
    SystemDisk SystemDisk 待扩容的系统盘配置信息。只支持扩容云盘。
    说明

    您必须指定参数DataDisks与SystemDisk的其中一个,但不能同时指定。

    ResizeOnline Boolean 扩容云盘的方式是否为在线扩容。
    示例值:true

    3. 输出参数

    参数名称 类型 描述
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 重置一块指定id的磁盘大小

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=ResizeInstanceDisks
    &InstanceId=ins-r8hr2upy
    &DataDisks.0.DiskSize=100
    &<公共请求参数>

    输出示例

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

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation.InvalidInstanceApplicationRole 不支持操作的applicationRole实例
    InternalError 内部错误。
    InternalError.TradeUnknownError 内部错误
    InternalServerError 操作内部错误。
    InvalidAccount.InsufficientBalance 账户余额不足。
    InvalidAccount.UnpaidOrder 账户有未支付订单。
    InvalidInstance.NotSupported 不被支持的实例。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidInstanceId.NotFound 没有找到相应实例。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.CdhOnlyLocalDataDiskResize CDH磁盘扩容只支持LOCAL_BASIC和LOCAL_SSD。
    InvalidParameterValue.InstanceIdMalformed 实例ID不合要求,请提供规范的实例ID,类似ins-xxxxxxxx,字母x代表小写字符或数字。
    InvalidParameterValue.ZoneNotSupported 请求不支持该可用区
    MissingParameter 缺少参数错误。
    MissingParameter.AtLeastOne 缺少必要参数,请至少提供一个参数。
    OperationDenied.InstanceOperationInProgress 实例正在执行其他操作,请稍后再试。
    UnsupportedOperation.InstanceChargeType 请求不支持该实例计费模式
    UnsupportedOperation.InstanceStateBanning 该子机处于封禁状态,请联系相关人员处理。
    UnsupportedOperation.InstanceStateCorrupted 请求不支持永久故障的实例。
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate 不支持状态为 ENTER_SERVICE_LIVE_MIGRATE.的实例 ins-xxxxxx
    UnsupportedOperation.InstanceStateExitRescueMode 请求不支持正在退出救援模式的实例
    UnsupportedOperation.InstanceStateFreezing 操作不支持已冻结的实例。
    UnsupportedOperation.InstanceStatePending 请求不支持创建未完成的实例
    UnsupportedOperation.InstanceStateRebooting 请求不支持正在重启的实例
    UnsupportedOperation.InstanceStateRescueMode 请求不支持救援模式的实例
    UnsupportedOperation.InstanceStateRunning 请求不支持开机状态的实例
    UnsupportedOperation.InstanceStateServiceLiveMigrate 不支持正在服务迁移的实例,请稍后再试
    UnsupportedOperation.InstanceStateShutdown 请求不支持隔离状态的实例
    UnsupportedOperation.InstanceStateStarting 实例开机中,不允许该操作。
    UnsupportedOperation.InstanceStateStopped 请求不支持已关机的实例
    UnsupportedOperation.InstanceStateStopping 请求不支持正在关机的实例
    UnsupportedOperation.InstanceStateTerminating 请求不支持正在销毁的实例
    UnsupportedOperation.InvalidDataDisk 不支持调整数据盘。
    UnsupportedOperation.SpecialInstanceType 请求不支持特殊机型的实例
    UnsupportedOperation.StoppedModeStopCharging 不支持关机不收费特性