创建实例

最近更新时间:2024-03-12 01:32:39

我的收藏

1. 接口描述

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

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

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:RunInstances。
Version String 公共参数,本接口取值:2023-08-12。
Region String 公共参数,详见产品支持的 地域列表
ApplicationId String 应用ID
示例值:app-jknfna
BundleType String 算力套餐类型
示例值:XL
SystemDisk SystemDisk 实例系统盘配置信息。若不指定该参数,则按照系统默认值进行分配。
示例值:{"DiskType":"CLOUD_PREMIUM","DiskSize":250}
InstanceCount Integer 购买实例数量。
示例值:1
InstanceName String 实例显示名称
示例值:test
ClientToken String 幂等请求的token
示例值:hai-0-109261e6-c992-4d68-8b91-a70fac0da7b4
DryRun Boolean DryRun为True就是只验接口连通性,默认为False
示例值:False

3. 输出参数

参数名称 类型 描述
InstanceIdSet Array of String 实例ID列表
示例值:['hai-df99mzt1']
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建实例

创建hai实例

输入示例

POST / HTTP/1.1
Host: hai.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: RunInstances
<公共请求参数>

{
    "ApplicationId": "app-jknfna",
    "BundleType": "S",
    "SystemDisk": {
        "DiskType": "CLOUD_PREMIUM",
        "DiskSize": 250
    },
    "InstanceName": "test"
}

输出示例

{
    "Response": {
        "InstanceIdSet": [
            "hai-qcgdfaptd"
        ],
        "RequestId": "e267492d-fadaf-45a9-a139-416bc8652861"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.ArrearsAccountCannotRunInstances 欠费账户不能创建实例
InternalError 内部错误。
InvalidParameterValue.ApplicationIdNotFound 指定的应用不存在
InvalidParameterValue.BundleTypeNotFound 算力套餐类型不存在
InvalidParameterValue.InstanceNameTooLong 实例名称过长
InvalidParameterValue.InvalidApplicationIdMalformed 应用ID格式非法
InvalidParameterValue.InvalidInstanceCount 每次购买的实例数目不在合理范围内
LimitExceeded.SecurityGroupLimitExceeded 没有配额去为HAI创建新的安全组
LimitExceeded.VpcLimitExceeded 没有配额去为HAI创建新的VPC
ResourceInsufficient.BundleInventoryShortage 指定的算力套餐库存不足
UnauthorizedOperation.GetRoleError 高性能应用服务相关角色获取失败,无法完成操作
UnauthorizedOperation.UnauthorizedNetworkUser 用户账号的网络类型是传统型,不允许使用HAI
UnauthorizedOperation.UnauthorizedUser 客户未授权使用本产品