tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ResizeInstanceDisks

Last updated: 2024-10-22 19:33:00

    1. API Description

    Domain name for API request: cvm.tencentcloudapi.com.

    This API (ResizeInstanceDisks) is used to expand the data disks of an instance.

    • Currently, you can only use the API to expand non-elastic data disks whose disk type is CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD. You can use DescribeDisks to check whether a disk is elastic. If the Portable field in the response is false, it means that the disk is non-elastic.
    • Currently, this API does not support CDH instances.
    • Currently, only one data disk can be expanded at a time.

    A maximum of 10 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: ResizeInstanceDisks.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID. To obtain the instance IDs, you can call DescribeInstances and look for InstanceId in the response.
    DataDisks.N No Array of DataDisk Configuration information of a data disk to be expanded. Only inelastic data disks (with Portable being false in the return values of DescribeDisks) can be expanded. The unit of data disk capacity is GB. The minimum expansion step is 10 GB. For more information about data disk types, refer to Disk Product Introduction. The available data disk type is restricted by the instance type InstanceType. Additionally, the maximum allowable capacity for expansion varies by data disk type.

    You should specify either DataDisks or SystemDisk, but you cannot specify both at the same time.
    ForceStop No Boolean Whether to forcibly shut down a running instance. It is recommended to manually shut down a running instance first and then reset the user password. Valid values:
  • true: Forcibly shut down an instance after a normal shutdown fails.

  • false: Do not forcibly shut down an instance after a normal shutdown fails.


    • Default value: false.

    Forced shutdown is equivalent to turning off a physical computer's power switch. Forced shutdown may cause data loss or file system corruption and should only be used when a server cannot be shut down normally.
    SystemDisk No SystemDisk Configuration information of a system disk to be expanded. Only cloud disks can be expanded.

    You should specify either DataDisks or SystemDisk, but you cannot specify both at the same time.
    ResizeOnline No Boolean Whether the cloud disk is expanded online.

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Resetting the disk size of a specific instance

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=ResizeInstanceDisks
&InstanceId=ins-r8hr2upy
&DataDisks.0.DiskSize=100
&<Common request parameters>

    Output Example

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

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.InvalidInstanceApplicationRole
    InternalError Internal error.
    InternalError.TradeUnknownError Internal error.
    InternalServerError Internal error.
    InvalidAccount.InsufficientBalance Insufficient account balance.
    InvalidAccount.UnpaidOrder The account has unpaid orders.
    InvalidInstance.NotSupported This instance is not supported.
    InvalidInstanceId.Malformed Invalid instance ID. The specified instance ID has an invalid format. For example, ins-1122 has an invalid ID length.
    InvalidInstanceId.NotFound No instance found.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.CdhOnlyLocalDataDiskResize
    InvalidParameterValue.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
    InvalidParameterValue.ZoneNotSupported The availability zone does not support this operation.
    MissingParameter Missing parameter.
    MissingParameter.AtLeastOne Parameter missing. Provide at least one parameter.
    OperationDenied.InstanceOperationInProgress The instance has an operation in progress. Please try again later.
    UnsupportedOperation.InstanceChargeType This instance billing mode does not support the operation.
    UnsupportedOperation.InstanceStateBanning This CVM is blocked. Please submit a ticket.
    UnsupportedOperation.InstanceStateCorrupted The instances are permanently corrupted, and this operation is not supported.
    UnsupportedOperation.InstanceStateEnterServiceLiveMigrate The instance ins-xxxxxx in the ENTER_SERVICE_LIVE_MIGRATE status is not supported.
    UnsupportedOperation.InstanceStateExitRescueMode Instances are exiting from the rescue mode, and this operation is not supported.
    UnsupportedOperation.InstanceStateFreezing The operation is not supported for the frozen instances.
    UnsupportedOperation.InstanceStatePending The instances are being created, and this operation is not supported.
    UnsupportedOperation.InstanceStateRebooting The instances are being restarted, and this operation is not supported.
    UnsupportedOperation.InstanceStateRescueMode Instances in the rescue mode are not available for this operation.
    UnsupportedOperation.InstanceStateRunning Running instances do not support this operation.
    UnsupportedOperation.InstanceStateServiceLiveMigrate The instances are being migrated, and this operation is not supported.
    UnsupportedOperation.InstanceStateShutdown Isolated instances do not support this operation.
    UnsupportedOperation.InstanceStateStarting The instance is starting up, and this operation is not supported.
    UnsupportedOperation.InstanceStateStopped The instance has been shut down, and this operation is not supported.
    UnsupportedOperation.InstanceStateStopping The instance is being shut down, and this operation is not supported.
    UnsupportedOperation.InstanceStateTerminating The instance is being terminated, and the operation is not supported.
    UnsupportedOperation.InvalidDataDisk Adjusting the data disk is not supported.
    UnsupportedOperation.SpecialInstanceType This special instance type does not support the operation.
    UnsupportedOperation.StoppedModeStopCharging The instance does not support the no charges when shut down feature.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy