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

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

注意事项

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

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

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

ModifyNodeSpecInOneStep

要执行的操作,取值:ModifyNodeSpecInOneStep。

Version
String

2023-01-01

API的版本,取值:2023-01-01。

InstanceId
String

o-0080**iu98

需要修改节点配置的实例 ID

NodeSpecsAssigns
Array of Object

--

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
InstanceId
String

o-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"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
Unauthorized
unauthorized error

用户无权限调用接口

200
IllegalParameter
illegal parameter

非法参数。可能是参数缺失,也可能是参数不符合接口要求

200
InternalServerError
服务器内部异常

服务由于异常退出,无法完成接口请求操作