创建实例

最近更新时间:2025-07-25 01:26:57

我的收藏

1. 接口描述

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

创建实例接口,仅供免费实例使用

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateInstance。
Version String 公共参数,本接口取值:2023-10-24。
Region String 公共参数,本接口不需要传递此参数。
Domain String 业务域名
示例值:mainDomain.com
AccessType String CUSTOM: 自定义接入域名
SYSTEM: 系统接入域名
示例值:CUSTOM
GlobalTtl Integer 解析生效时间
示例值:600
PackageType String 套餐类型
FREE: 免费版
STANDARD:标准版
ULTIMATE:旗舰版
示例值:FREE
InstanceName String 实例名称
示例值:实例名称
AccessDomain String 接入主域名
示例值:rootDomain.com
AccessSubDomain String 接入子域名
示例值:subDomain
Remark String 备注
示例值:备注信息
ResourceId String 套餐资源id
示例值:ins-sdsdad12x

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建免费版套餐

创建免费版套餐

输入示例

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

{
    "InstanceName": "example-test-instance",
    "Domain": "igtm.example.com",
    "AccessType": "custom",
    "AccessDomain": "example.com",
    "AccessSubDomain": "access.igtm",
    "GlobalTtl": 300,
    "PackageType": "Free",
    "Remark": "测试实例"
}

输出示例

{
    "Response": {
        "RequestId": "ec040ddf-7c7d-4aef-9e0d-6f3105fa0a4c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
FailedOperation.CreateError 创建失败。
FailedOperation.CreateInstanceFailed 创建实例失败
FailedOperation.QueryErr 查询失败
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.AccessTypeInvalid 实例接入类型不合法
InvalidParameter.GlobalAccessDomainConflict 全局接入域名冲突,当前域名被其他实例使用,请解决占用后重试
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.UnauthorizedError 资源未授权。
UnsupportedOperation.AccessDomainUnauthorized 接入域名未使用腾讯云 DNSPod 解析,请重新输入
UnsupportedOperation.DomainTtlInvalid 接入域名的套餐不允许此TTL值
UnsupportedOperation.InstanceNameDuplicate 实例名称不能重复
UnsupportedOperation.PackageUnauthorized 套餐无效,请选择正确套餐
UnsupportedOperation.TTLInvalid TTL无效,请设置正确的TTL
UnsupportedOperation.UserNotFound 用户未登录,缺少Uin参数。