Get topic

Available in VPC

Get topic details.

Request

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

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

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*****' \
--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
`topicId`	String	-	Topic ID
`topicName`	String	-	Topic name
`description`	String	-	Topic description
`partitions`	Number	-	Number of topic partitions
`retentionMs`	Number	-	Topic partition message retention period (millisecond)
`status`	String	-	Topic status `CREATING` \| `CREATED` `CREATING`: Topic being created `CREATED`: Topic creation completed (active)
`tcpEndpoint`	String	-	TCP endpoint
`createdDate`	String	-	Topic creation date and time ISO 8601 format `YYYY-MM-DDThh:mm:ssZ`
`updatedDate`	String	-	Topic modification date and time ISO 8601 format `YYYY-MM-DDThh:mm:ssZ`

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:

{
    "topicId": "mgNWA*****",
    "topicName": "h4j6l-ds001",
    "description": "Data Stream Topic",
    "partitions": 3,
    "retentionMs": 86400000,
    "status": "CREATED",
    "tcpEndpoint": "cluster-1.datastream.naverncp.com:30010",
    "createdDate": "2025-05-22T10:25:19Z",
    "updatedDate": "2025-05-22T14:14:41Z"
}