Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

XSKY os-search-engines API

OSSearchEngineController provides APIs for OS search engine

XSKY os-search-engines API is one of 124 APIs that XSKY publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include os-search-engines. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 7 paths, and defines 17 schemas. It is described by OpenAPI 2.0, at version SDS_4.2.000.0.200302.

Requests are made against the base URL https://{xms-controller}/v1.

10 operations 7 paths 17 schemas 1 DELETE3 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
SDS_4.2.000.0.200302
Base URL
https://{xms-controller}/v1
Authentication
API Key, API Key
License
Commercial
Resource Areas
1

Authentication & Security 2

XSKY os-search-engines API declares 2 security schemes for authenticating requests. An API key is passed in the header as Xms-Auth-Token (tokenInHeader). An API key is passed in the query as token (tokenInQuery).

  • tokenInHeader — auth by token
  • tokenInQuery — auth by token

Paths & Operations 10

Across 7 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

os-search-engines 10

OSSearchEngineController provides APIs for OS search engine

GET
/os-search-engines/
List OS search engine
ListOSSearchEngines 2 params → 200500
POST
/os-search-engines/
Create OS search engine
CreateOSSearchEngine 1 param → 202400409500
GET
/os-search-engines/{os_search_engine_id}
Get a OS search engine
GetOSSearchEngine 1 param → 200404500
DELETE
/os-search-engines/{os_search_engine_id}
delete OS search engine
DeleteOSSearchEngine 1 param → 202404409500
PATCH
/os-search-engines/{os_search_engine_id}
change OS search engine falvor or data size
ChangeOSSearchEngine 2 params → 202400404409500
GET
/os-search-engines/{os_search_engine_id}/samples
get an object storage search engine's samples
GetOSSearchEngineSamples 4 params → 200404500
POST
/os-search-engines/{os_search_engine_id}:add-os-search-gateways
Create new OS Search gateways on OS search engine
AddOSSearchGateways 2 params → 202400404409500
POST
/os-search-engines/{os_search_engine_id}:remove-os-search-gateways
remove OS search gateways from OS search engine
RemoveOSSearchGateways 2 params → 202400404409500
POST
/os-search-engines/{os_search_engine_id}:start
start OS search gateways from OS search engine
StartOSSearchEngine 1 param → 202400404409500
POST
/os-search-engines/{os_search_engine_id}:stop
stop OS search gateways from OS search engine
StopOSSearchEngine 1 param → 202400404409500

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are OSSearchEngine (13 properties), OSSearchEngineStat (7 properties), OSSearchEngineCreateReq_SearchEngine (5 properties), S3LoadBalancerGroup_Nestview (3 properties). Each schema is shown below with its type and property counts.

OSSearchEngineRemoveGatewaysReq_SearchEngine
object
1 property 1 required
OSSearchEngineAddGatewaysReq
object
1 property 1 required
S3LoadBalancerGroup_Nestview
object
3 properties
OSSearchEngineResp
object
1 property 1 required
OSSearchEngine
object
OSSearchEngine defines model of OS search engine TODO(penghui): Load balancer group
13 properties
OSSearchEngineStat
object
OSSearchEngineStat contains info of os search engine
7 properties
OSSearchEngineUpdateReq_SearchEngine
object
2 properties
OSSearchEngineCreateReq_SearchEngine
object
5 properties 3 required
OSSearchEngineSamplesResp
object
1 property 1 required
OSSearchEngineRemoveGatewaysReq
object
1 property 1 required
OSSearchEngineCreateReq
object
1 property 1 required
OSSearchEngineAddGatewaysReq_SearchEngine
object
1 property 1 required
OSSearchGatewayReq
object
2 properties 2 required
OSSearchEngineUpdateReq
object
1 property 1 required
OSSearchEnginesResp
object
1 property 1 required
VMFlavor_Nestview
object
2 properties
OSSearchEngineRecord
OSSearchEngineRecord is used to combine OSSearchEngine and OSSearchEngineStat

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xsky-os-search-engines-api-openapi.yml Raw ↑

Other APIs XSKY publishes across the network.

XSKY access-paths API
XSKY access-tokens API
XSKY action-logs API
XSKY alert-groups API
XSKY alert-rules API
XSKY alerts API
XSKY auth API
XSKY block-snapshots API
XSKY block-volume-group-snapshots API
XSKY block-volume-groups API
XSKY block-volume-migration-jobs API
XSKY block-volumes API