tencent cloud

Feedback

InquiryPriceResizeInstanceDisks

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

    1. API Description

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

    This API is used to query the price for expanding data disks of an instance.

    • Currently, you can only use this API to query the price of 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, you cannot use this API to query the price for CDH instances. *Also, you can only query the price of expanding one data disk 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: InquiryPriceResizeInstanceDisks.
    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.

    3. Output Parameters

    Parameter Name Type Description
    Price Price Price of the disks after being expanded to the specified configurations
    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 Querying the price for expanding the disk capacity of a pay-as-you-go instance

    This example shows you how to query the price for expanding the disk capacity of a pay-as-you-go instance.

    Input Example

    POST / HTTP/1.1
    Host: cvm.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: InquiryPriceResizeInstanceDisks
    <Common request parameters>
    
    {
        "InstanceId": "ins-fd8spnmq",
        "DataDisks": [
            {
                "DiskSize": "100"
            }
        ]
    }
    

    Output Example

    {
        "Response": {
            "Price": {
                "InstancePrice": {
                    "DiscountPrice": 0.0,
                    "OriginalPriceThreeYear": 0.0,
                    "DiscountOneYear": 0.0,
                    "UnitPrice": 0.46,
                    "UnitPriceThirdStep": 0.0,
                    "OriginalPriceFiveYear": 0.0,
                    "Discount": 0.0,
                    "DiscountFiveYear": 0.0,
                    "UnitPriceDiscountThirdStep": 0.0,
                    "UnitPriceSecondStep": 0.0,
                    "OriginalPrice": 0.0,
                    "DiscountThreeYear": 0.0,
                    "UnitPriceDiscountSecondStep": 0.0,
                    "UnitPriceDiscount": 0.0,
                    "DiscountPriceFiveYear": 0.0,
                    "OriginalPriceOneYear": 0.0,
                    "ChargeUnit": "HOUR",
                    "DiscountPriceThreeYear": 0.0,
                    "DiscountPriceOneYear": 0.0
                },
                "BandwidthPrice": {
                    "DiscountPrice": 0.0,
                    "OriginalPriceThreeYear": 0.0,
                    "DiscountOneYear": 0.0,
                    "UnitPrice": 0.0,
                    "UnitPriceThirdStep": 0.0,
                    "OriginalPriceFiveYear": 0.0,
                    "Discount": 0.0,
                    "DiscountFiveYear": 0.0,
                    "UnitPriceDiscountThirdStep": 0.0,
                    "UnitPriceSecondStep": 0.0,
                    "OriginalPrice": 0.0,
                    "DiscountThreeYear": 0.0,
                    "UnitPriceDiscountSecondStep": 0.0,
                    "UnitPriceDiscount": 0.0,
                    "DiscountPriceFiveYear": 0.0,
                    "OriginalPriceOneYear": 0.0,
                    "ChargeUnit": "HOUR",
                    "DiscountPriceThreeYear": 0.0,
                    "DiscountPriceOneYear": 0.0
                }
            },
            "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
        }
    }
    

    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
    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.InstanceIdMalformed Invalid instance ID. Please enter a valid ID, such as ins-xxxxxxxx (“x” represents a lower-case letter or a number).
    InvalidParameterValue.SnapshotIdMalformed Invalid snapshot ID. Provide a snapshot ID in the format of snap-xxxxxxxx, where the letter x refers to lowercase letter or number.
    InvalidParameterValue.ZoneNotSupported The availability zone does not support this operation.
    MissingParameter Missing parameter.
    MissingParameter.AtLeastOne Parameter missing. Provide at least one parameter.
    ResourceInsufficient.CloudDiskUnavailable The parameters of cloud disk do not meet the specification.
    UnsupportedOperation.InstanceStateCorrupted The instances are permanently corrupted, and this operation is not supported.
    UnsupportedOperation.InstanceStateStopped The instance has been shut down, and this operation is not supported.
    UnsupportedOperation.InvalidDisk The specified disk is not supported.
    UnsupportedOperation.LocalDiskMigratingToCloudDisk The specified disk is converting to a cloud disk. Try again later.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support