---
title: "Get inlong stream"
method: GET
path: "/inlong/manager/api/stream/get"
tags: ["Inlong-Stream-API"]
---

# Get inlong stream

`GET /inlong/manager/api/stream/get`

## Request

- The document declares no server URL.
- Auth: none declared

## Query parameters

- `groupId` string, required
- `streamId` string, required

## Response `200`

OK

- ResponseInlongStreamInfo
  - `data` InlongStreamInfo
    - `createTime` string, date-time
    - `creator` string: Name of creator
    - `dailyRecords` integer: Number of access items per day, unit: 10,000 items per day
    - `dailyStorage` integer: Access size per day, unit: GB per day
    - `dataEncoding` string: Data encoding format: UTF-8, GBK
    - `dataEscapeChar` string: Data field escape symbol
    - `dataSeparator` string: Data separator
    - `dataType` string: Data type, including: TEXT, KV, etc.
    - `description` string: Inlong stream description
    - `extList` InlongStreamExtensionInformation[]: Inlong stream Extension properties
      - `id` integer: id
      - `inlongGroupId` string, required: inlong group id
      - `inlongStreamId` string, required: inlong stream id
      - `keyName` string: property name
      - `keyValue` string: property value
    - `extParams` string: Extended params, will be saved as JSON string
    - `fieldList` StreamFieldConfiguration[]: Field list
      - `extParams` string: Extra Param in JSON style
      - `fieldComment` string: Field comment
      - `fieldFormat` string: Field format, including: MICROSECONDS, MILLISECONDS, SECONDS, SQL, ISO_8601 and custom such as 'yyyy-MM-dd HH:mm:ss'. This is mainly used for time format
      - `fieldName` string, required: Field name
      - `fieldType` string, required: Field type
      - `fieldValue` string: Field value for constants
      - `id` integer: Field index
      - `inlongGroupId` string, required: inlong group id
      - `inlongStreamId` string, required: inlong stream id
      - `isMetaField` integer: Is this field a meta field, 0: no, 1: yes
      - `isPredefinedField` integer: Is predefined field, 1: yes, 0: no
      - `metaFieldName` string: Meta field name
      - `originFieldName` string: Origin field name before transform operation
      - `originNodeName` string: Origin node name which stream fields belong
      - `preExpression` string: Value expression of predefined field
    - `id` integer: Primary key
    - `ignoreParseError` boolean: Whether to ignore the parse errors of field value
    - `inlongGroupId` string: Inlong group id
    - `inlongStreamId` string: Inlong stream id
    - `maxLength` integer: The maximum length of a single piece of data, unit: Byte
    - `modifier` string: Name of modifier
    - `modifyTime` string, date-time
    - `mqResource` string: MQ resource for inlong stream. Default: ${inlongStreamId}
    - `name` string, required: Inlong stream name
    - `peakRecords` integer: peak access per second, unit: bars per second
    - `previousStatus` integer: Previous status
    - `sinkList` StreamSinkInfo[]: Stream sink infos
      - `createTime` string, date-time
      - `creator` string: Creator
      - `dataEncoding` string: Encoding type for sink, default is UTF-8
      - `dataNodeName` string: Data node name
      - `description` string: Sink description
      - `enableCreateResource` integer: Whether to enable create sink resource? 0: disable, 1: enable. Default is 1
      - `fieldList` StreamFieldConfiguration[]
        - `extParams` string: Extra Param in JSON style
        - `fieldComment` string: Field comment
        - `fieldFormat` string: Field format, including: MICROSECONDS, MILLISECONDS, SECONDS, SQL, ISO_8601 and custom such as 'yyyy-MM-dd HH:mm:ss'. This is mainly used for time format
        - `fieldName` string, required: Field name
        - `fieldType` string, required: Field type
        - `fieldValue` string: Field value for constants
        - `id` integer: Field index
        - `inlongGroupId` string, required: inlong group id
        - `inlongStreamId` string, required: inlong stream id
        - `isMetaField` integer: Is this field a meta field, 0: no, 1: yes
        - `isPredefinedField` integer: Is predefined field, 1: yes, 0: no
        - `metaFieldName` string: Meta field name
        - `originFieldName` string: Origin field name before transform operation
        - `originNodeName` string: Origin node name which stream fields belong
        - `preExpression` string: Value expression of predefined field
      - `id` integer: Sink id
      - `inlongClusterName` string: Inlong cluster name
      - `inlongGroupId` string: Inlong group id
      - `inlongStreamId` string: Inlong stream id
      - `modifier` string: Modifier
      - `modifyTime` string, date-time
      - `operateLog` string: Backend operation log
      - `postNodes` string[]
      - `preNodes` string[]
      - `previousStatus` integer: Previous status
      - `properties` object: Properties for sink
      - `sinkFieldList` SinkFieldInfo[]: Sink field list
        - `extParams` string: Extra Param in JSON style
        - `fieldComment` string: Field comment
        - `fieldFormat` string: Field format, including: MICROSECONDS, MILLISECONDS, SECONDS, SQL, ISO_8601 and custom such as 'yyyy-MM-dd HH:mm:ss'. This is mainly used for time format
        - `fieldName` string, required: Field name
        - `fieldType` string, required: Field type
        - `id` integer: Field index
        - `inlongGroupId` string, required: inlong group id
        - `inlongStreamId` string, required: inlong stream id
        - `isMetaField` integer: Is this field a meta field, 0: no, 1: yes
        - `metaFieldName` string: Meta field name
        - `originFieldName` string: Origin field name before transform operation
        - `originNodeName` string: Origin node name which stream fields belong
        - `sinkType` string: sink type
        - `sourceFieldName` string: Source field name
        - `sourceFieldType` string: Source field type
      - `sinkName` string: Sink name, unique in one stream.
      - `sinkType` string: Sink type, including: HIVE, ICEBERG, etc.
      - `sortConsumerGroup` string: Sort consumer group
      - `sortTaskName` string: Sort task name
      - `status` integer: Status
      - `version` integer: Version number
    - `sourceList` StreamSourceInfo[]: Stream source infos
      - `agentIp` string: Ip of the agent running the task
      - `createTime` string, date-time
      - `creator` string: Creator
      - `dataNodeName` string: Data node name
      - `fieldList` StreamFieldConfiguration[]
        - `extParams` string: Extra Param in JSON style
        - `fieldComment` string: Field comment
        - `fieldFormat` string: Field format, including: MICROSECONDS, MILLISECONDS, SECONDS, SQL, ISO_8601 and custom such as 'yyyy-MM-dd HH:mm:ss'. This is mainly used for time format
        - `fieldName` string, required: Field name
        - `fieldType` string, required: Field type
        - `fieldValue` string: Field value for constants
        - `id` integer: Field index
        - `inlongGroupId` string, required: inlong group id
        - `inlongStreamId` string, required: inlong stream id
        - `isMetaField` integer: Is this field a meta field, 0: no, 1: yes
        - `isPredefinedField` integer: Is predefined field, 1: yes, 0: no
        - `metaFieldName` string: Meta field name
        - `originFieldName` string: Origin field name before transform operation
        - `originNodeName` string: Origin node name which stream fields belong
        - `preExpression` string: Value expression of predefined field
      - `id` integer: Source id
      - `ignoreParseError` boolean: Whether to ignore the parse errors of field value, true as default
      - `inlongClusterName` string: Inlong cluster name
      - `inlongClusterNodeTag` string: Inlong cluster node tag
      - `inlongGroupId` string: Inlong group id
      - `inlongStreamId` string: Inlong stream id
      - `modifier` string: Modifier
      - `modifyTime` string, date-time
      - `postNodes` string[]
      - `preNodes` string[]
      - `previousStatus` integer: Previous status
      - `properties` object: Properties for source
      - `serializationType` string: Data Serialization, support: csv, json, canal, avro, etc
      - `snapshot` string: Snapshot of this source task
      - `sourceName` string: Source name, unique in one stream
      - `sourceType` string: Source type, including: FILE, KAFKA, etc.
      - `status` integer: Status
      - `subSourceList` SubSourceDTO[]: Sub source information of existing agents
        - `agentIp` string: Agent ip of sub source
        - `id` integer: stream source id
        - `status` integer: Status of sub source
        - `templateId` integer: Template source id this sub source belongs to
      - `templateId` integer: Null if not a sub source
      - `uuid` string: Mac uuid of the agent running the task
      - `version` integer: Version
    - `status` integer: Status
    - `storagePeriod` integer: Data storage period, unit: day
    - `syncSend` integer: Whether to send synchronously, 0: no, 1: yes
    - `version` integer: Version number
    - `wrapWithInlongMsg` boolean: Whether the message body wrapped with InlongMsg
  - `errMsg` string
  - `success` boolean

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api.md) - [All operations](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api/revisions/41c687f48683?raw)