创建实例

最近更新时间: 2026-11-06 00:17:12

1. 接口描述

接口请求域名: bms.api3.fincloud.tencent.cn。

本接口 (RunInstances) 用于创建一个或多个指定配置的实例。

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

接口更新时间:2025-12-30 17:59:41。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数,本接口取值:RunInstances
Version 是 否 String 公共参数,本接口取值:2018-08-13
Region 是 否 String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
HostName 否 否 String 裸金属的主机名。
  • 点号(.)和短横线(-)不能作为 HostName 的首尾字符,不能连续使用。
  • Windows 实例:名字符长度为[2, 15],允许字母(不限制大小写)、数字和短横线(-)组成,不支持点号(.),不能全是数字。
  • 其他类型(Linux 等)实例:字符长度为[2, 30],允许支持多个点号,点之间为一段,每段允许字母(不限制大小写)、数字和短横线(-)组成。
    示例值: host_name
  • Placement 是 否 Placement 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目。
    示例值:查看
    FlavorId 是 否 String 套餐ID。
    示例值: flavor-adfghjk
    OperatingSystemType 是 否 String 系统类型,支持Linux/Windows。
    示例值: linux
    OperatingSystem 是 否 String 系统的发行版本号。
    示例值: tlinux2.1
    VirtualPrivateCloud 是 否 VirtualPrivateCloud 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。若在此参数中指定了私有网络ip,InstanceCount参数必须与私有网络ip的个数一致。
    示例值:查看
    InternetAccessible 否 否 InternetAccessible 公网带宽相关信息设置。若不指定该参数,则默认公网带宽为0Mbps。
    示例值:查看
    InstanceCount 否 否 Int64 实例数量。
    示例值: 1
    InstanceName 否 否 String 实例显示名称。
    示例值: bms-adsfdghj
    LoginSettings 是 否 LoginSettings 实例登录设置,通过该参数可以设置实例的登录方式密码。
    示例值:查看
    EnhancedService 否 否 EnhancedService 增强服务。通过该参数可以指定是否开启云安全、云监控等服务。若不指定该参数,则默认开启云监控、云安全服务。
    示例值:查看
    RaidType 是 否 String RAID类型
    示例值: NORAID
    Tags 否 否 Array of Tag 绑定标签参数
    示例值:查看
    GroupId 否 否 String 分散置放群组ID,可通过[DescribeDisasterRecoverGroups]接口获取。
    示例值: ps-asdfghjk
    UserImage 否 否 Bool 自定义镜像标识(true:自定义镜像,false:公共镜像)
    示例值: true
    NodeList 否 否 Array of String 指定BMS创建的资源SN
    示例值: asdfadsg454f5asd
    TbdsShell 否 否 String 指定创建BMS时调用的dcos内置脚本
    示例值: tbds.sh

    3. 输出参数

    参数名称 类型 描述
    TaskId Array of String 返回改任务的taskid,可通过taskid查询任务运行情况
    示例值: 1234
    BmsId Array of String 返回创建BMS ID列表
    示例值: bms-wes2dfi8
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 错误码

    该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码。

    5. 示例

    示例1 创建实例

    输入示例

    {
      "Placement": {
        "Zone": "az"
      },
      "FlavorId": "flavor-03a89db9",
      "OperatingSystemType": "Linux",
      "UserImage": false,
      "OperatingSystem": "6",
      "VirtualPrivateCloud": {
        "VpcId": "vpc-73y2kwoz",
        "SubnetId": "subnet-57yurace"
      },
      "InstanceCount": 1,
      "LoginSettings": {
        "Password": ""
      },
      "EnhancedService": {
        "SecurityService": true,
        "WhistleService": false
      },
      "RaidType": "5",
      "Version": "2018-08-13",
      "Language": "zh-CN"
    }
    

    输出示例

    {
      "Response": {
        "TaskId": [
          "457561"
        ],
        "BmsId": [
          "bms-348a0fea"
        ],
        "RequestId": "61fb2db1-9991-99c1-dfbd-c431d3f709ac"
      }
    }