有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
说明:

当前页面接口为旧版 API,未来可能停止维护,目前不展示在左侧导航。云服务器 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 云服务器 API 3.0

1. 接口描述

本接口 (InquiryPriceResetInstance) 用于重装实例询价。
接口请求域名:cvm.api.qcloud.com

  • 如果指定了ImageId参数,则使用指定的镜像进行重装询价;否则按照当前实例使用的镜像进行重装询价。
  • 目前只支持系统盘类型是CLOUD_BASICCLOUD_PREMIUMCLOUD_SSD类型的实例使用该接口实现LinuxWindows操作系统切换的重装询价。
  • 目前不支持境外地域的实例使用该接口实现LinuxWindows操作系统切换的重装询价。

2. 输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数

参数名称 类型 是否必选 描述
Version String 表示 API 版本号,主要用于标识请求的不同API 版本。 本接口第一版本可传:2017-03-12。
InstanceId String 实例 ID。可通过 DescribeInstances API 返回值中的InstanceId获取。
ImageId String 指定有效的 镜像 ID,格式形如img-xxx。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像 ID:
  • 公共镜像自定义镜像共享镜像的镜像 ID 可通过登录 控制台 查询;服务镜像市场的镜像 ID 可通过 云市场 查询。
  • 通过调用接口 DescribeImages,取返回信息中的ImageId字段。
  • SystemDisk SystemDisk object 实例系统盘配置信息。系统盘为云盘的实例可以通过该参数指定重装后的系统盘大小来实现对系统盘的扩容操作,若不指定则默认系统盘大小保持不变。系统盘大小只支持扩容不支持缩容;重装只支持修改系统盘的大小,不能修改系统盘的类型。
    LoginSettings LoginSettings object 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
    EnhancedService EnhancedService object 增强服务。通过该参数可以指定是否开启云安全、腾讯云可观测平台等服务。若不指定该参数,则默认开启腾讯云可观测平台、云安全服务。

    3. 输出参数

    参数名称 类型 描述
    Price Price object 该参数表示重装成对应配置实例的价格。
    RequestId String 唯一请求ID。每次请求都会返回RequestId。当用户调用接口失败找后台研发人员处理时需提供该RequestId

    4. 错误码

    以下错误码表仅列出了该接口的业务逻辑错误码,更多错误码详见 公共错误码

    错误码 描述
    MissingParameter 参数缺失。请求没有带必选参数。
    InvalidInstanceId.NotFound 无效实例ID。指定的实例ID不存在。
    InvalidInstanceId.Malformed 无效实例ID。指定的实例ID格式错误。例如实例ID长度错误ins-1122
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    InvalidInstance.NotSupported 实例不支持该操作。
    InternalServerError 操作内部错误。

    5. 示例

    示例1

    包年包月实例重装系统询价:

    请求参数

    https://cvm.api.qcloud.com/v2/index.php?Action=InquiryPriceResetInstance
    &Version=2017-03-12
    &InstanceId=ins-2zvpghhc
    &SystemDisk.DiskSize=50
    &<公共请求参数>
    

    返回参数

    {
        "Response": {
            "Price": {
                "OriginalPrice": "9.46",
                "DiscountPrice": "9.46"
            },
            "RequestId": "c2d86443-dcb7-4279-a06d-5b3b700451d4"
        }
    }
    

    示例2

    按量付费实例重装系统询价:

    请求参数

    https://cvm.api.qcloud.com/v2/index.php?Action=InquiryPriceResetInstance
    &Version=2017-03-12
    &InstanceId=ins-fd8spnmq
    &SystemDisk.DiskSize=50
    &<公共请求参数>
    

    返回参数

    {
        "Response": {
            "Price": {
                "InstancePrice": {
                    "UnitPrice": 0.43,
                    "ChargeUnit": "HOUR"
                }
            },
            "RequestId": "2cc6136b-12f4-4632-bba4-386d7b76abec"
        }
    }