InquiryPriceResizeInstanceDisks

Last updated: 2020-09-17 17:54:16

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.

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: cvm.ap-shanghai-fsi.tencentcloudapi.com

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 parameter. The value used for this API: InquiryPriceResizeInstanceDisks.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. 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 The configuration of data disks to be expanded. 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. Data disk capacity unit: GB; minimum increment: 10 GB. For more information about selecting a data disk type, see the product overview on cloud disks. Available data disk types are subject to the instance type (InstanceType). In addition, the maximum capacity allowed for expansion varies by data disk type.
ForceStop No Boolean Whether to force shut down a running instances. It is recommended to manually shut down a running instance before resetting the user password. Valid values:
  • TRUE: force shut down an instance after a normal shutdown fails.
  • FALSE: do not force shut down an instance after a normal shutdown fails.

    Default value: FALSE.

    A forced shutdown is similar to switching off the power of a physical computer. It may cause data loss or file system corruption. Be sure to only force shut down a CVM when it 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, which is returned for each request. 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

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=InquiryPriceResizeInstanceDisks
    &InstanceId=ins-fd8spnmq
    &DataDisks.0.DiskSize=100
    &<common request parameters>

    Output Example

    {
      "Response": {
        "Price": {
          "InstancePrice": {
            "UnitPrice": 0.46,
            "ChargeUnit": "HOUR"
          }
        },
        "RequestId": "d63b4f53-335b-49fb-9aa1-1716bb9276f6"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    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
    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 Invalid parameter value: parameter value is in the wrong format or is not supported.
    MissingParameter Missing parameter: a required parameter is missing.
    ResourceInsufficient.CloudDiskUnavailable The parameters of cloud disk do not meet the specification.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help