在列表中展示所有或指定Logstash实例的详细信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
elasticsearch:ListLogstash |
list |
*全部资源
|
无 | 无 |
请求语法
GET /openapi/logstashes HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| page |
integer |
否 |
实例列表的页码。默认值：1。 |
1 |
| size |
integer |
否 |
分页查询时设置的每页条数。默认值：20。 |
10 |
| description |
string |
否 |
实例名称，支持模糊查询。例如查询名称为 abc 的实例，则可能返回名称为 abc、abcde、xyabc、xabcy 的所有实例。 |
ls-cn-abc |
| instanceId |
string |
否 |
实例 ID。 |
ls-cn-n6w1o5jq**** |
| version |
string |
否 |
实例版本。 |
5.5.3_with_X-Pack |
| resourceGroupId |
string |
否 |
资源组 ID。 |
rg-acfm2h5vbzd**** |
| tags |
string |
否 |
实例标签。 |
[{"tagKey":"key1","tagValue":"value1"}] |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
AC442F2F-5068-4434-AA21-E78947A9**** |
| Headers |
object |
请求头信息。 |
|
| X-Total-Count |
integer |
实例总记录数。 |
10 |
| Result |
array<object> |
当前请求返回的实例列表。 |
|
|
array<object> |
|||
| paymentType |
string |
实例的付费模式。支持：prepaid（包年包月）、postpaid（按量付费）。 |
postpaid |
| nodeAmount |
integer |
实例的节点个数。 |
2 |
| description |
string |
实例名称。 |
ls-cn-abc |
| createdAt |
string |
实例创建时间。 |
2018-07-13T03:58:07.253Z |
| status |
string |
实例的状态。支持四种状态：正常（active）、生效中（activating）、冻结（inactive）和失效（invalid）。 |
active |
| updatedAt |
string |
实例最后更新的时间。 |
2018-07-18T10:10:04.484Z |
| instanceId |
string |
实例 ID。 |
ls-cn-n6w1o5jq**** |
| version |
string |
实例版本。目前仅支持 6.7.0_with_X-Pack、7.4.0_with_X-Pack。 |
6.7.0_with_X-Pack |
| Tags |
array<object> |
实例标签。 |
|
|
object |
|||
| TagValue |
string |
标签值。 |
dev |
| TagKey |
string |
标签键。 |
env |
| nodeSpec |
object |
数据节点的配置信息。 |
|
| spec |
string |
实例规格。 |
logstash.n4.small |
| disk |
integer |
节点磁盘大小。 |
50 |
| diskEncryption |
boolean |
是否使用磁盘加密：
|
false |
| diskType |
string |
磁盘类型。 |
cloud_ssd |
| networkConfig |
object |
网络配置。 |
|
| vpcId |
string |
专有网络 ID。 |
vpc-abc |
| vsArea |
string |
实例所在的可用区。 |
cn-hangzhou-* |
| type |
string |
网络类型，目前仅支持专有网络 VPC（Virtual Private Cloud）。 |
vpc |
| vswitchId |
string |
交换机 ID。 |
vsw-def |
| resourceGroupId |
string |
Logstash 实例所属的资源组 ID。 |
rg-acfm2h5vbzd**** |
| endTime |
integer |
包年包月实例，最后的失效时间。 |
4928745600000 |
返回数据中还包含以下参数。
| 名称 | 类型 | 示例值 | 描述 |
| enablePublic | Boolean | false | 是否开启公网访问，默认为 false。 |
| commodityCode | String | elasticsearch_logstash_post | 产品代码。 |
| endTime | Long | 4749897600000 | 包年包月实例，最后的失效时间。 |
| clusterTasks | Array | [] | 实例的任务列表。 |
| resourceGroupId | String | rg-acfm2h5vbzd**** | 实例所在的资源组 ID。 |
| zoneCount | Integer | 1 | 实例的可用区个数。 |
| protocol | String | HTTP | 实例的访问协议。 |
| zoneInfos | Array | 可用区信息。 | |
| └zoneId | String | cn-hangzhou-i | 可用区 ID。 |
| └status | String | NORMAL | 可用区状态。支持：ISOLATION（下线）、NORMAL（正常）。 |
| instanceType | String | logstash | 实例类型。 |
| inited | Boolean | true | 实例是否已完成初始化。 |
| config | Array | [] | 实例配置。 |
| endpointList | Array | 节点信息。 | |
| └host | String | 172.16.xx.xx | 节点的 IP 地址。 |
| └port | Integer | 9200 | 节点的访问端口号。 |
| └zoneId | String | cn-hangzhou-i | 节点所在的可用区 ID。 |
└表示子参数。
示例
正常返回示例
JSON格式
{
"RequestId": "AC442F2F-5068-4434-AA21-E78947A9****",
"Headers": {
"X-Total-Count": 10
},
"Result": [
{
"paymentType": "postpaid",
"nodeAmount": 2,
"description": "ls-cn-abc",
"createdAt": "2018-07-13T03:58:07.253Z",
"status": "active",
"updatedAt": "2018-07-18T10:10:04.484Z",
"instanceId": "ls-cn-n6w1o5jq****",
"version": "6.7.0_with_X-Pack",
"Tags": [
{
"TagValue": "dev",
"TagKey": "env"
}
],
"nodeSpec": {
"spec": "logstash.n4.small",
"disk": 50,
"diskEncryption": false,
"diskType": "cloud_ssd"
},
"networkConfig": {
"vpcId": "vpc-abc",
"vsArea": "cn-hangzhou-*",
"type": "vpc",
"vswitchId": "vsw-def"
},
"resourceGroupId": "rg-acfm2h5vbzd****",
"endTime": 4928745600000
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。