1. 接口描述
接口请求域名: es.tencentcloudapi.com 。
用于创建Logstash实例
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateLogstashInstance。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceName | 是 | String | 实例名称(1-50 个英文、汉字、数字、连接线-或下划线_) 示例值:logstash_test |
Zone | 是 | String | 可用区 示例值:ap-guangzhou-3 |
LogstashVersion | 是 | String | 实例版本(支持"6.8.13"、"7.10.1") 示例值:6.8.13 |
VpcId | 是 | String | 私有网络ID 示例值:vpc-xxxxxx |
SubnetId | 是 | String | 子网ID 示例值:subnet-xxxxxx |
NodeNum | 否 | Integer | 节点数量(2-50个) 示例值:3 |
ChargeType | 否 | String | 计费类型 示例值:POSTPAID_BY_HOUR |
ChargePeriod | 否 | Integer | 包年包月购买时长(单位由参数TimeUnit决定) 示例值:1 |
TimeUnit | 否 | String | 计费时长单位(ChargeType为PREPAID时需要设置,默认值为“m”,表示月,当前只支持“m”) 示例值:m |
AutoVoucher | 否 | Integer | 是否自动使用代金券 示例值:1 |
VoucherIds.N | 否 | Array of String | 代金券ID列表(目前仅支持指定一张代金券) 示例值:[""] |
RenewFlag | 否 | String | 自动续费标识 示例值:RENEW_FLAG_DEFAULT |
NodeType | 否 | String | 节点规格 示例值:LOGSTASH.S1.SMALL2 |
DiskType | 否 | String | 节点磁盘类型 示例值:CLOUD_SSD |
DiskSize | 否 | Integer | 节点磁盘容量(单位GB) 示例值:100 |
LicenseType | 否 | String | License类型 示例值:xpack |
TagList.N | 否 | Array of TagInfo | 标签信息列表 |
OperationDuration | 否 | OperationDuration | 可维护时间段 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 实例ID 示例值:ls-xxxxxx |
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure.UnAuthCreateInstance | 当前用户对创建集群实例操作未授权,请添加CAM权限 |
AuthFailure.UnAuthDescribeInstances | 当前用户对查询集群实例操作未授权,请添加CAM权限。 |
AuthFailure.UnAuthorizedOperation | 操作未授权。 |
FailedOperation.CloseDataTier | 关闭数据层失败,至少要保留热层和温层其中一层。 |
FailedOperation.ClusterResourceLimitError | 集群资源配额限制错误。 |
FailedOperation.EsDictionaryInfoError | 由于EsDictionaryInfo错误,不允许操纵。 |
FailedOperation.FileNameError | 文件名不符合规范。 |
FailedOperation.FileSizeError | 文件大小不符合要求。 |
FailedOperation.GetTagInfoError | 获取实例的标签列表错误。 |
FailedOperation.NoPayment | 账户未绑定信用卡或paypal,无法支付。 |
FailedOperation.NodeNumAndZoneError | 节点数和可用区的信息不符合对应操作的规则。 |
FailedOperation.Password | 解码Password时出错。 |
FailedOperation.RefundError | 该实例不满足退费条件。 |
FailedOperation.RequestTimeOut | 请求超时。 |
FailedOperation.TradeSignError | 生成询价或者下单签名有误。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameter.GC | Gc类型的取值和预期不符。 |
InvalidParameter.InvalidAutoVoucher | 是否自动使用代金券AutoVoucher的取值和预期不符。 |
InvalidParameter.InvalidBackends | Backends的取值和预期不符。 |
InvalidParameter.InvalidDeployMode | 集群部署方式InvalidDeployMode的取值和预期不符。 |
InvalidParameter.InvalidDiskEnhance | 是否启用增强型ssd云盘DiskEnhance的取值和预期不符。 |
InvalidParameter.InvalidDns | 内网域名解析服务器IP Dns的取值和预期不符。 |
InvalidParameter.InvalidEsVersion | 实例版本EsVersion的取值和预期不符。 |
InvalidParameter.InvalidIndexMetaJson | 创建的索引元数据JSON IndexMetaJson的取值和预期不符。 |
InvalidParameter.InvalidIndexName | 索引名IndexName的取值和预期不符。 |
InvalidParameter.InvalidIndexOptionsField | 索引自治字段IndexOptionsField的取值和预期不符。 |
InvalidParameter.InvalidIndexPolicyField | 索引生命周期字段IndexPolicyField的取值和预期不符。 |
InvalidParameter.InvalidIndexSettingsField | 索引配置字段IndexSettingsField的取值和预期不符。 |
InvalidParameter.InvalidIndexType | 索引类型IndexType的取值和预期不符。 |
InvalidParameter.InvalidInstanceOperationDurations | 集群可维护时间段和集群ID InstanceOperationDurations的取值和预期不符。 |
InvalidParameter.InvalidLogType | 日志类型LogType的取值和预期不符。 |
InvalidParameter.InvalidLogstashVersion | 实例版本LogstashVersion的取值和预期不符。 |
InvalidParameter.InvalidNodeNames | 节点名称列表NodeNames的取值和预期不符。 |
InvalidParameter.InvalidNodeTypeStorageInfo | 温热层数据结构NodeTypeInfos的取值和预期不符。 |
InvalidParameter.InvalidOperationDuration | 可维护时间段OperationDuration的取值和预期不符。 |
InvalidParameter.InvalidPara | 需要签名的参数Para的取值和预期不符。 |
InvalidParameter.InvalidRestartMode | 可选重启模式RestartMode的取值和预期不符。 |
InvalidParameter.InvalidRestartType | 重启方式RestartType的取值和预期不符。 |
InvalidParameter.InvalidSampleJson | 数据样例JSON SampleJson的取值和预期不符。 |
InvalidParameter.InvalidSecurityGroupIds | 安全组id列表SecurityGroupIds的取值和预期不符。 |
InvalidParameter.InvalidSubnetUidList | 虚拟子网络统一ID列表的取值和预期不符。 |
InvalidParameter.InvalidTargetIndexName | 目标索引名TargetIndexName的取值和预期不符。 |
InvalidParameter.InvalidTargetNodeTypes | 接收请求的目标节点类型列表InvalidTargetNodeTypes的取值和预期不符。 |
InvalidParameter.InvalidTimeParam | 时间相关参数的取值或格式和预期不符。 |
InvalidParameter.InvalidTraceUuid | 调用链Id TraceUuid的取值和预期不符。 |
InvalidParameter.InvalidType | 节点类型Type的取值和预期不符。 |
InvalidParameter.InvalidUpdateMetaJson | 更新的索引元数据json UpdateMetaJson的取值和预期不符。 |
InvalidParameter.InvalidVoucherIds | 代金券ID列表VoucherIds的取值和预期不符。 |
InvalidParameterValue.ChargePeriod | 包年包月购买时长ChargePeriod的取值有误。 |
InvalidParameterValue.ChargeType | 计费类型ChargeType的参数取值有误。 |
InvalidParameterValue.CheckOnly | 是否只做升级检查CheckOnly的取值有误。 |
InvalidParameterValue.ConfigInfo | 组件配置值有误。 |
InvalidParameterValue.EnableDoubleEni | 是否允许双网卡EnableDoubleEni的值有误。 |
InvalidParameterValue.EsPort | 端口EsPort的取值有误。 |
InvalidParameterValue.EsVip | EsVip的取值有误。 |
InvalidParameterValue.InstallBundleList | 要安装的bundle信息列表InstallBundleList的取值有误。 |
InvalidParameterValue.InstallPluginList | 为集群稳定起见,当前只支持同时安装1个用户插件。 |
InvalidParameterValue.InvalidJDK | Jdk类型的取值和预期不符。 |
InvalidParameterValue.PluginType | 插件类型PluginType的取值有误。 |
InvalidParameterValue.RemoveBundleList | 要卸载的bundle名列表RemoveBundleList的取值有误。 |
InvalidParameterValue.RemovePluginList | 为集群稳定起见,当前只支持同时卸载1个用户插件。 |
InvalidParameterValue.RenewFlag | 自动续费标识RenewFlag的参数取值有误。 |
InvalidParameterValue.TargetPath | 要安装的bundle的zip包解压所在的路径TargetPath的取值有误。 |
InvalidParameterValue.TimeUnit | 计费时长单位TimeUnit的取值有误。 |
InvalidParameterValue.UpgradeMode | 升级方式UpgradeMode的取值有误。 |
LimitExceeded.ClusterNum | 该账号下的集群数超过限额。 |
LimitExceeded.DiagnoseCount | 超过当天智能诊断最大次数。 |
LimitExceeded.DiskCount | 节点磁盘块数超过最大限额。 |
LimitExceeded.NodeNumOrIndices | 节点数量或索引存储量超过限额。 |
LimitExceeded.PluginInstall | 超过最大自定义插件数量,请先删除部分自定义插件。 |
RegionError | 地域错误 |
ResourceInUse | 资源被占用。 |
ResourceInUse.Diagnose | 存在诊断中的作业,请等待作业诊断完成后重试。 |
ResourceInUse.Order | 订单被锁定。 |
ResourceInsufficient | 资源不足。 |
ResourceInsufficient.Balance | 账户余额不足。 |
ResourceInsufficient.CVM | 计算资源不足,可更换可用区或调整机型。 |
ResourceInsufficient.CVMQuota | cvm份额不足。 |
ResourceInsufficient.Subnet | 子网剩余ip数量不足。 |
ResourceNotFound.AccountInfoNotFound | 账户信息未找到。 |
ResourceNotFound.BaradMetricNotFound | 巴拉多(barad)指标资源未找到。 |
ResourceNotFound.CAMInfoNotFound | CAM资源未找到。 |
ResourceNotFound.CLBNotFound | 负载均衡信息未找到。 |
ResourceNotFound.CosInfoNotFound | COS相关信息获取失败。 |
ResourceNotFound.DiagnoseNotFound | 智能诊断相关资源未找到。 |
ResourceNotFound.KMSNotFound | 密钥管理系统资源获取失败。 |
ResourceNotFound.STSNotFound | 获取安全凭证服务资源失败。 |
ResourceNotFound.SecurityGroupNotFound | 安全组信息获取失败。 |
ResourceNotFound.TradeCgwNotFound | 获取计费资源失败。 |
ResourceNotFound.VPCInfoNotFound | VPC资源获取失败。 |
UnsupportedOperation.AuditStatusConflict | 审计日志的状态冲突。 |
UnsupportedOperation.CosBackUp | 该版本不支持cos备份。集群需要重启来允许cos备份。 |
UnsupportedOperation.DiagnoseJob | 不支持该智能诊断任务。 |
UnsupportedOperation.DiagnoseNotOpen | 智能诊断未开启。 |
UnsupportedOperation.DiskUse | 不支持的读硬盘配置。 |
UnsupportedOperation.EditListLength | 不支持这个长度的editList的操作。 |
UnsupportedOperation.Migrate | 不支持迁移操作。 |
UnsupportedOperation.PassLogstashId | 用户同步日志的配置passLogstashId为空,不支持该操作。 |
UnsupportedOperation.Plugin | 不支持该插件。 |
UnsupportedOperation.Protocol | 不支持对应Protocol的操作。 |
UnsupportedOperation.ReadRate | 不支持的读取速度。 |
UnsupportedOperation.RestartMode | 离线节点蓝绿变更存在风险,请直接选择重启“in-place”。 |
UnsupportedOperation.StatusNotNormal | 不支持该操作,当前实例运行状态不为正常。 |
UnsupportedOperation.UpdateDiskEncrypt | 节点或磁盘数变更时不支持更新磁盘加密信息。 |
UnsupportedOperation.UpdateDiskType | 不支持更新磁盘类型。 |
UnsupportedOperation.UpdateNodeNumAndNodeType | 不支持同时更新节点个数(NodeNum)和节点规格(NodeType)。 |
UnsupportedOperation.WebServiceType | 不支持的web组件。 |
UnsupportedOperation.WriteRate | 不支持的写入速度。 |