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

# Get inlong stream brief

`GET /inlong/manager/api/stream/getBrief`

## Request

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

## Query parameters

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

## Response `200`

OK

- ResponseInlongStreamBriefInfo
  - `data` InlongStreamBriefInfo
    - `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
    - `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
    - `name` string: Inlong stream name
    - `peakRecords` integer: peak access per second, unit: bars per second
    - `sinkList` SinkBriefInfo[]: Sink brief list
      - `clusterId` integer: Sink cluster ID
      - `clusterUrl` string: Sink cluster URL
      - `id` integer
      - `inlongGroupId` string: Inlong group id
      - `inlongStreamId` string: Inlong stream id
      - `sinkName` string: Sink name, unique in one stream
      - `sinkType` string: Sink type, such as HIVE
    - `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)