1. 接口描述
接口请求域名: es.tencentcloudapi.com 。
对集群进行节点规格变更,修改实例名称,修改配置,等操作。参数中InstanceId为必传参数,参数传递组合及含义如下:
- InstanceName:修改实例名称(仅用于标识实例)
- NodeNum: 修改实例节点数量(节点横向扩缩容,纵向扩缩容等)
- YMLConfig: 修改实例YML配置
- BindedES:修改绑定的ES集群配置
以上参数组合只能传递一种,多传或少传均会导致请求失败
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:UpdateLogstashInstance。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceId | 是 | String | 实例ID 示例值:ls-xxxxxxxx |
NodeNum | 否 | Integer | 实例节点数量 示例值:2 |
YMLConfig | 否 | String | 实例YML配置 示例值:"" |
BindedES | 否 | LogstashBindedES | 实例绑定的ES集群信息 示例值:{} |
InstanceName | 否 | String | 实例名称 示例值:"" |
ExtendedFiles.N | 否 | Array of LogstashExtendedFile | 扩展文件列表 |
NodeType | 否 | String | 实例规格 示例值:LOGSTASH.S1.LARGE16 |
DiskSize | 否 | Integer | 节点磁盘容量 示例值:100 |
OperationDuration | 否 | OperationDurationUpdated | 可维护时间段 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改Logstash实例名称
用以修改指定Logstash实例的名称
输入示例
输出示例
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: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.ClusterResourceLimitError | 集群资源配额限制错误。 |
FailedOperation.ErrorClusterState | 集群状态错误。 |
FailedOperation.NoPayment | 账户未绑定信用卡或paypal,无法支付。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
ResourceInUse | 资源被占用。 |
ResourceInUse.Order | 订单被锁定。 |
ResourceInsufficient | 资源不足。 |
ResourceInsufficient.Balance | 账户余额不足。 |
ResourceInsufficient.Subnet | 子网剩余ip数量不足。 |
UnsupportedOperation | 操作不支持。 |