文档

ListDataStreams - 查询Serverless数据流列表

查询Serverless数据流列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /openapi/xops/instances/{appName}/data-streams

请求参数

名称类型必填描述示例值
appNamestring

应用名称。

es-severless-test-app
dataStreamNamestring

数据流名称。

metrics-logs-online
regionIdstring

地域 ID。

cn-hangzhou
pageNumberinteger

页码,默认 pageNumber = 1

2
pageSizeinteger

每页返回的结果数量。默认值:10,最小值:1,最大值:100。

20

返回参数

名称类型描述示例值
object

Schema of Response

resultobject []

返回结果的集合。

appNamestring

数据流所属的应用。

es-severless-test-app
regionIdstring

地域 ID。

cn-hangzhou
templateobject

数据流模板。

mappingsarray

索引字段设置。

DataStreamMapping

索引模板的 mappings 配置。

deletePhasestring

数据保存时间,数据自动删除触发时间。单位:天

150d
dataStreamNamestring

数据流名称。

metrics-logs-online
dataStreamIdstring

数据流 ID。(17 位)

ds-***(17位id)**
typestring

数据流类型:

  • logs
  • metrics
logs
createTimestring

数据流创建时间

2022-12-27T07:09:11.000Z
timeStampKeystring

查询时间戳字段名

@timestamp
requestIdstring

请求 ID

2C5DAA30-****-5181-9B87-9D6181016197
totalCountinteger

返回的数据流总数。

68

示例

正常返回示例

JSON格式

{
  "result": [
    {
      "appName": "es-severless-test-app",
      "regionId": "cn-hangzhou",
      "template": {
        "mappings": [
          {
            "type": "",
            "caseSensitive": true,
            "docValues": true,
            "index": true,
            "tokenizeOnChars": [
              ""
            ],
            "key": "",
            "properties": [
              {
                "type": "",
                "caseSensitive": true,
                "docValues": true,
                "index": true,
                "tokenizeOnChars": [
                  ""
                ],
                "key": "",
                "properties": [
                  {
                    "type": "",
                    "caseSensitive": true,
                    "docValues": true,
                    "index": true,
                    "tokenizeOnChars": [
                      ""
                    ],
                    "key": "",
                    "properties": []
                  }
                ]
              }
            ]
          }
        ],
        "downsamples": [
          {
            "interval": "",
            "settings": {
              "deletePhase": ""
            }
          }
        ]
      },
      "deletePhase": "150d",
      "dataStreamName": "metrics-logs-online",
      "dataStreamId": "ds-***(17位id)**",
      "type": "logs",
      "createTime": "2022-12-27T07:09:11.000Z",
      "timeStampKey": "@timestamp"
    }
  ],
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197",
  "totalCount": 68
}

错误码

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

  • 本页导读 (1)