Available in VPC
Cloud Data Streaming Service is a NAVER Cloud Platform service that allows you to easily deploy, protect, operate, and expand Apache Kafka clusters, an open source platform for real-time streaming data pipelines and application builds. Cloud Data Streaming Service provides APIs for cluster, monitoring, and config group features in RESTful format.
Common Cloud Data Streaming Service settings
The following describes commonly used request and response formats in Cloud Data Streaming Service APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://clouddatastreamingservice.apigw.ntruss.com
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256)
|
Content-type |
Optional | Request data format
|
Response
The following describes the common response format.
Response status codes
Cloud Data Streaming Service APIs use NAVER Cloud Platform's common response status codes. For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Cloud Data Streaming Service API
The following describes the APIs provided by Cloud Data Streaming Service.
Cluster
The following describes the cluster-related APIs.
| API | Description |
|---|---|
| Reset account password | Reset the CMAK access account password for a Cloud Data Streaming Service cluster. |
| Get version | Get available Cloud Data Streaming Service versions. |
| Upgrade version | Cloud Data Streaming Service version upgrade |
| Pre-check version upgrade | Pre-check Cloud Data Streaming Service version upgrade. |
| Get version upgrade status | Get the progress status of Cloud Data Streaming Service version upgrade. |
| Get server generation | Get available node server generations. |
| Get server type | Get available node server types. |
| Get server type (G3) | Get available node server types (3rd generation servers only). |
| Get operating system type | Get available operating system types. |
| Get operating system type (G3) | Get available operating system types (3rd generation servers only). |
| Get subnet list. | Get the list of available subnets. |
| Get subnet list (G3) | Get the list of available subnets (3rd generation servers only). |
| Get VPC list | Get the list of available VPCs. |
| Create cluster | Create Cloud Data Streaming Service cluster |
| Create cluster (return ID) | Create Cloud Data Streaming Service cluster (return ID). |
| Create cluster (G3) | Create Cloud Data Streaming Service cluster (3rd generation servers only). |
| Get cluster list | Get Cloud Data Streaming Service cluster list. |
| Get cluster status | Get the Cloud Data Streaming Service cluster status. |
| Get cluster certificate | Get the certificate used for cluster communication encryption in the Cloud Data Streaming Service. |
| Get cluster | Get Cloud Data Streaming Service cluster details. |
| Get cluster ACG list | Get the Cloud Data Streaming Service cluster ACG rule list. |
| Restart all cluster services | Restart all services in a Cloud Data Streaming Service cluster. |
| Restart cluster CMAK | Restart CMAK in a Cloud Data Streaming Service cluster. |
| Restart cluster Kafka | Restart Kafka and Zookeeper of a Cloud Data Streaming Service cluster. |
| Disable cluster public domain | Disable the public domain for accessing management tools for a Cloud Data Streaming Service cluster. |
| Enable cluster public domain | Enable the public domain for accessing management tools for a Cloud Data Streaming Service cluster. |
| Delete cluster | Delete Cloud Data Streaming Service cluster. |
| Add node | Add Cloud Data Streaming Service cluster broker node. |
| Get node list | Get the list of all nodes in a Cloud Data Streaming Service cluster. |
| Get changeable node specification | Get changeable server specifications for each node in a Cloud Data Streaming Service cluster. |
| Get changeable node specification (G3) | Get changeable server specifications for each node in a Cloud Data Streaming Service cluster (3rd generation servers only). |
| Get node specifications | Get server specifications for each node in a Cloud Data Streaming Service cluster. |
| Get node communication information | Get communication information for a Cloud Data Streaming Service cluster broker node. |
| Change node specifications | Change server specifications for each node in a Cloud Data Streaming Service cluster. |
| Rolling restart node | Rolling restart all nodes in a Cloud Data Streaming Service cluster |
| Pre-check node rolling restart | Pre-check rolling restart of all nodes in a Cloud Data Streaming Service cluster. |
| Get node rolling restart status | Get the progress status of rolling restart of all nodes in a Cloud Data Streaming Service cluster. |
| Restart node Kafka | Restart Kafka on a specified node in a Cloud Data Streaming Service cluster. |
| Disable node public endpoint | Disable the public endpoint of the broker node for a Cloud Data Streaming Service cluster. |
| Enable node public endpoint | Enable the public endpoint of the broker node for a Cloud Data Streaming Service cluster. |
| Get load balancer list | Get the list of load balancers available as public endpoints for broker nodes in a Cloud Data Streaming Service cluster. |
Monitoring
The following describes the event monitoring-related APIs.
| API | Description |
|---|---|
| Get monitoring result | Get monitoring data for Cloud Data Streaming Service clusters and node servers. |
| Get operating system monitoring results | Get operating system monitoring data for a Cloud Data Streaming Service node server. |
Config Group
The following describes the config group-related APIs.
| API | Description |
|---|---|
| Create config group | Create a config group required when creating a cluster. |
| Get config group list | Get the list of config groups created by Kafka version. |
| Get cluster with config group applied | Get clusters with applied config groups. |
| Get config group | Get config group details. |
| Get config group Kafka settings | Get detailed Kafka settings for a config group. |
| Change config group description | Change the config group description. |
| Apply config group to cluster | Apply a config group to a cluster. |
| Change config group Kafka settings | Change detailed Kafka settings for a config group. |
| Delete config group | Delete config group. |
Cloud Data Streaming Service related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Cloud Data Streaming Service APIs.
- Cloud Data Streaming Service API guides
- Create signature: how to create a signature to add to the request header
- Sub Account User Guide: how to issue the access key to be added to the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the Cloud Hadoop service
- How to use the Cloud Data Streaming Service service
- Cloud Data Streaming Service User Guide: how to use Cloud Data Streaming Service in the NAVER Cloud Platform console
- Ncloud use environment guide: guide for VPC and Classic environments and support availability
- Introduction to pricing, characteristics, and detailed features: the summary of pricing system, characteristics, and detailed features of Cloud Data Streaming Service
Latest service news: the latest news on the Cloud Data Streaming Service service - FAQ: frequently asked questions from the Cloud Data Streaming Service service users
- Support: Send direct inquiries for unresolved questions that aren't answered by the API guide.