ListDataStreams - ES集群数据流列表-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

获取Elasticserch集群中，索引数据流列表。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:ListDataStreams

none

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instanceId}

无

请求语法

GET /openapi/instances/{InstanceId}/data-streams HTTP/1.1

路径参数

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

请求参数

名称	类型	必填	描述	示例值
isManaged	boolean	否	是否只显示托管中的索引，取值含义如下： true：只显示托管中的索引。 false（默认值）：显示全部索引。	false
name	string	否	数据流名称。	Log1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	F99407AB-2FA9-489E-A259-40CF6DCC****
Headers	object	返回头信息。
X-Managed-StorageSize	integer	索引存储总大小，单位：Byte。	143993923932990
X-Managed-Count	integer	数据流总个数。	100
Result	array<object>	返回的数据流详情。
	array<object>
indexTemplateName	string	索引模版名称。	template1
indices	array<object>	当前数据流下的索引信息。
	object
managedStatus	string	索引托管状态，支持以下三种状态： following：托管中。 closing：取消托管中。 closed：未托管。	following
size	integer	当前索引所占用的总存储空间。单位：Byte。	15393899
createTime	string	查询数据流列表的时间。	2018-07-13T03:58:07.253Z
name	string	数据流名称。	Log1
health	string	索引状态，支持以下三种状态： Green：健康。 Yellow：报警。 Red：异常。	Green
isManaged	boolean	该字段已废弃，无需关注。	false
name	string	索引名称。	my-index-0001
health	string	数据流状态，支持以下三种状态： Green：健康。 Yellow：报警。 Red：异常。	Green
ilmPolicyName	string	生命周期策略名称。	rollver1
totalStorageSize	integer	当前数据流下的全部索引，所占用的总存储空间。单位：Byte。	1788239393298
managedStorageSize	integer	当前数据流下的托管索引，所占用的总存储空间。单位：Byte。	1788239393298

示例

正常返回示例

JSON格式

{
  "RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC****",
  "Headers": {
    "X-Managed-StorageSize": 143993923932990,
    "X-Managed-Count": 100
  },
  "Result": [
    {
      "indexTemplateName": "template1",
      "indices": [
        {
          "managedStatus": "following",
          "size": 15393899,
          "createTime": "2018-07-13T03:58:07.253Z",
          "name": "Log1",
          "health": "Green",
          "isManaged": false
        }
      ],
      "name": "my-index-0001",
      "health": "Green",
      "ilmPolicyName": "rollver1",
      "totalStorageSize": 1788239393298,
      "managedStorageSize": 1788239393298
    }
  ]
}

错误码

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

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

变更历史

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