DescribeLogstash - 查询Logstash实例信息-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

查询Logstash实例详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:DescribeLogstash

get

*Logstash

acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#logstashesId}

无

请求语法

GET /openapi/logstashes/{InstanceId} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ls-cn-s9dsk3k4k****

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	C9334241-4837-46C2-B24B-9BDC517318DE
Result	object	当前实例的详细信息。
config	object	实例配置信息。	{"slowlog.threshold.warn": "2s","slowlog.threshold.info": "1s","slowlog.threshold.debug": "500ms","slowlog.threshold.trace": "100ms" }
paymentType	string	实例的付费模式。支持： prepaid：包年包月 postpaid：按量付费	prepaid
ResourceGroupId	string	实例所属的资源组 ID。	rg-aekzvowej3i****
nodeAmount	integer	实例的节点个数。	2
description	string	实例名称。	ls-cn-abc
createdAt	string	实例创建时间。	2020-02-06T14:12:03.672Z
status	string	实例的状态。支持四种状态：正常：active 生效中：activating 冻结：inactive 失效：invalid	active
vpcInstanceId	string	实例所属的 VPC ID。	vpc-bp16k1dvzxtmagcva****
updatedAt	string	实例最后更新的时间。	2020-02-06T14:22:36.850Z
version	string	实例版本。	7.4.0_with_X-Pack
instanceId	string	实例 ID。	ls-cn-abc
endpointList	array<object>	节点的访问信息。
	object
zoneId	string	节点所在的可用区 ID。	cn-hangzhou-b
port	string	端口号。	9600
host	string	节点的 IP 地址。	172.16..
Tags	array<object>	实例标签。
	object
tagKey	string	标签键。	env
tagValue	string	标签值。	dev
ZoneInfos	array<object>	可用区信息。
	object
status	string	可用区状态。支持： ISOLATION：下线 NORMAL：正常	NORMAL
zoneId	string	可用区 ID。	cn-hangzhou-b
ExtendConfigs	array<object>	Logstash 实例扩展配置列表。
	object	集群扩展参数配置。	[{ "configType": "aliVersion","aliVersion": "ali1.3.0" }]
nodeSpec	object	节点的配置信息。
spec	string	节点的规格。	elasticsearch.sn1ne.large
disk	integer	节点的磁盘大小。	20
diskEncryption	boolean	是否使用云盘加密： true：使用 false：不使用	true
diskType	string	节点的磁盘类型。	cloud_ssd
networkConfig	object	网络配置。
vpcId	string	专有网络 ID。	vpc-bp16k1dvzxtmagcva****
vsArea	string	实例所在的可用区。	cn-hangzhou-*
type	string	网络类型。目前只支持专有网络 VPC（Virtual Private Cloud）。	vpc
vswitchId	string	虚拟交换机 ID。	vsw-bp1k4ec6s7sjdbudw****
endTime	integer	实例到期时间，Unix 毫秒时间戳。	1715826092044

更多参数说明请参见 ListLogstash 。

示例

正常返回示例

JSON格式

{
  "RequestId": "C9334241-4837-46C2-B24B-9BDC517318DE",
  "Result": {
    "config": {
      "slowlog.threshold.warn": "2s",
      "slowlog.threshold.info": "1s",
      "slowlog.threshold.debug": "500ms",
      "slowlog.threshold.trace": "100ms"
    },
    "paymentType": "prepaid",
    "ResourceGroupId": "rg-aekzvowej3i****",
    "nodeAmount": 2,
    "description": "ls-cn-abc",
    "createdAt": "2020-02-06T14:12:03.672Z",
    "status": "active",
    "vpcInstanceId": "vpc-bp16k1dvzxtmagcva****",
    "updatedAt": "2020-02-06T14:22:36.850Z",
    "version": "7.4.0_with_X-Pack",
    "instanceId": "ls-cn-abc",
    "endpointList": [
      {
        "zoneId": "cn-hangzhou-b",
        "port": "9600",
        "host": "172.16.**.**"
      }
    ],
    "Tags": [
      {
        "tagKey": "env",
        "tagValue": "dev"
      }
    ],
    "ZoneInfos": [
      {
        "status": "NORMAL",
        "zoneId": "cn-hangzhou-b"
      }
    ],
    "ExtendConfigs": [
      [
        {
          "configType": "aliVersion",
          "aliVersion": "ali1.3.0"
        }
      ]
    ],
    "nodeSpec": {
      "spec": "elasticsearch.sn1ne.large",
      "disk": 20,
      "diskEncryption": true,
      "diskType": "cloud_ssd"
    },
    "networkConfig": {
      "vpcId": "vpc-bp16k1dvzxtmagcva****",
      "vsArea": "cn-hangzhou-*",
      "type": "vpc",
      "vswitchId": "vsw-bp1k4ec6s7sjdbudw****"
    },
    "endTime": 1715826092044
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。