Help Center> Cloud Search Service> API Reference> API Overview
View PDF

API Overview

The CSS API is a self-developed API that complies with RESTful API design specifications. CSS provides the functions listed in Table 1 through the CSS API.

Table 1 API functions

API

Function

API URI

APIs Related to Cluster Management

Creating a Cluster

 
POST /v1.0/{project_id}/clusters

Querying the List of Clusters

 
GET /v1.0/{project_id}/clusters

Querying Cluster Details

 
GET /v1.0/{project_id}/clusters/{cluster_id}

Deleting a Cluster

 
DELETE /v1.0/{project_id}/clusters/{cluster_id}

Restarting a Cluster

 
POST /v1.0/{project_id}/clusters/{cluster_id}/restart

Scaling Out a Cluster

 
POST /v1.0/{project_id}/clusters/{cluster_id}/extend

Adding Instances and Expanding Instance Storage Capacity

 
POST /v1.0/{project_id}/clusters/{cluster_id}/role_extend

Obtaining the List of Instance Flavors

 
GET /v1.0/{project_id}/es-flavors

APIs Related to Cluster Management

Querying Tags of a Specified Cluster

 
GET /v1.0/{project_id}/css-cluster/{cluster_id}/tags

Querying All Tags

 
GET /v1.0/{project_id}/css-cluster/tags

APIs Related to Word Dictionary Management (Poisson Analyzer)

Creating a Word Dictionary

 
POST /v1.0/{project_id}/clusters/{cluster_id}/poisson_words

Querying the Word Dictionary Status

 
GET /v1.0/{project_id}/clusters/{cluster_id}/poisson_words

Deleting a Word Dictionary

 
DELETE /v1.0/{project_id}/clusters/{cluster_id}/poisson_words?name={name}

APIs Related to Word Dictionary Management (IK Analyzer)

Loading Custom Word Dictionary

 
POST /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

Querying the Status of a Custom Word Dictionary

 
GET /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

Deleting a Custom Word Dictionary

 
DELETE /v1.0/{project_id}/clusters/{cluster_id}/thesaurus

APIs Related to Snapshot Management

Automatically Performing Basic Configurations for a Cluster Snapshot

 
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/auto_setting

Modifying Basic Configurations of a Cluster Snapshot

 
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/setting

Setting the Automatic Snapshot Creation Policy

 
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

Querying the Automatic Snapshot Creation Policy for a Cluster

 
GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/policy

Manually Creating a Snapshot

 
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot

Querying the List of Snapshots

 
GET /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots

Restoring a Snapshot

 
POST /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}/restore

Deleting a Snapshot

 
DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshot/{snapshot_id}

Disabling the Snapshot Function

 
DELETE /v1.0/{project_id}/clusters/{cluster_id}/index_snapshots