Available in VPC
Search Engine Service is a NAVER Cloud Platform service that helps create and manage managed OpenSearch and Elasticsearch clusters that can search, analyze, and visualize various types of data. The Search Engine Service provides APIs for cluster, dashboard, monitoring, snapshot, and import features in RESTful form.
Common Search Engine Service settings
The following describes commonly used request and response formats in Search Engine Service APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://vpcsearchengine.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
Search Engine 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.
Search Engine Service API
The following describes the APIs provided by the Search Engine Service service.
Cluster
The following describes the cluster-related APIs.
| API | Description |
|---|---|
| Reset account password | Reset the search engine admin account's password. |
| Get version | Get available search engine versions. |
| Upgrade version | Upgrade search engine version. |
| Pre-check version upgrade | Pre-check search engine version upgrade. |
| Get version upgrade status | Get progress of search engine 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 authentication key list | Get list of authentication keys used when accessing the manager node of a search engine cluster via SSH. |
| 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 search engine cluster. |
| Create cluster (G3) | Create search engine cluster (3rd generation servers only). |
| Get cluster list | Get search engine cluster list. |
| Get cluster | Get search engine cluster details. |
| Get ACG list | Get search engine cluster ACG rule list. |
| Restart cluster | Restart search engine cluster. |
| Delete cluster | Delete search engine cluster. |
| Add node | Add search engine cluster data node. |
| Get node list | Get search engine cluster node list. |
| Get changeable specification by node | Get changeable server specifications for each node in a search engine cluster. |
| Get changeable specification by node (G3) | Get changeable server specifications for each node in a search engine cluster (3rd generation servers only). |
| Get node specifications | Get server specifications for each node in a search engine cluster. |
| Change disk capacity | Change search engine cluster data node server disk capacity. |
| Change node specifications | Change search engine cluster node server specifications. |
| Change node type | Change search engine cluster data node type. |
Dashboard
The following describes the dashboard-related APIs.
| API | Description |
|---|---|
| Get dashboard | Get search engine cluster dashboard. |
Monitoring
The following describes the event monitoring-related APIs.
| API | Description |
|---|---|
| Get monitoring result | Get monitoring data for search engine clusters and node servers. |
| Get operating system monitoring results | Get operating system monitoring data for a search engine node server. |
Snapshot
The following describes the snapshot-related APIs.
| API | Description |
|---|---|
| Get bucket list | Get the list of Object Storage buckets that can store search engine cluster snapshots. |
| Set API authentication key | Set API authentication key for Object Storage access. |
| Create snapshot | Create search engine cluster snapshot. |
| Get snapshot creation history | Get search engine cluster snapshot creation history. |
| Get snapshot scheduling configuration history | Get search engine cluster snapshot creation scheduling configuration history. |
| Set snapshot scheduling | Set search engine cluster snapshot creation scheduling. |
| Remove snapshot scheduling setting | Remove search engine cluster snapshot creation scheduling settings. |
Import
The following describes the import-related APIs.
| API | Description |
|---|---|
| Get bucket list | Get the list of Object Storage buckets that can import data. |
| Run data import | Run cluster import of data stored in an Object Storage bucket. |
| Get data import history | Get cluster import history of data stored in an Object Storage bucket. |
| Stop data import | Stop data import in progress. |
Search Engine Service related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Search Engine Service APIs.
- Search Engine Service API guides
- Create signature: how to create a signature to add to the request header
- API Gateway User Guide: how to issue the API key to be added 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 Search Engine Service service
- How to use the Search Engine Service service
- Search Engine Service User Guide: how to use Search Engine 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 Search Engine Service
- Latest service news: the latest news on the Search Engine Service service
- FAQ: frequently asked questions from the Search Engine Service service users
- Contact us: Send direct inquiries for unresolved questions that aren't answered by the API guide.