Contact UsGet started

Managed Service for ClickHouse API, REST: MlModel.List

Written by
Updated at November 26, 2024

Retrieves the list of machine learning models in the specified cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/mlModels

Path parameters

Field

Description

clusterId

string

Required field. ID of the cluster that models belongs to.

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListMlModelsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

pageToken

string

Page token. To get the next page of results, set page_token to the
ListMlModelsResponse.nextPageToken returned by the previous list request.

Response

HTTP Code: 200 - OK

{
  "mlModels": [
    {
      "name": "string",
      "clusterId": "string",
      "type": "string",
      "uri": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

mlModels[]

MlModel

List of models in the specified cluster.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
the specified ListMlModelsRequest.pageSize, use next_page_token as the value
for the ListMlModelsRequest.pageToken parameter in the next list request.

Each subsequent page will have its own next_page_token to continue paging through the results.

MlModel

Field

Description

name

string

Name of the the model.

clusterId

string

ID of the ClickHouse cluster that the model belongs to.

type

enum (MlModelType)

Type of the model.

  • ML_MODEL_TYPE_UNSPECIFIED
  • ML_MODEL_TYPE_CATBOOST: CatBoost model.

uri

string

Model file URL. You can only use models stored in Object Storage.
Previous
Get
Next
Create