Managed Service for Elasticsearch API, REST: Extension.list
Returns the list of available extensions for the specified Elasticsearch cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-elasticsearch/v1/clusters/{clusterId}/extensions
Path parameters
Parameter | Description |
---|---|
clusterId | Required. ID of the cluster to list extensions in. The maximum string length in characters is 50. |
Query parameters
Parameter | Description |
---|---|
pageSize | The maximum number of results per page to return. If the number of available results is larger than pageSize, the API returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. |
pageToken | Page token that can be used to iterate through multiple pages of results. To get the next page of results, set pageToken to the nextPageToken returned by the previous list request. The maximum string length in characters is 100. |
Response
HTTP Code: 200 - OK
{
"extensions": [
{
"name": "string",
"id": "string",
"clusterId": "string",
"version": "string",
"active": true
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
extensions[] | object Requested list of extensions. |
extensions[]. name |
string Name of the extension. |
extensions[]. id |
string Unique ID of the extension. |
extensions[]. clusterId |
string ID of the Elasticsearch cluster the extension belongs to. |
extensions[]. version |
string (int64) Version of the extension. |
extensions[]. active |
boolean (boolean) The flag shows whether the extension is active. |
nextPageToken | string The token that can be used to get the next page of results. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken in the subsequent list request to iterate through multiple pages of results. Each of the subsequent list requests should use the nextPageToken value returned in the previous request to continue paging through the results. |