Связаться с намиПодключиться

Managed Service for OpenSearch API, REST: Extension.Create

Статья создана
Обновлена 3 октября 2025 г.

Creates new extension version.

HTTP request

POST https://mdb.api.yandexcloud.kz/managed-opensearch/v1/clusters/{clusterId}/extensions

Path parameters

Field

Description

clusterId

string

Required field. Required. ID of the cluster.

Body parameters

{
  "extensionSpec": {
    "name": "string",
    "uri": "string",
    "disabled": "boolean",
    "type": "string"
  }
}

Field

Description

extensionSpec

ExtensionSpec

Required field.

ExtensionSpec

Field

Description

name

string

Required field. Name of the extension.

uri

string

Required field. URI of the extension file
Currently only supports links that are stored in Yandex Object Storage.

disabled

boolean

type

enum (ExtensionType)

Required field. Extension type

  • EXTENSION_TYPE_UNSPECIFIED
  • EXTENSION_TYPE_SYNONYMS
  • EXTENSION_TYPE_STOPWORDS

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string",
    "extensionId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "name": "string",
    "id": "string",
    "clusterId": "string",
    "version": "string",
    "active": "boolean",
    "type": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateExtensionMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Extension

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateExtensionMetadata

Field

Description

clusterId

string

Required field. Required. ID of the cluster.

extensionId

string

Required field. Required. ID of the extension.

Status

The error result of the operation in case of failure or cancellation.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Extension

Field

Description

name

string

Name of the extension.

id

string

Extension unique ID

clusterId

string

ID of the OpenSearch cluster the extension belongs to.

version

string (int64)

Extension version

active

boolean

Flag is extension active now

type

enum (ExtensionType)

Extension type

  • EXTENSION_TYPE_UNSPECIFIED
  • EXTENSION_TYPE_SYNONYMS
  • EXTENSION_TYPE_STOPWORDS
Предыдущая
List
Следующая
Update