管理与支持产品文档捉虫活动邀您参加！> HOT
文档中心>API 中心>云数据库 KeeWiDB>实例相关接口>创建数据库实例

创建数据库实例

最近更新时间：2025-05-29 01:42:11

我的收藏

本页目录：

1. 接口描述

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

创建数据库实例

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：CreateInstances。
Version 是 String 公共参数，本接口取值：2022-03-08。
Region 是 String 公共参数，详见产品支持的 地域列表。
TypeId 是 Integer 产品版本。
14：当前仅支持混合存储版。
示例值：14
UniqVpcId 是 String 私有网络唯一ID。
请登录控制台在私有网络列表查询，如：vpc-azlk3***。
示例值：vpc-azlk31bs
UniqSubnetId 是 String 私有网络所属子网唯一ID。
请登录控制台在私有网络列表查询，如：subnet-8abje***。
示例值：subnet-8abjechk
BillingMode 是 Integer 计费模式。
  • 0：按量计费。
  • 1：包年包月。

示例值：1
GoodsNum 是 Integer 实例数量，单次最大购买数量以查询产品售卖规格返回的数量为准。
示例值：1
Period 是 Integer 选择包年包月计费模式（BillingMode 设置为1）时，您需要选择购买实例的时长。单位：月，取值范围 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。按量计费（BillingMode 设置为0）实例该参数设置为1即可。
示例值：1
ShardNum 是 Integer 分片数量，支持选择3、5、6、8、9、10、12、15、16、18、20、21、24、25、27、30、32、33、35、36、39、40、42、45、48、50、51、54、55、56、57、60、63、64分片。
示例值：3
ReplicasNum 是 Integer 副本数。当前仅支持设置1个副本节点，即每一个分片仅包含1个主节点与1个副本节点，数据主从实时热备。
示例值：1
MachineMemory 是 Integer 实例内存容量，单位：GB。
KeeWiDB 内存容量MachineMemory与持久内存容量MemSize为固定搭配，即2GB内存，固定分配8GB的持久内存，不可选择。具体信息，请参见产品规格。
示例值：8
ZoneId 否 Integer 实例所属的可用区ID。
  • 具体取值，请参见地域和可用区获取。
  • 参数ZoneId和ZoneName至少配置其中一个。

示例值：100006
ZoneName 否 String 实例所属的可用区名称。
  • 具体取值，请参见地域和可用区获取。
  • 参数ZoneId和ZoneName至少配置其中一个。

示例值：ap-guangzhou-6
InstanceName 否 String 创建实例的名称。
仅支持长度小于60的中文、英文或者数字，短划线"-"、下划线"_"。
示例值：myInstance
NoAuth 否 Boolean 指明创建的实例是否需要支持免密访问。
  • true：免密实例。
  • false：非免密实例，默认为非免密实例。此时，需要设置访问密码。

示例值：false
Password 否 String 实例访问密码。
  • 当参数NoAuth为true时，Password为无需设置，否则Password为必填参数。
  • 密码复杂度要求：
    • 8-30个字符。
    • 至少包含小写字母、大写字母、数字和字符 ()`~!@#$%^&*-+=_|{}[]:;<>,.?/ 中的2种。
    • 不能以"/"开头。

示例值：123456MyP@ssword
VPort 否 Integer 自定义端口。默认为6379，范围[1024,65535]。
示例值：6378
AutoRenew 否 Integer 包年包月计费的续费模式。
  • 0：默认状态，指手动续费。
  • 1：自动续费。
  • 2：到期不再续费。

示例值：0
SecurityGroupIdList.N 否 Array of String 给实例设置安全组 ID 数组。
示例值：["sg-bmadczm1"]
ResourceTags.N 否 Array of ResourceTag 给实例绑定标签。
MemSize 否 Integer 混合存储版，单分片持久化内存容量，单位：GB。
KeeWiDB 内存容量MachineMemory与持久内存容量MemSize为固定搭配，即2GB内存，固定分配8GB的持久内存，不可选择。具体信息，请参见产品规格。
示例值：16
DiskSize 否 Integer 每个分片硬盘的容量。单位：GB。
每一缓存分片容量，对应的磁盘容量范围不同。具体信息，请参见产品规格。
示例值：100
MachineCpu 否 Integer 计算 CPU 核数，可忽略不传。CPU 核数与内存为固定搭配，具体信息，请参见产品规格。
示例值：2
ProjectId 否 Integer 项目id，取值以用户账户>用户账户相关接口查询>项目列表返回的projectId为准。
示例值：0
Compression 否 String 数据压缩开关。
  • ON：开启，默认开启压缩。
  • OFF：关闭。

示例值：ON

3. 输出参数

参数名称 类型 描述
DealId String 交易 ID。
示例值：199878234
InstanceIds Array of String 实例 ID 。
示例值：kee-7djvzcnx
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

创建实例

输入示例

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

{
    "ShardNum": "3",
    "TypeId": "14",
    "GoodsNum": "1",
    "UniqVpcId": "vpc-qicyv9mz",
    "MachineMemory": "2",
    "Period": "1",
    "ZoneId": "100002",
    "ReplicasNum": "1",
    "UniqSubnetId": "subnet-4rohwntq",
    "DiskSize": "100",
    "MemSize": "8",
    "MachineCpu": "1",
    "Password": "Test123456",
    "InstanceName": "测试实例2",
    "BillingMode": "1"
}

输出示例

{
    "Response": {
        "DealId": "229126199",
        "InstanceIds": [
            "kee-emg6bltn"
        ],
        "RequestId": "365b3029-06d5-4016-8054-518994bba781"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误，和业务无关。
InvalidParameter.EmptyParam 参数为空。
InvalidParameter.IllegalParameterError 非法参数错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
InvalidParameterValue.PasswordFreeDenied 该账号禁止使用免密实例。
InvalidParameterValue.SecurityGroupIdsNotExists 请求参数错误，安全组id不存在。
InvalidParameterValue.UnSupportedType 实例类型不支持。
InvalidParameterValue.UnVpcIdNotExists 请求参数错误，私有网络id不存在。
LimitExceeded.InvalidSize 请求的容量不在售卖规格中。
ResourceInsufficient 资源不足。
中国站
目录