向量数据库创建实例

1. 接口描述

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

本接口（CreateInstance）用于创建向量数据库实例。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateInstance。
Version	是	String	公共参数，本接口取值：2023-06-16。
Region	是	String	公共参数，详见产品支持的地域列表。
VpcId	是	String	私有网络 ID。示例值：vpc-rdfkabjj
SubnetId	是	String	私有网络 VPC 的子网 ID。示例值：subnet-rdfkabj
PayMode	是	Integer	指定实例计费方式。 0：按量付费。 1：包年包月。示例值：1
InstanceName	否	String	设置实例名称。仅支持长度不超过 60 的中文/英文/数字/-/_。示例值：vdb-yn67ikxud
SecurityGroupIds.N	否	Array of String	安全组 ID。示例值：["A","B"]
PayPeriod	否	Integer	若计费方式为包年包月，指定包年包月续费的时长。单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。示例值：1
AutoRenew	否	Integer	若为包年包月计费，需指定是否开启自动续费。 0：不开启自动续费。 1：开启自动续费。示例值：1
Params	否	String	实例额外参数，通过json提交。示例值：'{"key":"value"}'
ResourceTags.N	否	Array of Tag	以数组形式列出标签信息。
ProductType	否	Integer	产品版本，0-标准版，1-容量增强版示例值：0
InstanceType	否	String	实例类型。 base：免费测试版。 single：单机版。 cluster：高可用版。示例值：cluster
Mode	否	String	实例类型为高可用版，需指定可用区选项。 two：两可用区。 three：三可用区。示例值：three
GoodsNum	否	Integer	购买实例数量。示例值：1
Cpu	否	Integer	指定实例所需的 CPU 核数。实例类型不同，支持的 CPU 核数存在差异。计算型： 1、2、4、8、16、24、32。标准型： 1、2、4、8、12、16。存储型： 1、2、4、6、8。示例值：1
Memory	否	Integer	指定实例所需的内存大小。单位：GB。选择具体规格，请参见配置规格（选型）。示例值：1
DiskSize	否	Integer	指定实例所需的磁盘大小，单位：GB。选择具体规格，请参见配置规格（选型）。示例值：20
WorkerNodeNum	否	Integer	指定实例所需配置的节点数量。选择方法，请参见配置规格（选型）。示例值：1
EnableEncryption	否	Boolean	是否开启磁盘数据存储加密（仅 CBS 数据盘生效，需落在 VECTORDB_DISK_ENCRYPT_REGION 白名单地域，默认 false 不开启）默认值：true 示例值：false

3. 输出参数

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

4. 示例

示例1 创建磁盘加密实例

输入示例

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

{
    "VpcId": "vpc-n4c3s8u4",
    "SubnetId": "subnet-8apk7iir",
    "PayMode": 0,
    "InstanceName": "vdb-disk",
    "SecurityGroupIds": [
        "sg-dxnd192j"
    ],
    "PayPeriod": 1,
    "AutoRenew": 1,
    "Params": null,
    "ResourceTags": [
        {
            "TagKey": null,
            "TagValue": null
        }
    ],
    "ProductType": 0,
    "InstanceType": "cluster",
    "Mode": "two",
    "GoodsNum": 1,
    "Cpu": 1,
    "Memory": 2,
    "DiskSize": 100,
    "WorkerNodeNum": 2,
    "EnableEncryption": false
}

输出示例

{
    "Response": {
        "InstanceIds": [
            "vdb-17jsleiv"
        ],
        "RequestId": "617ca492-e31a-445f-b562-8a6588ed2a6b"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。

创建实例

本页目录：