Yandex Cloud
Search
Contact UsGet started
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • AI for business
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Center for Technologies and Society
    • Yandex Cloud Partner program
  • Pricing
  • Customer Stories
  • Documentation
  • Blog
© 2025 Direct Cursus Technology L.L.C.
Yandex Managed Service for ClickHouse®
  • Getting started
  • Access management
  • Pricing policy
  • Terraform reference
    • API authentication
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
  • Yandex Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes

In this article:

  • gRPC request
  • ListMlModelsRequest
  • ListMlModelsResponse
  • MlModel
  1. API reference
  2. gRPC
  3. MlModel
  4. List

Managed Service for ClickHouse API, gRPC: MlModelService.List

Written by
Yandex Cloud
Updated at November 26, 2024
  • gRPC request
  • ListMlModelsRequest
  • ListMlModelsResponse
  • MlModel

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

gRPC requestgRPC request

rpc List (ListMlModelsRequest) returns (ListMlModelsResponse)

ListMlModelsRequestListMlModelsRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

cluster_id

string

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

page_size

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.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

page_token

string

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

ListMlModelsResponseListMlModelsResponse

{
  "ml_models": [
    {
      "name": "string",
      "cluster_id": "string",
      "type": "MlModelType",
      "uri": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

ml_models[]

MlModel

List of models in the specified cluster.

next_page_token

string

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

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

MlModelMlModel

Field

Description

name

string

Name of the the model.

cluster_id

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.

Was the article helpful?

Previous
Get
Next
Create
© 2025 Direct Cursus Technology L.L.C.