文档中心>API 中心>向量数据库>实例相关接口>升配节点规格(垂直扩容)

升配节点规格(垂直扩容)

最近更新时间:2025-04-25 02:08:09

我的收藏

1. 接口描述

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

本接口(ScaleUpInstance)用于升级节点配置规格。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ScaleUpInstance。
Version String 公共参数,本接口取值:2023-06-16。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定需升级配置的实例 ID。
示例值:vdb-iue**
Cpu Float 指定升级配置后的 CPU 核数。
- 节点规格可选项(CPU & 内存)必须 >= 当前配置。
- 可选择的规格信息,请参见选择节点规格与数量
示例值:4
Memory Float 指定升级配置后的内存大小,单位为:GB。
- 节点规格可选项(CPU & 内存)必须 >= 当前配置。
- 不同实例类型对 CPU 与内存资源的配置比例有不同的要求。例如,计算型实例,CPU 与内存的分配比例要求为 1:2。CPU 被指定为 4 核,那么内存则应被指定为 8GB。节点规格的详细信息,请参见选择节点规格与数量

示例值:8
StorageSize Integer 指定升级配置后的磁盘容量。
- 单位:GB。
- 取值范围为:[10,1000]。
- 取值必须为10的倍数。
示例值:200
RunNow Boolean 指定垂直扩容升级节点配置的时间。
- false:默认值,指在下一个维护时间段内执行升配节点规格的任务。实例列表中“状态”列将显示“待执行配置变更”,等到维护时间窗内启动任务。维护时间的更多信息,请参见维护时间窗。
- true:立即执行升级配置的任务,请确保此时没有重大业务操作。
示例值:false

3. 输出参数

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

4. 示例

示例1 升配节点规格

垂直扩容,升级指定实例的节点规格

输入示例

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

{
    "Cpu": 4,
    "Memory": 8,
    "InstanceId": "vdb-jnaj****",
    "StorageSize": 40
}

输出示例

{
    "Response": {
        "RequestId": "3b9204cd-6946-4688-8489-5707960ff6d3"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码