创建实例(预付费包年包月)

最近更新时间:2024-03-12 01:17:06

我的收藏

1. 接口描述

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

创建实例(预付费包年包月), 仅支持创建专业版实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateInstancePre。
Version String 公共参数,本接口取值:2019-08-19。
Region String 公共参数,详见产品支持的 地域列表
InstanceName String 实例名称,是一个不超过 64 个字符的字符串,必须以字母为首字符,剩余部分可以包含字母、数字和横划线(-)
示例值:test
ZoneId Integer 可用区。当购买多可用区实例时,当前参数为主可用区。需要保证传入的参数和 SubnetId 所在子网属于同一个可用区
示例值:100003
Period String 预付费购买时长,例如 "1m",就是一个月
示例值:1m
InstanceType Integer 国际站标准版实例规格。目前只有国际站标准版使用当前字段区分规格,国内站标准版使用峰值带宽区分规格。除了国际站标准版外的所有实例填写 1 即可。国际站标准版实例:入门型(general)]填写1;[标准型(standard)]填写2;[进阶型(advanced)]填写3;[容量型(capacity)]填写4;[高阶型1(specialized-1)]填写5;[高阶型2(specialized-2)]填写6;[高阶型3(specialized-3)]填写7;[高阶型4(specialized-4)]填写8。
示例值:1
VpcId String vpcId,必填
示例值:vpc-xxx
SubnetId String 子网id,必填
示例值:subnet-xxx
MsgRetentionTime Integer 可选。实例日志的最长保留时间,单位分钟,默认为10080(7天),最大30天,不填默认0,代表不开启日志保留时间回收策略
示例值:1440
ClusterId Integer 创建实例时可以选择集群Id, 该入参表示集群Id
示例值:1232
RenewFlag Integer 预付费自动续费标记,0表示默认状态(用户未设置,即初始状态), 1表示自动续费,2表示明确不自动续费(用户设置)
KafkaVersion String CKafka版本号[0.10.2、1.1.1、2.4.1、2.4.2、2.8.1、3.2.3], 默认是1.1.1。2.4.1 与 2.4.2 属于同一个版本,传任意一个均可。
示例值:1.1.1
SpecificationsType String 实例类型: [标准版实例]填写 "standard" (默认), [专业版实例]填写 "profession",[高级版实例]填写"premium"
示例值:profession
DiskSize Integer 磁盘大小,如果跟控制台规格配比不相符,则无法创建成功
示例值:500GB
BandWidth Integer 带宽,如果跟控制台规格配比不相符,则无法创建成功
示例值:40MB
Partition Integer 分区大小,如果跟控制台规格配比不相符,则无法创建成功
示例值:800
Tags.N Array of Tag 标签
示例值:{tagKey:'kkk',tag:Value:'vvv'}
DiskType String 专业版/高级版实例磁盘类型,标准版实例不需要填写。"CLOUD_SSD":SSD云硬盘;"CLOUD_BASIC":高性能云硬盘。不传默认为 "CLOUD_BASIC"
示例值:CLOUD_SSD
MultiZoneFlag Boolean 是否创建跨可用区实例,当前参数为 true 时,zoneIds必填
示例值:true
ZoneIds.N Array of Integer 可用区列表,购买多可用区实例时为必填项
示例值:[100006,100007]
PublicNetworkMonthly Integer 公网带宽大小,单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽,此处传 0;总共需要 6Mbps 公网带宽,此处传 3。默认值为 0。需要保证传入参数为 3 的整数倍
示例值:12
InstanceNum Integer 购买实例数量。非必填,默认值为 1。当传入该参数时,会创建多个 instanceName 加后缀区分的实例
示例值:1
AutoVoucher Integer 是否自动选择代金券:1-是;0否。默认为0
示例值:0

3. 输出参数

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

4. 示例

示例1 创建预付费实例

创建硬盘大小 200GB,峰值带宽 20MB/s 的专业版预付费实例

输入示例

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

{
    "InstanceName": "test55",
    "VpcId": "vpc-rmcgxxxx",
    "SubnetId": "subnet-mnzcxxxx",
    "ZoneId": 450001,
    "Period": "1m",
    "RenewFlag": 0,
    "InstanceType": 1,
    "KafkaVersion": "1.1.1",
    "SpecificationsType": "profession",
    "DiskSize": 200,
    "BandWidth": 20,
    "Partition": 400,
    "DiskType": "CLOUD_BASIC",
    "PublicNetworkMonthly": 0
}

输出示例

{
    "Response": {
        "RequestId": "323c3bbe-db79-48c3-9b76-63aacd65b169",
        "Result": {
            "Data": {
                "DealNameInstanceIdMapping": [
                    {
                        "DealName": "20230608002033899990000",
                        "InstanceIdList": [
                            "ckafka-mom5xxxx"
                        ]
                    }
                ],
                "DealNames": [
                    "2023060800203389990000"
                ],
                "FlowId": 0,
                "InstanceId": "ckafka-mom5xxxx"
            },
            "ReturnCode": "0",
            "ReturnMessage": "ok[apply ok]"
        }
    }
}

示例2 创建预付费标准版实例

创建预付费标准版实例,规格为入门型(general) ,周期为一个月

输入示例

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

{
    "InstanceName": "test57",
    "VpcId": "vpc-rmcgxxxx",
    "SubnetId": "subnet-mnzcxxxx",
    "ZoneId": 450001,
    "Period": "1m",
    "RenewFlag": 2,
    "InstanceType": 1,
    "KafkaVersion": "1.1.1",
    "SpecificationsType": "standard",
    "DiskSize": 200,
    "BandWidth": 20,
    "Partition": 400
}

输出示例

{
    "Response": {
        "RequestId": "2050ebf8-e255-4b90-ba0c-2fe8465e821a",
        "Result": {
            "Data": {
                "DealNameInstanceIdMapping": [
                    {
                        "DealName": "20230608002033922780000",
                        "InstanceIdList": [
                            "ckafka-bz4dxxxx"
                        ]
                    }
                ],
                "DealNames": [
                    "20230608002033922780000"
                ],
                "FlowId": 0,
                "InstanceId": "ckafka-bz4dxxxx"
            },
            "ReturnCode": "0",
            "ReturnMessage": "ok[apply ok]"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue.InstanceNotExist 实例不存在。
InvalidParameterValue.NotAllowedEmpty 参数不允许为空。
InvalidParameterValue.RepetitionValue 已存在相同参数。
InvalidParameterValue.SubnetIdInvalid 无效的子网id。
InvalidParameterValue.SubnetNotBelongToZone 子网不属于zone。
InvalidParameterValue.VpcIdInvalid 无效的 Vpc Id。
InvalidParameterValue.WrongAction Action参数取值错误。
InvalidParameterValue.ZoneNotSupport zone不支持。
ResourceInsufficient 资源不足。
ResourceUnavailable 资源不可用。
UnauthorizedOperation 未授权操作。
UnsupportedOperation.OssReject Oss拒绝该操作。