You need to enable JavaScript to run this app.
导航
ModifyNodeSpecInOneStep - 单步更新实例节点规格
最近更新时间:2024.04.09 15:04:01首次发布时间:2023.11.30 14:19:27

调用 ModifyNodeSpecInOneStep 接口,可以直接一步修改实例节点配置,即进行实例的升配或降配操作。

注意事项

您在进行实例的升降配操作时,需要注意以下事项:

  • 降配时,支持降配各节点的节点规格,只有 Coordinator 节点支持减少节点数量。
  • 升配时,支持升配节点的节点规格、节点数量、存储容量和存储类型,但不同类型的节点有所差异。
  • 只有处于运行中状态的实例支持变配,其他状态下的实例均不支持变配。
  • 如果升配过程提升了节点规格,将会导致实例重启,建议您在业务低峰期变更实例配置。如果升配过程只提升存储容量或节点数量,不会触发实例重启,仅是变更实例。

请求说明

  • 请求方式:POST
  • 请求地址:/?Action=ModifyNodeSpecInOneStep&Version=2023-01-01 HTTP/1.1

请求参数

Query

参数类型是否必选示例值描述
ActionStringModifyNodeSpecInOneStep接口名称。当前 API 的名称为 ModifyNodeSpecInOneStep
VersionString2023-01-01接口版本。当前 API 的版本为 2023-01-01

Body

参数类型是否必选示例值描述
InstanceIdStringo-0080**iu98需要修改节点配置的实例 ID

NodeSpecsAssigns

Array of EsNodeSpecAssign

节点类型及其配置信息。
支持修改配置的节点类型包括:Kibana、Master、Hot、Coordinator、Warm、Cold。

EsNodeSpecAssign

参数类型是否必选示例值描述

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

计算资源规格名称,所有节点类型都支持修改节点规格。
您可以通过调用 DescribeNodeAvailableSpecs 接口获取可用的节点规格列表;也可以在产品规格文档查看节点规格。

返回参数

参数类型示例值描述
InstanceIdStringo-0080**iu98节点配置修改后,返回的实例 ID。

请求示例

POST https://open.volcengineapi.com/?Action=ModifyNodeSpecInOneStep&Version=2023-01-01
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"
        }
    ]
}

返回示例

{
    "Result": {
        "InstanceId": "o-0080**iu98"
    },
    "ResponseMetadata": {
        "Version": "2023-01-01",
        "RequestId": "2023060411042001001002****",
        "Service": "escloud",
        "Action": "ModifyNodeSpecInOneStep",
        "Region": "cn-beijing"
    }
}