API 文档

购买物理机

最近更新时间:2020-07-13 08:10:03

1. 接口描述

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

购买黑石物理机

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:BuyDevices。
Version String 公共参数,本接口取值:2018-04-23。
Region String 公共参数,详见产品支持的 地域列表
Zone String 可用区ID。通过接口查询地域以及可用区(DescribeRegions)获取可用区信息
OsTypeId Integer 部署服务器的操作系统ID。通过接口查询操作系统信息(DescribeOsInfo)获取操作系统信息
RaidId Integer RAID类型ID。通过接口查询机型RAID方式以及系统盘大小(DescribeDeviceClassPartition)获取RAID信息
GoodsCount Integer 购买数量
VpcId String 购买至私有网络ID
SubnetId String 购买至子网ID
DeviceClassCode String 购买的机型ID。通过接口查询设备型号(DescribeDeviceClass)获取机型信息
TimeUnit String 购买时长单位,取值:M(月) D(天)
TimeSpan Integer 购买时长
NeedSecurityAgent Integer 是否安装安全Agent,取值:1(安装) 0(不安装),默认取值0
NeedMonitorAgent Integer 是否安装监控Agent,取值:1(安装) 0(不安装),默认取值0
NeedEMRAgent Integer 是否安装EMR Agent,取值:1(安装) 0(不安装),默认取值0
NeedEMRSoftware Integer 是否安装EMR软件包,取值:1(安装) 0(不安装),默认取值0
ApplyEip Integer 是否分配弹性公网IP,取值:1(分配) 0(不分配),默认取值0
EipPayMode String 弹性公网IP计费模式,取值:Flow(按流量计费) Bandwidth(按带宽计费),默认取值Flow
EipBandwidth Integer 弹性公网IP带宽限制,单位Mb
IsZoning Integer 数据盘是否格式化,取值:1(格式化) 0(不格式化),默认取值为1
CpmPayMode Integer 物理机计费模式,取值:1(预付费) 2(后付费),默认取值为1
ImageId String 自定义镜像ID,取值生效时用自定义镜像部署物理机
Password String 设置Linux root或Windows Administrator的密码
AutoRenewFlag Integer 自动续费标志位,取值:1(自动续费) 0(不自动续费),默认取值0
SysRootSpace Integer 系统盘根分区大小,单位为G,默认取值10G。通过接口查询机型RAID方式以及系统盘大小(DescribeDeviceClassPartition)获取根分区信息
SysSwaporuefiSpace Integer 系统盘swap分区或/boot/efi分区的大小,单位为G。若是uefi启动的机器,分区为/boot/efi,且此值是默认是2G。 普通机器为swap分区,可以不指定此分区。 机型是否是uefi启动,参见接口查询设备型号(DescribeDeviceClass)
SysUsrlocalSpace Integer /usr/local分区大小,单位为G
SysDataSpace Integer /data分区大小,单位为G。如果系统盘还有剩余大小,会分配给/data分区。(特殊情况:如果剩余空间不足10G,并且没有指定/data分区,则剩余空间会分配给Root分区)
HyperThreading Integer 是否开启超线程,取值:1(开启) 0(关闭),默认取值1
LanIps.N Array of String 指定的内网IP列表,不指定时自动分配
Aliases.N Array of String 设备名称列表
CpuId Integer CPU型号ID,自定义机型需要传入,取值:

  • 1: E5-2620v3 (6核) * 2
  • 2: E5-2680v4 (14核) * 2
  • 3: E5-2670v3 (12核) * 2
  • 4: E5-2620v4 (8核) * 2
  • 5: 4110 (8核) * 2
  • 6: 6133 (20核) * 2

  • ContainRaidCard Integer 是否有RAID卡,取值:1(有) 0(无),自定义机型需要传入
    MemSize Integer 内存大小,单位为G,自定义机型需要传入。取值参考接口查询自定义机型部件信息(DescribeHardwareSpecification)返回值
    SystemDiskTypeId Integer 系统盘ID,自定义机型需要传入。取值参考接口查询自定义机型部件信息(DescribeHardwareSpecification)返回值
    SystemDiskCount Integer 系统盘数量,自定义机型需要传入。取值参考接口查询自定义机型部件信息(DescribeHardwareSpecification)返回值
    DataDiskTypeId Integer 数据盘ID,自定义机型需要传入。取值参考接口查询自定义机型部件信息(DescribeHardwareSpecification)返回值
    DataDiskCount Integer 数据盘数量,自定义机型需要传入。取值参考接口查询自定义机型部件信息(DescribeHardwareSpecification)返回值
    Tags.N Array of Tag 绑定的标签列表
    FileSystem String 指定数据盘的文件系统格式,当前支持 EXT4和XFS选项, 默认为EXT4。 参数适用于数据盘和Linux, 且在IsZoning为1时生效
    BuySession String 此参数是为了防止重复发货。如果两次调用传入相同的BuySession,只会发货一次。 不要以设备别名作为BuySession,这样只会第一次购买成功。参数长度为128位,合法字符为大小字母,数字,下划线,横线。
    SgId String 绑定已有的安全组ID。仅在NeedSecurityAgent为1时生效
    TemplateId String 安全组模板ID,由模板创建新安全组并绑定。TemplateId和SgId不能同时传入

    3. 输出参数

    参数名称 类型 描述
    InstanceIds Array of String 购买的物理机实例ID列表
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 购买物理机

    输入示例

    https://bm.tencentcloudapi.com/?Action=BuyDevices
    &Zone=ap-guangzhou
    &OsTypeId=1
    &RaidId=1
    &GoodsCount=100
    &VpcId=vpc-xxx
    &SubnetId=subnet-xxx
    &DeviceClassCode=PS100v3
    &TimeUnit=M
    &TimeSpan=12
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "InstanceIds": [
          "cpm-xxx"
        ],
        "RequestId": "3f02fb0c-f782-4cef-9007-d63c68146e39"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    FailedOperation 操作失败
    InvalidParameter 参数错误
    LimitExceeded 超过配额限制
    ResourceInUse.FlowBusy 流程操作繁忙,请稍后重试。
    ResourceInsufficient.DeviceInsufficient 设备不足。
    ResourceUnavailable 资源不可用
    UnsupportedOperation 操作不支持
    UnsupportedOperation.FundInsufficient 余额不足。
    目录