InquiryPriceResetInstance

Last updated: 2019-12-05 20:00:33

PDF

1. API Description

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

This API is used to query the price for reinstalling an instance.

  • If you have specified the ImageId parameter, the price query is performed with the specified image. Otherwise, the image used by the current instance is used.
  • You can only query the price for reinstallation caused by switching between Linux and Windows OS. And the system disk type of the instance must be CLOUD_BASIC, CLOUD_PREMIUM, or CLOUD_SSD.
  • Currently, this API only supports instances in Mainland China regions.

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

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: InquiryPriceResetInstance
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.
ImageId No String Image ID in the format of img-xxx. There are four types of images:
  • Public images
  • Custom images
  • Shared images
  • Marketplace images

  • You can obtain the available image IDs in the following ways:
  • For IDs of public images, custom images, and shared images, log in to the console to query the information; for IDs of marketplace images, go to Cloud Marketplace.
  • Call DescribeImages and look for ImageId in the response.
  • SystemDisk No SystemDisk Configuration of the system disk of the instance. For instances with a cloud disk as the system disk, you can expand the system disk by using this parameter to specify the new capacity after reinstallation. If the parameter is not specified, the system disk capacity remains unchanged by default. You can only expand the capacity of the system disk; reducing its capacity is not supported. When reinstalling the system, you can only modify the capacity of the system disk, not the type.
    LoginSettings No LoginSettings Login settings of the instance. You can use this parameter to set the login method, password, and key of the instance or keep the login settings of the original image. By default, a random password will be generated and sent to you via the Message Center.
    EnhancedService No EnhancedService Enhanced services. You can use this parameter to specify whether to enable services such as Cloud Monitor and Cloud Security. If this parameter is not specified, Cloud Monitor and Cloud Security will be enabled by default.

    3. Output Parameters

    Parameter Name Type Description
    Price Price Price of reinstalling the instance with the specified configuration.
    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 of a pay-as-you-go instance with a new configuration

    Input Example

    GET https://cvm.tencentcloudapi.com/?Action=InquiryPriceResetInstancesType
    &InstanceId=ins-fd8spnmq
    InternetAccessible.InternetMaxBandwidthOut=20
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "Price": {
          "InstancePrice": {
            "UnitPrice": 0.66,
            "ChargeUnit": "HOUR"
          }
        },
        "RequestId": "56d68b92-7004-4716-b3bf-3c2c231035c9"
      }
    }

    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.

    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.
    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.