InquiryPriceRunInstances

最近更新时间: 2024-12-21 13:01:32

1. 接口描述

接口请求域名: cvm.api3.gsesgpucloud.com。

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

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

接口更新时间:2022-10-27 11:28:18。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:InquiryPriceRunInstances
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
InstanceChargeType String 实例计费类型。
  • PREPAID:预付费,即包年包月
  • POSTPAID_BY_HOUR:按小时后付费
    默认值:POSTPAID_BY_HOUR。
    示例值: PREPAID
  • InstanceChargePrepaid InstanceChargePrepaid 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
    示例值:查看
    Placement Placement 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
    示例值:查看
    InstanceType String 实例机型。不同实例机型指定了不同的资源规格,具体取值可通过调用接口DescribeInstanceTypeConfigs来获得最新的规格表。若不指定该参数,则默认机型为S1.SMALL1。
    示例值: S5.MEDIUM2
    ImageId String 指定有效的镜像ID,格式形如img-xxx。镜像类型分为四种:
  • 公共镜像
  • 自定义镜像
  • 共享镜像
  • 服务市场镜像

  • 可通过以下方式获取可用的镜像ID:
  • 公共镜像自定义镜像共享镜像的镜像ID可通过登录控制台查询。
    示例值: img-pmqg1cw7
  • SystemDisk SystemDisk 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
    示例值:查看
    DataDisks Array of DataDisk 实例数据盘配置信息。若不指定该参数,则默认不购买数据盘,购买时可指定多个数据盘。
    示例值:查看
    VirtualPrivateCloud VirtualPrivateCloud 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若不指定该参数,则默认使用基础网络。若在此参数中指定了私有网络ip,那么InstanceCount参数只能为1。
    示例值:查看
    InternetAccessible InternetAccessible 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
    示例值:查看
    InstanceCount Int64 购买实例数量。取值范围:[1,100]。默认取值:1。指定购买实例的数量不能超过用户所能购买的剩余配额数量。
    示例值: 1
    InstanceName String 实例显示名称。如果不指定则默认显示
    示例值: myInstance
    LoginSettings LoginSettings 实例登录设置。通过该参数可以设置实例的登录方式密码、密钥或保持镜像的原始登录设置。默认情况下会随机生成密码,并以站内信方式知会到用户。
    示例值:查看
    SecurityGroupIds Array of String 实例所属安全组。若不指定该参数,则默认不绑定安全组。
    示例值: ["sg-efil73jd"]
    EnhancedService EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
    示例值:查看
    ClientToken String 用于保证请求幂等性的字符串。该字符串由客户生成,需保证不同请求之间唯一,最大值不超过64个ASCII字符。若不指定该参数,则无法保证请求的幂等性。
    更多详细信息请参阅:如何保证幂等性。
    示例值: 4668722c-b6d6-4f79-96fd-097ebe5318e5
    PurchaseSource String 内部参数,购买来源。前端调用的来源是MC
    示例值: API

    3. 输出参数

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

    4. 错误码

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

    错误码 描述
    InvalidParameterValue 无效参数值。参数值格式错误或者参数值不被支持等。
    AccountQualificationRestrictions 该请求账户未通过资格审计。
    InvalidParameterValue.Range 无效参数值。参数值取值范围不合法。
    InvalidInstanceName.TooLong 指定的InstanceName字符串长度超出限制,必须小于等于60字节。
    InvalidParameterCombination 表示参数组合不正确。
    InvalidInstanceType.Malformed 指定InstanceType参数格式不合法。
    InvalidHostId.NotFound 指定的HostId不存在,或不属于该请求账号所有。
    InvalidPeriod 无效时长。目前只支持时长:[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36],单位:月。
    InstancesQuotaLimitExceeded 表示当前创建的实例个数超过了该账户允许购买的剩余配额数。
    InvalidZone.MismatchRegion 指定的zone不存在。
    InvalidClientToken.TooLong 指定的ClientToken字符串长度超出限制,必须小于等于64字节。
    MissingParameter 参数缺失。请求没有带必选参数。
    InvalidPassword 无效密码。指定的密码不符合密码复杂度限制。例如密码长度不符合限制等。
    InvalidPermission 账户不支持该操作。