Get connector

Available in VPC

Get connector information.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v1/topics/{topicId}/connectors

Request headers

For information about the headers common to all Data Stream APIs, see Data Stream request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`topicId`	String	Required	Topic ID See Get topic list.

Request example

The request example is as follows:

curl --location --request GET 'https://datastream.apigw.ntruss.com/api/v1/topics/mgNWA*****/connectors' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`id`	String	-	Connector ID
`topicId`	String	-	Topic ID
`status`	String	-	Connector status `RUNNING` \| `FAILED` `RUNNING`: Normal operation (active) `FAILED`: Operation error If the bucket is deleted after setting up the connector If you access the bucket is unavailable because access control is set on it after setting up the connector If the bucket is set as a locked bucket after setting up the connector
`connectorName`	String	-	Connector name
`description`	String	-	Connector description
`consumerSpec`	String	-	Consumer specifications (connector processing performance) `SMALL` \| `MEDIUM` `SMALL`: It supports up to 250 Kbytes per second per partition with a single container. `MEDIUM`: It supports up to 500 Kbytes per second per partition with 2 containers.
`location`	String	-	Storage path
`locationWithTopicName`	String	-	Storage path containing the topic name directory
`objectStorageLocation`	String	-	Object Storage path
`dateFormat`	String	-	Whether to use date formatting for sub-storage paths `NONE` \| `YEAR` \| `MONTH` \| `DAY` \| `HOUR` `NONE`: Not use `YEAR`: Use year={yyyy}/ `MONTH`: Use year={yyyy}/month={MM}/ `DAY`: Use year={yyyy}/month={MM}/day={dd}/ `HOUR`: Use year={yyyy}/month={MM}/day={dd}/hour={HH}/
`exportType`	String	-	Connector type `OBJECT_STORAGE` (valid value)
`includeTopicInPath`	Boolean	-	Whether to create a topic name directory in the storage path `true` \| `false` `true`: Create `false`: Not create
`createdDate`	String	-	Connector creation date and time ISO 8601 format `YYYY-MM-DDThh:mm:ssZ`
`roleNrn`	String	-	Resource identification value for the role of the Data Stream service used to access the connector
`flushInterval`	Number	-	File creation interval when recording messages to storage (minute) 1-10 (default: 10)
`flushCount`	Number	-	Stored message count when recording messages to storage (count) 20-100 (default: 100)
`groupId`	String	-	Connector group ID
`failedMessage`	String	-	If the status of the connector is `FAILED`, the reason for the failure
`failedDate`	String	-	If the status of the connector is `FAILED`, the date and time it was changed to the Failed status

Response status codes

For information about the HTTP status codes common to all Data Stream APIs, see Data Stream response status codes.

Response example

The response example is as follows:

Connector status: Normal

[
    {
        "id": "xlThN*****",
        "topicId": "mgNWA*****",
        "status": "RUNNING",
        "connectorName": "connector-h4j6l-ds001",
        "description": "",
        "consumerSpec": "SMALL",
        "location": "s3a://datastream001",
        "locationWithTopicName": "s3a://datastream001",
        "objectStorageLocation": "https://console.ncloud.com/objectStorage/objectStorageList?bucketName=datastream001&folderPrefix=",
        "dateFormat": "NONE",
        "exportType": "OBJECT_STORAGE",
        "includeTopicInPath": false,
        "createdDate": "2025-05-22T16:39:21Z",
        "roleNrn": "nrn:PUB:IAM::****:Role/********-36**-11**-a**-24****b4",
        "flushInterval": 10,
        "flushCount": 100,
        "groupId": "connect-h**-ds0**"
    }
]

Connector status: Failed

[
  {
    "id": "1c*****",
    "topicId": "15*****",
    "status": "FAILED",
    "connectorName": "connector-n***-c***",
    "description": "",
    "consumerSpec": "SMALL",
    "location": "s3a://stream-***",
    "locationWithTopicName": "s3a://stream-***/n***-c***",
    "objectStorageLocation": "https://beta-console.ncloud.com/objectStorage/objectStorageList?bucketName=stream-***&folderPrefix=n***-c***",
    "dateFormat": "HOUR",
    "exportType": "OBJECT_STORAGE",
    "includeTopicInPath": true,
    "createdDate": "2025-07-23T14:29:57Z",
    "roleNrn": "nrn:PUB:IAM::***:Role/8733****-10**-1**-a1**-246*****c4",
    "flushInterval": 10,
    "flushCount": 100,
    "groupId": "connect-n***-c***",
    "failedMessage": "Failed to access ObjectStorage: an error occurred during the connection or request.",
    "failedDate": "2025-07-23T14:40:26"
  }
]