当前位置:主页 > 查看内容

云服务器 创建实例询价 - API 文档

发布时间:2021-05-06 00:00| 位朋友查看

简介:1. 接口描述 接口请求域名: cvm.tencentcloudapi.com 。 本接口(InquiryPriceRunInstances)用于创建实例询价。本接口仅允许针对购买限制范围内的实例配置进行询价, 详见:创建实例。 默认接口请求频率限制:10次/秒。 注意:本接口支持金融区地域。由于金融……

1. 接口描述

接口请求域名: cvm.tencentcloudapi.com 。

本接口(InquiryPriceRunInstances)用于创建实例询价。本接口仅允许针对购买限制范围内的实例配置进行询价, 详见:创建实例。

默认接口请求频率限制:10次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:InquiryPriceRunInstances。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表。
Placement Placement 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
ImageId String 指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像ID:
  • 公共镜像自定义镜像共享镜像的镜像ID可通过登录控制台查询;服务镜像市场的镜像ID可通过云市场查询。
  • 通过调用接口 DescribeImages ,取返回信息中的ImageId字段。
  • InstanceChargeType String 实例计费类型。
  • PREPAID:预付费,即包年包月
  • POSTPAID_BY_HOUR:按小时后付费
  • SPOTPAID:竞价付费
    默认值:POSTPAID_BY_HOUR。
  • InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
    InstanceType String 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表或参见实例规格描述。若不指定该参数,则默认机型为S1.SMALL1。
    SystemDisk SystemDisk 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
    DataDisks.N Array of DataDisk 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘。支持购买的时候指定21块数据盘,其中最多包含1块LOCAL_BASIC数据盘或者LOCAL_SSD数据盘,最多包含20块CLOUD_BASIC数据盘、CLOUD_PREMIUM数据盘或者CLOUD_SSD数据盘。
    VirtualPrivateCloud VirtualPrivateCloud 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络IP,那么InstanceCount参数只能为1。
    InternetAccessible InternetAccessible 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
    InstanceCount Integer 购买实例数量。取值范围:[1,100]。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量,具体配额相关限制详见CVM实例购买限制。
    InstanceName String 实例显示名称。
  • 不指定实例显示名称则默认显示‘未命名’。
  • 购买多台实例,如果指定模式串{R:x},表示生成数字[x, x+n-1],其中n表示购买实例的数量,例如server_{R:3},购买1台时,实例显示名称为server_3;购买2台时,实例显示名称分别为server_3server_4。支持指定多个模式串{R:x}
  • 购买多台实例,如果不指定模式串,则在实例显示名称添加后缀1、2...n,其中n表示购买实例的数量,例如server_,购买2台时,实例显示名称分别为server_1server_2
  • 最多支持60个字符(包含模式串)。
  • LoginSettings LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
    SecurityGroupIds.N Array of String 实例所属安全组。该参数可以通过调用 DescribeSecurityGroups 的返回值中的sgId字段来获取。若不指定该参数,则默认不绑定安全组。
    EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
    ClientToken String 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
    更多详细信息请参阅:如何保证幂等性。
    HostName String 云服务器的主机名。
  • 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
  • Windows 实例:名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
  • 其他类型(Linux 等)实例:字符长度为[2, 30],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
  • TagSpecification.N Array of TagSpecification 标签描述列表。通过指定该参数可以同时绑定标签到相应的资源实例,当前仅支持绑定标签到云服务器实例。
    InstanceMarketOptions InstanceMarketOptionsRequest 实例的市场相关选项,如竞价实例相关参数
    HpcClusterId String 高性能计算集群ID。

    3. 输出参数

    参数名称 类型 描述
    Price Price 该参数表示对应配置实例的价格。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 最简单参数的购买询价

    只传必传的Zone和镜像ID,其他均采用系统默认值,具体配置如下:实例所在位置为上海二区,镜像ID为:img-pmqg1cw7。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=InquiryPriceRunInstances
    &Placement.Zone=ap-shanghai-2
    &ImageId=img-pmqg1cw7
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "Price": {
          "InstancePrice": {
            "UnitPrice": 0.2,
            "UnitPriceThirdStep": 0.1,
            "Discount": 40,
            "UnitPriceDiscountThirdStep": 0.06,
            "UnitPriceSecondStep": 0.12,
            "UnitPriceDiscount": 0.08,
            "UnitPriceDiscountSecondStep": 0.06,
            "ChargeUnit": "HOUR"
          },
          "BandwidthPrice": {
            "ChargeUnit": "GB",
            "UnitPrice": 0,
            "Discount": 65,
            "UnitPriceDiscount": 0
          }
        },
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
      }
    }

    示例2 包年包月实例购买询价

    实例所在位置为上海二区,付费模式为包年包月,购买一个月,到期自动续费,镜像ID为:img-pmqg1cw7,选择机型为:64C256G标准型(S5.16XLARGE256),50G大小高性能云系统盘,挂载100G大小高性能云数据盘,私有网络,公网付费模式为流量按小时后付费,外网带宽上限10Mbps,分配公网IP,实例命名为QCLOUD-TEST,设置登录密码未Qcloud@TestApi123++,安装云监控云安全,购买数量为1台。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=InquiryPriceRunInstances
    &Placement.Zone=ap-shanghai-2
    &InstanceChargeType=PREPAID
    &InstanceChargePrepaid.Period=1
    &InstanceChargePrepaid.RenewFlag=NOTIFY_AND_AUTO_RENEW
    &ImageId=img-pmqg1cw7
    &InstanceType=S5.16XLARGE256
    &SystemDisk.DiskType=CLOUD_PREMIUM
    &SystemDisk.DiskSize=50
    &DataDisks.0.DiskType=CLOUD_PREMIUM
    &DataDisks.0.DiskSize=100
    &InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
    &InternetAccessible.InternetMaxBandwidthOut=10
    &InternetAccessible.PublicIpAssigned=TRUE
    &InstanceName=QCLOUD-TEST
    &LoginSettings.Password=Qcloud@TestApi123++
    &EnhancedService.SecurityService.Enabled=TRUE
    &EnhancedService.MonitorService.Enabled=TRUE
    &InstanceCount=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "Price": {
          "InstancePrice": {
            "DiscountPrice": 1804.9,
            "OriginalPrice": 8884.5,
            "Discount": 20
          },
          "BandwidthPrice": {
            "ChargeUnit": "GB",
            "UnitPrice": 0.8,
            "UnitPriceDiscount": 0.52,
            "Discount": 65
          }
        },
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
      }
    }

    示例3 按小时后付费实例购买询价

    实例所在位置为上海二区,付费模式为按小时后付费,镜像ID为:img-pmqg1cw7,选择机型为:64C256G标准型(S5.16XLARGE256),50G大小高性能云系统盘,挂载100G大小高性能云数据盘,私有网络,公网付费模式为流量按小时后付费,外网带宽上限10Mbps,分配公网IP,实例命名为QCLOUD-TEST,设置登录密码未Qcloud@TestApi123++,安装云监控云安全,购买数量为1台。

    输入示例

    GET https://cvm.tencentcloudapi.com/?Action=InquiryPriceRunInstances
    &Placement.Zone=ap-shanghai-2
    &InstanceChargeType=POSTPAID_BY_HOUR
    &ImageId=img-pmqg1cw7
    &InstanceType=S5.16XLARGE256
    &SystemDisk.DiskType=CLOUD_PREMIUM
    &SystemDisk.DiskSize=50
    &DataDisks.0.DiskType=CLOUD_PREMIUM
    &DataDisks.0.DiskSize=100
    &InternetAccessible.InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR
    &InternetAccessible.InternetMaxBandwidthOut=10
    &InternetAccessible.PublicIpAssigned=TRUE
    &InstanceName=QCLOUD-TEST
    &LoginSettings.Password=Qcloud@TestApi123++
    &EnhancedService.SecurityService.Enabled=TRUE
    &EnhancedService.MonitorService.Enabled=TRUE
    &InstanceCount=1
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "Price": {
          "InstancePrice": {
            "UnitPrice": 16.09,
            "UnitPriceThirdStep": 16.09,
            "Discount": 21,
            "UnitPriceDiscountThirdStep": 3.33,
            "UnitPriceSecondStep": 16.09,
            "UnitPriceDiscount": 3.33,
            "UnitPriceDiscountSecondStep": 3.33,
            "ChargeUnit": "HOUR"
          },
          "BandwidthPrice": {
            "ChargeUnit": "GB",
            "UnitPrice": 0.8,
            "Discount": 65,
            "UnitPriceDiscount": 0.52
          }
        },
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
      }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    • Tencent Cloud SDK 3.0 for Python
    • Tencent Cloud SDK 3.0 for Java
    • Tencent Cloud SDK 3.0 for PHP
    • Tencent Cloud SDK 3.0 for Go
    • Tencent Cloud SDK 3.0 for NodeJS
    • Tencent Cloud SDK 3.0 for .NET
    • Tencent Cloud SDK 3.0 for C++
    • Tencent Cloud SDK 3.0 for Ruby

    命令行工具

    • Tencent Cloud CLI 3.0

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

    错误码 描述
    AccountQualificationRestrictions 该请求账户未通过资格审计。
    AuthFailure.CamRoleNameAuthenticateFailed 角色名鉴权失败
    FailedOperation.DisasterRecoverGroupNotFound 未找到指定的容灾组
    FailedOperation.InquiryPriceFailed 询价失败
    FailedOperation.TagKeyReserved 请求中指定的标签键为系统预留标签,禁止创建
    InstancesQuotaLimitExceeded 表示当前创建的实例个数超过了该账户允许购买的剩余配额数。
    InternalError.TradeUnknownError 内部错误
    InvalidClientToken.TooLong 指定的ClientToken字符串长度超出限制,必须小于等于64字节。
    InvalidHostId.Malformed 无效CDH ID。指定的CDH ID格式错误。例如ID长度错误host-1122
    InvalidHostId.NotFound 指定的HostId不存在,或不属于该请求账号所有。
    InvalidImageId.Malformed 错误的镜像Id格式。
    InvalidImageId.NotFound 未找到该镜像。
    InvalidInstanceName.TooLong 指定的InstanceName字符串长度超出限制,必须小于等于60字节。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidParameter.InstanceImageNotSupport 当前接口不支持实例镜像。
    InvalidParameter.SnapshotNotFound 指定的快照不存在。
    InvalidParameterCombination 表示参数组合不正确。
    InvalidParameterValue 参数取值错误。
    InvalidParameterValue.CloudSsdDataDiskSizeTooSmall SSD云硬盘为数据盘时,购买大小不得小于100GB
    InvalidParameterValue.InstanceTypeNotSupportHpcCluster 实例类型不可加入高性能计算集群。
    InvalidParameterValue.InstanceTypeRequiredHpcCluster 高性能计算实例需指定对应的高性能计算集群。
    InvalidParameterValue.InsufficientPrice 竞价失败。
    InvalidParameterValue.InvalidUserDataFormat UserData格式错误, 需要base64编码格式
    InvalidParameterValue.LimitExceeded 参数值数量超过限制。
    InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
    InvalidParameterValue.SnapshotIdMalformed 快照ID不合要求,请提供规范的快照ID,类似snap-xxxxxxxx,字母x代表小写字符或者数字
    InvalidPassword 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。
    InvalidPeriod 无效时长。目前只支持时长:[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36],单位:月。
    InvalidPermission 账户不支持该操作。
    InvalidProjectId.NotFound 无效的项目ID,指定的项目ID不存在。
    InvalidZone.MismatchRegion 指定的zone不存在。
    MissingParameter 缺少参数错误。
    MissingParameter.MonitorService 该实例类型必须开启云监控服务
    ResourceInsufficient.CloudDiskUnavailable 云盘参数不符合规范
    ResourceInsufficient.DisasterRecoverGroupCvmQuota 实例个数超过容灾组的配额
    ResourceNotFound.HpcCluster 高性能计算集群不存在。
    ResourceNotFound.NoDefaultCbs 无可用的缺省类型的CBS资源。
    ResourceNotFound.NoDefaultCbsWithReason 无可用的缺省类型的CBS资源。
    ResourceUnavailable.InstanceType 该可用区不售卖此机型
    UnsupportedOperation.BandwidthPackageIdNotSupported 指定的实例付费模式或者网络付费模式不支持共享带宽包
    UnsupportedOperation.InvalidDisk 不支持指定的磁盘
    UnsupportedOperation.NoInstanceTypeSupportSpot 该实例类型不支持竞价计费
    UnsupportedOperation.OnlyForPrepaidAccount 该操作仅支持预付费账户
    UnsupportedOperation.UnsupportedInternationalUser 请求不支持国际版账号

    本站部分内容转载于网络,版权归原作者所有,转载之目的在于传播更多优秀技术内容,如有侵权请联系QQ/微信:153890879删除,谢谢!

    推荐图文

    • 周排行
    • 月排行
    • 总排行

    随机推荐