消息队列 CKafka 版创建按量计费实例（新）-实例相关接口-API 中心-腾讯云

1. 接口描述

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

当前接口用来替代 CreateInstancePost 接口。创建按量计费实例。通常用于 SDK 或云 API 控制台调用接口，创建后付费 CKafka 实例。调用接口与在 CKafka 控制台购买按量付费实例效果相同。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreatePostPaidInstance。
Version	是	String	公共参数，本接口取值：2019-08-19。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceName	否	String	实例名称，是一个不超过 64 个字符的字符串，必须以字母为首字符，剩余部分可以包含字母、数字和横划线(-) 示例值：testInstance
VpcId	否	String	创建的实例默认接入点所在的 vpc 对应 vpcId。目前不支持创建基础网络实例，因此该参数必填示例值：vpc-xxxxxxxx
SubnetId	否	String	子网id。创建实例默认接入点所在的子网对应的子网 id 示例值：subnet-xxxxxxxx
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
MsgRetentionTime	否	Integer	实例日志的默认最长保留时间，单位分钟。不传入该参数时默认为 1440 分钟（1天），最大30天。当 topic 显式设置消息保留时间时，以 topic 保留时间为准示例值：1440
ClusterId	否	Integer	创建实例时可以选择集群Id, 该入参表示集群Id。不指定实例所在集群则不传入该参数示例值：5914
KafkaVersion	否	String	实例版本。目前支持 "0.10.2","1.1.1","2.4.1","2.4.2","2.8.1"。"2.4.1" 与 "2.4.2" 属于同一个版本，传任意一个均可。示例值：2.4.2
SpecificationsType	否	String	实例类型。"standard"：标准版，"profession"：专业版。 (标准版仅国际站支持，国内站目前支持专业版) 示例值：profession
DiskType	否	String	专业版实例磁盘类型，标准版实例不需要填写。"CLOUD_SSD"：SSD云硬盘；"CLOUD_BASIC"：高性能云硬盘。不传默认值为 "CLOUD_BASIC" 示例值：CLOUD_BASIC
BandWidth	否	Integer	实例内网峰值带宽。单位 MB/s。标准版需传入当前实例规格所对应的峰值带宽。注意如果创建的实例为专业版实例，峰值带宽，分区数等参数配置需要满足专业版的计费规格。示例值：20
DiskSize	否	Integer	实例硬盘大小，需要满足当前实例的计费规格示例值：200
Partition	否	Integer	实例最大分区数量，需要满足当前实例的计费规格示例值：400
TopicNum	否	Integer	实例最大 topic 数量，需要满足当前实例的计费规格示例值：200
ZoneId	否	Integer	实例所在的可用区。当创建多可用区实例时，该参数为创建的默认接入点所在子网的可用区 id 示例值：100006
MultiZoneFlag	否	Boolean	当前实例是否为多可用区实例。示例值：true
ZoneIds.N	否	Array of Integer	当实例为多可用区实例时，多可用区 id 列表。注意参数 ZoneId 对应的多可用区需要包含在该参数数组中示例值：[100006,100007]
InstanceNum	否	Integer	购买实例数量。非必填，默认值为 1。当传入该参数时，会创建多个 instanceName 加后缀区分的实例示例值：1
PublicNetworkMonthly	否	Integer	公网带宽大小，单位 Mbps。默认是没有加上免费 3Mbps 带宽。例如总共需要 3Mbps 公网带宽，此处传 0；总共需要 6Mbps 公网带宽，此处传 3。需要保证传入参数为 3 的整数倍示例值：12
Tags.N	否	Array of Tag	标签示例值：{tagKey:'kkk',tagValue:'vvv'}

3. 输出参数

参数名称	类型	描述
Result	CreateInstancePostResp	返回结果
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: CreatePostPaidInstance
<公共请求参数>

{
    "InstanceName": "test55",
    "VpcId": "vpc-rmcgxxxx",
    "SubnetId": "subnet-mnzcxxxx",
    "ZoneId": 450001,
    "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 批量创建后付费专业版实例

同时创建三个后付费专业版实例

输入示例

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

{
    "InstanceName": "test58",
    "VpcId": "vpc-rmcg5cpf",
    "SubnetId": "subnet-mnzcs7gk",
    "KafkaVersion": "2.4.2",
    "SpecificationsType": "profession",
    "BandWidth": 20,
    "DiskSize": 200,
    "Partition": 400,
    "TopicNum": 200,
    "ZoneId": 450001,
    "InstanceNum": 3,
    "PublicNetworkMonthly": 12
}

输出示例

{
    "Response": {
        "RequestId": "cda79237-6424-482a-b2d2-97d4853b33b4",
        "Result": {
            "Data": {
                "DealNameInstanceIdMapping": [
                    {
                        "DealName": "20230608002033915320000",
                        "InstanceIdList": [
                            "ckafka-bz4dxxxx",
                            "ckafka-o9gdxxxx",
                            "ckafka-aj5gxxxx"
                        ]
                    }
                ],
                "DealNames": [
                    "20230608002033915320000"
                ],
                "FlowId": 0,
                "InstanceId": "ckafka-bz4dxxxx"
            },
            "ReturnCode": "0",
            "ReturnMessage": "ok[apply ok]"
        }
    }
}

示例3 创建后付费多可用区专业版实例

创建一个三可用区的专业版实例

输入示例

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

{
    "InstanceName": "test55",
    "VpcId": "vpc-rmcgxxxx",
    "SubnetId": "subnet-mnzcxxxx",
    "ZoneId": 450001,
    "InstanceType": 1,
    "KafkaVersion": "1.1.1",
    "SpecificationsType": "profession",
    "DiskSize": 200,
    "BandWidth": 20,
    "Partition": 400,
    "DiskType": "CLOUD_BASIC",
    "PublicNetworkMonthly": 0,
    "MultiZoneFlag": true,
    "ZoneIds": [
        450001,
        450002,
        450003
    ]
}

输出示例

{
    "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]"
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

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不支持。
ResourceUnavailable	资源不可用。
UnauthorizedOperation	未授权操作。
UnsupportedOperation.BatchDelInstanceLimit	批量删除实例限制。
UnsupportedOperation.OssReject	Oss拒绝该操作。

创建按量计费实例（新）

本页目录：

1. 接口描述

2. 输入参数

3. 输出参数

4. 示例

示例1 创建后付费专业版实例

输入示例

输出示例

示例2 批量创建后付费专业版实例

输入示例

输出示例

示例3 创建后付费多可用区专业版实例

输入示例

输出示例

5. 开发者资源

腾讯云 API 平台

API Inspector

SDK

命令行工具

6. 错误码