云搜索服务
云搜索服务
文档指南
请输入
- 文档首页
云搜索服务API 参考实例管理ModifyNodeSpecInOneStep - 单步更新实例节点规格
复制全文
下载 pdfModifyNodeSpecInOneStep - 单步更新实例节点规格
文档反馈
问问助手调用 ModifyNodeSpecInOneStep 接口一步修改实例节点配置（即进行实例的升配或降配操作）。
注意事项
您在进行实例的升降配操作时，需要注意以下事项：
- 降配时，支持降配各节点的节点规格，只有 Coordinator 节点支持减少节点数量。
- 升配时，支持升配节点的节点规格、节点数量、存储容量和存储类型，但不同类型的节点有所差异。
- 只有处于运行中状态的实例支持变配，其他状态下的实例均不支持变配。
- 如果升配过程提升了节点规格，将会导致实例重启，建议您在业务低峰期变更实例配置。如果升配过程只提升存储容量或节点数量，不会触发实例重启，仅是变更实例。
- 单节点实例提升节点数量，将会触发实例重启。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：ModifyNodeSpecInOneStep
要执行的操作，取值：ModifyNodeSpecInOneStep。
Version string 必选 示例值：2023-01-01
API的版本，取值：2023-01-01。
InstanceId string 必选 示例值：o-0080**iu98
需要修改节点配置的实例 ID。
NodeSpecsAssigns object[] 必选 示例值：--
节点类型及其配置信息。
支持修改配置的节点类型包括：Kibana、Master、Hot、Coordinator、Warm、Cold。
Type string 必选 示例值：Hot
需要修改配置的节点类型。
- Master：Master 节点。
- Hot：数据节点。
- Warm：温数据节点。
- Cold：冷数据节点。
- Kibana：Kibana 节点。
- Coordinator：协调节点。
说明
修改任何节点配置，Master 和 Hot 节点的配置信息必须包含在数组结构中。
Number integer 必选 示例值：2
节点数量。
- 升配时，除 Kibana 和专有主节点不支持增加节点数量，其余节点类型均支持增加节点数量。
- 降配时，只有 Coordinator 节点支持减少节点数量。
StorageSize integer 必选 示例值：100
存储容量，单位为 GiB，取值需为 10 的整数倍。
- 升配时，只有 Hot、Warm、Cold 节点支持增加存储容量。
- 降配时，不支持任何节点类型减少存储容量。
StorageSpecName string 必选 示例值：es.volume.essd.pl0
存储规格名称。
当前支持的规格有：
- es.volume.essd.pl0：标准版-高性能云盘-pl0。
- es.volume.essd.flexpl-standard：标准版-高性能云盘-flexpl。
说明
- 目前仅支持数据节点由 ESSD-PL0 存储类型升配到 ESSD-FlexPL 类型。
- Kibana 节点的 StorageSpecName 设置为空，即 "StorageSpecName": ""。
ResourceSpecName string 必选 示例值：es.x4.medium
计算资源规格名称，所有节点类型都支持修改节点规格。
返回参数
InstanceId string 示例值：o-0080**iu98
节点配置修改后，返回的实例 ID。
请求示例
POST /?Action=ModifyNodeSpecInOneStep&Version=2023-01-01
Host: escloud.cn-beijing.volcengineapi.com
Content-Type: application/json
X-Date: 20231003T104027Z
Authorization: HMAC-SHA256
Credential=AKLTMjI2ODVlYzI3ZGY1NGU4ZjhjYWRjMTlmNTM5OTZ****/20231003/cn-beijing/ESCloud/request, SignedHeaders=content-type;host;x-date, Signature=88dd0a9ea555d8609ec83eb46054b52f6cd4f79b8d5094fa784c66fa3f2b****
{
"InstanceId": "o-0080**iu98",
"NodeSpecsAssigns": [
{
"Number": 2,
"ResourceSpecName": "es.x4.medium",
"StorageSize": 100,
"StorageSpecName": "es.volume.essd.pl0",
"Type": "Hot"
}
]
}
返回示例
{
"ResponseMetadata": {
"Version": "2023-01-01",
"RequestId": "2023060411042001001002****",
"Service": "ESCloud",
"Action": "ModifyNodeSpecInOneStep",
"Region": "cn-beijing"
}
"Result": {
"InstanceId": "o-0080**iu98"
},
}
错误码
状态码 | 错误码 | 错误信息 | 说明 |
200 | Unauthorized | unauthorized error | 用户无权限调用接口。 |
200 | IllegalParameter | illegal parameter | 参数非法。原因可能是参数缺失或不符合接口要求。 |
200 | InternalServerError | 服务器内部异常 | 服务由于异常退出，无法完成接口请求操作。 |
最近更新时间：2026.04.01 10:37:03
这个页面对您有帮助吗？
有用
有用
无用
无用