1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
查询用户该地域下符合条件的所有Logstash实例
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeLogstashInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Zone | 否 | String | 实例所属可用区，不传则默认所有可用区 示例值：ap-guangzhou |
| InstanceIds.N | 否 | Array of String | 实例ID列表 示例值：[] |
| InstanceNames.N | 否 | Array of String | 实例名称列表 示例值：test |
| Offset | 否 | Integer | 分页起始值, 默认值0 示例值：0 |
| Limit | 否 | Integer | 分页大小，默认值20 示例值：0 |
| OrderByKey | 否 | Integer | 排序字段 示例值：1 |
| OrderByType | 否 | Integer | 排序方式 示例值：1 |
| VpcIds.N | 否 | Array of String | VpcId 筛选项 示例值：vpc-imhajivf |
| TagList.N | 否 | Array of TagInfo | 标签信息列表 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 返回的实例个数 示例值：2 |
| InstanceList | Array of LogstashInstanceInfo | 实例详细信息列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询Logstash实例
根据给定条件查询符合条件的Logstash实例并返回详细信息
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLogstashInstances
<公共请求参数>
{}输出示例
{
"Response": {
"TotalCount": 2,
"InstanceList": [
{
"InstanceId": "ls-ee6o1285",
"InstanceName": "wurong-20200927-ls01",
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-3",
"AppId": 1257780094,
"Uin": "100007799884",
"VpcId": "vpc-ck9abamb",
"SubnetId": "subnet-gmmt588q",
"Status": 1,
"ChargeType": "POSTPAID_BY_HOUR",
"ChargePeriod": 0,
"RenewFlag": "",
"NodeType": "LOGSTASH.S1.MEDIUM4",
"NodeNum": 5,
"DiskType": "CLOUD_SSD",
"DiskSize": 100,
"LogstashVersion": "6.8.10",
"LicenseType": "xpack",
"YMLConfig": "",
"BindedESInstanceId": "",
"Nodes": [
{
"NodeId": "100003160102096307",
"Ip": "10.0.3.21",
"Port": 9600
},
{
"NodeId": "100003160102096308",
"Ip": "10.0.3.134",
"Port": 9600
},
{
"NodeId": "100003160102514909",
"Ip": "10.0.3.151",
"Port": 9600
},
{
"NodeId": "100003160102514910",
"Ip": "10.0.3.160",
"Port": 9600
},
{
"NodeId": "100003160102514911",
"Ip": "10.0.3.157",
"Port": 9600
}
],
"ExtendedFiles": [
{
"Name": "xx",
"Size": 1
}
],
"CpuNum": 1,
"MemSize": 1,
"OperationDuration": {
"TimeStart": "xx",
"TimeZone": "xx",
"Periods": [
1
],
"TimeEnd": "xx"
},
"TagList": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"CreateTime": "2020-09-25 16:02:43",
"UpdateTime": "2020-09-27 16:10:17",
"Deadline": "2017-12-04 00:00:00"
},
{
"InstanceId": "ls-g8k9pzj9",
"InstanceName": "wurong-20200915-ls01",
"Region": "ap-guangzhou",
"Zone": "ap-guangzhou-3",
"AppId": 1257780094,
"Uin": "100007799884",
"VpcId": "vpc-ck9abamb",
"SubnetId": "subnet-gmmt588q",
"Status": 1,
"ChargeType": "POSTPAID_BY_HOUR",
"ChargePeriod": 0,
"RenewFlag": "",
"NodeType": "LOGSTASH.S1.MEDIUM4",
"NodeNum": 5,
"DiskType": "CLOUD_SSD",
"DiskSize": 100,
"LogstashVersion": "6.8.13",
"YMLConfig": "",
"LicenseType": "xpack",
"BindedESInstanceId": "",
"Nodes": [
{
"NodeId": "100003160015134602",
"Ip": "10.0.3.136",
"Port": 9600
},
{
"NodeId": "100003160015134603",
"Ip": "10.0.3.249",
"Port": 9600
},
{
"NodeId": "100003160015279213",
"Ip": "10.0.3.227",
"Port": 9600
},
{
"NodeId": "100003160015279214",
"Ip": "10.0.3.248",
"Port": 9600
},
{
"NodeId": "100003160015279215",
"Ip": "10.0.3.83",
"Port": 9600
}
],
"ExtendedFiles": [
{
"Name": "xx",
"Size": 1
}
],
"CpuNum": 1,
"MemSize": 1,
"OperationDuration": {
"TimeStart": "xx",
"TimeZone": "xx",
"Periods": [
1
],
"TimeEnd": "xx"
},
"TagList": [
{
"TagKey": "xx",
"TagValue": "xx"
}
],
"CreateTime": "2020-09-15 14:29:06",
"UpdateTime": "2020-09-15 15:28:27",
"Deadline": "2017-12-04 00:00:00"
}
],
"RequestId": "5d5a201f-0a3d-485f-a82f-3c73ccxxxxxx"
}
}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.UnAuthorizedOperation | 操作未授权。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |