調用ListDataStreams,用于查看數據流列表。僅適用于日志增強版實例。

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。

請求語法

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

請求參數

名稱 類型 位置 是否必選 示例值 描述
InstanceId String Path es-cn-nif24adwc0082****

實例ID。

isManaged Boolean Query false

是否只顯示托管中的索引,取值含義如下:

  • true:只顯示托管中的索引。
  • false(默認值):顯示全部索引。
name String Query Log1

數據流名稱。

返回數據

名稱 類型 示例值 描述
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

請求ID。

Headers Object

返回頭信息。

X-Managed-StorageSize Long 143993923932990

索引存儲總大小,單位:Byte。

X-Managed-Count Integer 100

數據流總個數。

Result Array of Result

返回的數據流詳情。

totalStorageSize Long 1788239393298

當前數據流下的全部索引,所占用的總存儲空間。單位:Byte。

indexTemplateName String template1

索引模版名稱。

ilmPolicyName String rollver1

生命周期策略名稱。

name String my-index-0001

索引名稱。

health String Green

數據流狀態,支持以下三種狀態:

  • Green:健康。
  • Yellow:報警。
  • Red:異常。
managedStorageSize Long 1788239393298

當前數據流下的托管索引,所占用的總存儲空間。單位:Byte。

indices Array of indices

當前數據流下的索引信息。

isManaged Boolean false

該字段已廢棄,無需關注。

createTime String 2018-07-13T03:58:07.253Z

查詢數據流列表的時間。

size Long 15393899

當前索引所占用的總存儲空間。單位:Byte。

managedStatus String following

索引托管狀態,支持以下三種狀態:

  • following:托管中。
  • closing:取消托管中。
  • closed:未托管。
name String Log1

數據流名稱。

health String Green

索引狀態,支持以下三種狀態:

  • Green:健康。
  • Yellow:報警。
  • Red:異常。

示例

請求示例

GET /openapi/instances/es-cn-nif24adwc0082****/data-streams HTTP/1.1

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

錯誤碼

訪問錯誤中心查看更多錯誤碼。