---
title: "List stream sinks by paginating"
method: POST
path: "/inlong/manager/api/sink/list"
tags: ["Stream-Sink-API"]
---

# List stream sinks by paginating

`POST /inlong/manager/api/sink/list`

## Request

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

## Request body

- PagingQueryRequestForSink
  - `dataNodeName` string: Data node name
  - `inlongClusterName` string: Inlong cluster name
  - `inlongGroupId` string, required: Inlong group id
  - `inlongStreamId` string: Inlong stream id
  - `keyword` string: Keyword, can be group id, stream id or sink name
  - `orderField` string: Order field, support create_time and modify_time, default is create_time
  - `orderType` string: Order type, only support asc and desc, default is desc
  - `pageNum` integer: Current page number, default is 1
  - `pageSize` integer: Page size, default is 10
  - `sinkType` string: Sink type, such as HIVE
  - `sortConsumerGroup` string: Sort consumer group
  - `sortTaskName` string: Sort task name
  - `status` integer: Status
  - `statusList` integer[]: Sink status list

## Response `200`

OK

- ResponsePaginatedQueryResultsStreamSinkInfo
  - `data` PaginatedQueryResultsStreamSinkInfo
    - `list` StreamSinkInfo[], required: data record
      - `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
    - `pageNum` integer, required: pageNum
    - `pageSize` integer, required: pageSize
    - `total` integer, required: The total number of items matching the filter criteria
  - `errMsg` string
  - `success` boolean

## Other responses

- `201`: Created
- `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)