DescribePipeline - 获取Logstash管道信息-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

获取Logstash实例的管道信息。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:DescribePipeline

get

*Logstash

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

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	Logstash 实例 ID。	ls-cn-oew1qbgl****
PipelineId	string	是	管道 ID。	pipeline_test

请求参数

名称

类型

必填

描述

示例值

当前API无需请求参数

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	829F38F6-E2D6-4109-90A6-888160BD1***
Result	object	返回的管道信息，更多详细信息请参见logstash.yml。
pipelineId	string	管道 ID。	pipeline_test
gmtUpdateTime	string	管道更新时间。	2020-06-20T07:26:47.000+0000
queueType	string	队列类型。支持： MEMORY：基于内存的传统队列。 PERSISTED：基于磁盘的 ACKed 队列（持久队列）。	MEMORY
queueCheckPointWrites	integer	队列检查点写入数。	1024
queueMaxBytes	integer	队列的总容量（以字节数表示）。单位：MB。	1024
config	string	管道具体配置。	input { } filter { } output { }
batchDelay	integer	管道批延迟。单位：毫秒。	50
workers	integer	管道工作线程数。	2
description	string	管道描述。	this is a test
gmtCreatedTime	string	管道创建时间。	2020-06-20T07:26:47.000+0000
batchSize	integer	管道批大小。	125
pipelineStatus	string	管道状态。支持： NOT_DEPLOYED：未部署 RUNNING：运行中 DELETED：已删除（控制台不展示此状态）	RUNNING

说明

未配置的管道参数将使用系统默认值，不会在返回结果中显示。

示例

正常返回示例

JSON格式

{
  "RequestId": "829F38F6-E2D6-4109-90A6-888160BD1***",
  "Result": {
    "pipelineId": "pipeline_test",
    "gmtUpdateTime": "2020-06-20T07:26:47.000+0000",
    "queueType": "MEMORY",
    "queueCheckPointWrites": 1024,
    "queueMaxBytes": 1024,
    "config": "input {  }  filter {  }  output {  }",
    "batchDelay": 50,
    "workers": 2,
    "description": "this is a test",
    "gmtCreatedTime": "2020-06-20T07:26:47.000+0000",
    "batchSize": 125,
    "pipelineStatus": "RUNNING"
  }
}

错误码

HTTP status code	错误码	错误信息
400	ComponentCodeValueError	component value is disable
401	UserNotOpen	Aliyun account is not open elasticsearch
401	StsRoleAccountNoPermission	Role account has no permission or expired
401	SubAccountNoPermission	Aliyun sub account has no permission, please authorize your sub account in Aliyun RAM
401	UserUnauthorized	Authentication required

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

变更历史

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