Связаться с экспертомПопробовать бесплатно
Статья создана
Открыть в Markdown

🚧 [Experimental] List Trino clusters

Returns a list of Trino clusters available to the current DataLens tenant.

Request

POST

https://api.datalens.tech/rpc/listTrinoClusters

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

Body

application/json
{
  "pageSize": 0,
  "pageToken": "example",
  "filter": [
    "example"
  ],
  "collectionId": "example",
  "catalogId": "example"
}

Name

Description

catalogId

Type: string

ID of the REST catalog attached to the Trino clusters.

Min length: 1

Max length: 50

Example: example

collectionId

Type: string

ID of the DataLens collection that contains the Trino clusters.

Min length: 1

Max length: 50

Example: example

filter

Type: string[]

Filter expressions applied to the Trino cluster list.

Example
[
  "example"
]

pageSize

Type: integer

Maximum number of Trino clusters to return. The default is 100.

Min value: 0

pageToken

Type: string

Token for the next page of Trino clusters.

Example: example

Responses

200 OK

Response

Body

application/json
{
  "clusters": [
    {
      "id": "example",
      "clusterId": "example",
      "collectionId": "example",
      "cloudEnvironmentId": "example",
      "name": "example",
      "description": "example",
      "labels": {},
      "config": {
        "trinoVersion": "example",
        "catalogsConfig": [
          {}
        ],
        "coordinatorConfig": {
          "resources": {}
        },
        "workerConfig": {
          "resources": {},
          "scalePolicy": {}
        },
        "retryPolicy": {
          "policy": "POLICY_UNSPECIFIED"
        }
      },
      "health": "HEALTH_UNKNOWN",
      "status": "STATUS_UNKNOWN",
      "coordinatorUrl": "example",
      "entryId": "example"
    }
  ],
  "nextPageToken": "example"
}

Name

Description

clusters

Type: TrinoCluster[]

Trino clusters matching the request.

Example
[
  {
    "id": "example",
    "clusterId": "example",
    "collectionId": "example",
    "cloudEnvironmentId": "example",
    "name": "example",
    "description": "example",
    "labels": {},
    "config": {
      "trinoVersion": "example",
      "catalogsConfig": [
        {
          "catalogId": "example"
        }
      ],
      "coordinatorConfig": {
        "resources": {
          "resourcePresetId": "example"
        }
      },
      "workerConfig": {
        "resources": {
          "resourcePresetId": "example"
        },
        "scalePolicy": {
          "autoScale": {},
          "scaleType": "autoScale"
        }
      },
      "retryPolicy": {
        "policy": "POLICY_UNSPECIFIED"
      }
    },
    "health": "HEALTH_UNKNOWN",
    "status": "STATUS_UNKNOWN",
    "coordinatorUrl": "example",
    "entryId": "example"
  }
]

nextPageToken

Type: string

Token for the next page of Trino clusters.

Example: example

TrinoCluster

Name

Description

cloudEnvironmentId

Type: string

ID of the associated cloud environment.

Min length: 1

Example: example

clusterId

Type: string

ID of the managed Trino cluster.

Example: example

collectionId

Type: string

ID of the DataLens collection that contains the cluster.

Min length: 1

Example: example

config
Type: object

catalogsConfig
Type: object[]

catalogId

Type: string

ID of the REST catalog.

Min length: 1

Max length: 50

Example: example

REST catalogs attached to the cluster.

Example
[
  {
    "catalogId": "example"
  }
]

coordinatorConfig
Type: object

resources
Type: object

resourcePresetId

Type: string

ID of the Trino resource preset.

Min length: 1

Max length: 50

Example: example

Resources assigned to the coordinator.

Example
{
  "resourcePresetId": "example"
}
Example
{
  "resources": {
    "resourcePresetId": "example"
  }
}

trinoVersion

Type: string

Trino version used by the cluster.

Example: example

workerConfig
Type: object

resources
Type: object

resourcePresetId

Type: string

ID of the Trino resource preset.

Min length: 1

Max length: 50

Example: example

Resources assigned to each worker.

Example
{
  "resourcePresetId": "example"
}

scalePolicy
Type: object

autoScale
Type: object

maxCount

Type: string

Maximum number of worker instances.

Pattern: ^(?:[1-9]|[1-5]\d|6[0-4])$

Example: example

minCount

Type: string

Minimum number of worker instances.

Pattern: ^(?:0|[1-5]?\d|6[0-4])$

Example: example
Example
{
  "minCount": "example",
  "maxCount": "example"
}

scaleType

Type: string

Const: autoScale

Example: example
Example
{
  "autoScale": {
    "minCount": "example",
    "maxCount": "example"
  },
  "scaleType": "autoScale"
}
Example
{
  "resources": {
    "resourcePresetId": "example"
  },
  "scalePolicy": {
    "autoScale": {
      "minCount": "example",
      "maxCount": "example"
    },
    "scaleType": "autoScale"
  }
}

retryPolicy

Type: object | null

Retry policy: QUERY retries a whole query, TASK retries the failed tasks only. Null when not set.

Example
{
  "policy": "POLICY_UNSPECIFIED"
}
Example
{
  "trinoVersion": "example",
  "catalogsConfig": [
    {
      "catalogId": "example"
    }
  ],
  "coordinatorConfig": {
    "resources": {
      "resourcePresetId": "example"
    }
  },
  "workerConfig": {
    "resources": {
      "resourcePresetId": "example"
    },
    "scalePolicy": {
      "autoScale": {
        "minCount": "example",
        "maxCount": "example"
      },
      "scaleType": "autoScale"
    }
  },
  "retryPolicy": {
    "policy": "POLICY_UNSPECIFIED"
  }
}

coordinatorUrl

Type: string

Address of the Trino coordinator.

Example: example

description

Type: string

Description of the Trino cluster.

Example: example

entryId

Type: string

ID of the DataLens entry of the Trino cluster. Empty when the cluster has no entry.

Example: example

health

Type: string

Aggregated health of the Trino cluster.

Enum: HEALTH_UNKNOWN, ALIVE, DEAD, DEGRADED

id

Type: string

ID of the Trino cluster.

Min length: 1

Example: example

labels
Type: object

[additional]

Type: string

Example: example

Trino cluster labels.

Example
{}

name

Type: string

Name of the Trino cluster.

Min length: 1

Example: example

status

Type: string

Current status of the Trino cluster.

Enum: STATUS_UNKNOWN, CREATING, RUNNING, ERROR, STOPPING, STOPPED, STARTING, UPDATING
Example
{
  "id": "example",
  "clusterId": "example",
  "collectionId": "example",
  "cloudEnvironmentId": "example",
  "name": "example",
  "description": "example",
  "labels": {},
  "config": {
    "trinoVersion": "example",
    "catalogsConfig": [
      {
        "catalogId": "example"
      }
    ],
    "coordinatorConfig": {
      "resources": {
        "resourcePresetId": "example"
      }
    },
    "workerConfig": {
      "resources": {
        "resourcePresetId": "example"
      },
      "scalePolicy": {
        "autoScale": {
          "minCount": "example",
          "maxCount": "example"
        },
        "scaleType": "autoScale"
      }
    },
    "retryPolicy": {
      "policy": "POLICY_UNSPECIFIED"
    }
  },
  "health": "HEALTH_UNKNOWN",
  "status": "STATUS_UNKNOWN",
  "coordinatorUrl": "example",
  "entryId": "example"
}
Предыдущая
Overview
Следующая
🚧 [Experimental] Get Trino cluster