文档

GetDataStream - 获取Serverless数据流详情

更新时间:

获取Serverless数据流详情。

调试

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

授权信息

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

请求语法

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

请求参数

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

应用名称。

es-severless-test-app
dataStreamNamestring

数据流名称。

metrics-logs-online

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

请求 ID。

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

查询结果。

appNamestring

关联应用 Id

es-severless-test-app
regionIdstring

地域 ID。

cn-hangzhou
templateobject

数据流模板。

mappingsarray

索引字段设置。

DataStreamMapping

索引模板的 mappings 配置。

deletePhasestring

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

150d
dataStreamIdstring

数据流 ID。 (17 位)

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

数据流名称。

metrics-logs-online
typestring

数据流类型:

  • logs
  • metrics
logs
createTimestring

数据流创建时间。

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

查询时间戳字段名。

@timestamp

示例

正常返回示例

JSON格式

{
  "requestId": "2C5DAA30-****-5181-9B87-9D6181016197",
  "result": {
    "appName": "es-severless-test-app\n",
    "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",
    "dataStreamId": "ds-***(17位id)**",
    "dataStreamName": "metrics-logs-online",
    "type": "logs",
    "createTime": "2022-12-27T07:09:11.000Z",
    "timeStampKey": "@timestamp"
  }
}

错误码

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

  • 本页导读 (1)
文档反馈