Elasticsearch Service Beats 指南

一、1. 接口描述

用于创建Beats采集器

默认接口请求频率限制：20次/秒。

二、2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateCollector。
Version	是	String	公共参数，本接口取值：2018-04-16。
Region	是	String	公共参数，详见产品支持的地域列表。
CollectorName	是	String	采集器名称（1-50 个英文、汉字、数字、连接线-或下划线_）示例值：test
CollectorVersion	是	String	采集器版本（支持"6.8.15"、"7.10.2"）示例值：7.10.2
CollectorType	是	String	采集器类型（支持filebeat、metricbeat、heartbeat、auditbeat、packetbeat）示例值：filebeat
OutputInstance	是	CollectorOutputInstance	采集器输出的ES实例信息
CollectorConfigs.N	否	Array of CollectorConfigInfo	采集器配置
CVMInstanceIds.N	否	Array of String	采集器下发的CVM实例ID列表示例值：["ins-xxxxxxxx"]
TargetType	否	String	采集目标类型，CVM或者TKE示例值：TKE
ContainerClusterId	否	String	容器集群ID，采集目标为TKE时必填示例值：cls-xxxxxxx
CollectorTargets.N	否	Array of CollectorTarget	采集器配置，采集目标为TKE时必填
TagList.N	否	Array of TagInfo	标签信息

三、3. 输出参数

参数名称	类型	描述
CollectorId	String	采集器ID示例值：coll-xxxxxx
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

四、示例1 创建采集器

根据输入参数创建采集器

五、输入示例

POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCollector
<公共请求参数>
{
"CollectorType": "filebeat",
"OutputInstance": {
"InstanceId": "es-xxxxxxxx",
"Type": "elasticsearch"
},
"CVMInstanceIds": [
"ins-xxxxxxxx"
],
"CollectorConfigs": [
{
"FileContent": "test",
"FileName": "filebeat.yml"
}
],
"CollectorName": "test",
"CollectorVersion": "7.10.2"
}

六、输出示例

{
"Response": {
"CollectorId": "coll-0xxxxxxx",
"RequestId": "d7b76d5e-ad7d-4abd-b3b2-43b96dxxxxxx"
}
}

七、腾讯云 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: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee

·Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

十、命令行工具

·Tencent Cloud CLI 3.0

十一、6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
AuthFailure.UnAuthorizedOperation	操作未授权。
FailedOperation.ClusterResourceLimitError	集群资源配额限制错误。
FailedOperation.NoPayment	账户未绑定信用卡或paypal，无法支付。
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。
ResourceUnavailable	资源不可用。