Получение информации об имеющихся кластерах PostgreSQL

Статья создана

Yandex Cloud

Обновлена 2 декабря 2024 г.

Получить список кластеров БД в каталоге
Получить детальную информацию о кластере
Посмотреть операции с кластерами

Вы можете запросить детальную информацию о каждом созданном вами кластере Managed Service for PostgreSQL.

Получить список кластеров БД в каталоге

Консоль управления

CLI

REST API

gRPC API

Перейдите на страницу каталога и выберите сервис Managed Service for PostgreSQL.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Чтобы запросить список кластеров PostgreSQL в каталоге по умолчанию, выполните команду:

yc managed-postgresql cluster list

+----------------------+---------------+-----------------------------+--------+---------+
|          ID          |     NAME      |         CREATED AT          | HEALTH | STATUS  |
+----------------------+---------------+-----------------------------+--------+---------+
| c9wlk4v14uq7******** | mypg          | 2018-11-02T10:04:14.645214Z | ALIVE  | RUNNING |
| ...                                                                                   |
+----------------------+---------------+-----------------------------+--------+---------+

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.List и выполните запрос, например, с помощью cURL:
```
curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters' \
  --url-query folderId=<идентификатор_каталога>
```
Идентификатор каталога можно запросить со списком каталогов в облаке.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService.List и выполните запрос, например, с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "folder_id": "<идентификатор_каталога>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.postgresql.v1.ClusterService.List

Идентификатор каталога можно запросить со списком каталогов в облаке.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получить детальную информацию о кластере

Консоль управления

CLI

REST API

gRPC API

Перейдите на страницу каталога и выберите сервис Managed Service for PostgreSQL.
Нажмите на имя нужного кластера.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

Чтобы получить информацию о кластере PostgreSQL, выполните команду:

yc managed-postgresql cluster get <имя_или_идентификатор_кластера>

Идентификатор и имя кластера можно запросить со списком кластеров в каталоге.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.Get и выполните запрос, например, с помощью cURL:
```
curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<идентификатор_кластера>'
```
Идентификатор кластера можно запросить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService.Get и выполните запрос, например, с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
        "cluster_id": "<идентификатор_кластера>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.postgresql.v1.ClusterService.Get

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Посмотреть операции с кластерами

Все действия с кластерами Managed Service for PostgreSQL сохраняются в виде списка операций. Каждой операции присваивается уникальный идентификатор.

Получить список операций

Консоль управления

CLI

REST API

gRPC API

Чтобы посмотреть операции со всеми кластерами Managed Service for PostgreSQL, на панели слева выберите Операции. В открывшемся списке также отображаются операции для ресурсов, которые были удалены.

Можно получить список операций для кластера:

В консоли управления откройте каталог, в котором находится кластер.
Выберите сервис Managed Service for PostgreSQL.
На панели слева выберите Кластеры.
Выберите нужный кластер.
Перейдите на панель Операции для выбранного кластера.

В открывшемся списке отображаются операции с выбранным кластером.

Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

Чтобы получить список операций для кластера Managed Service for PostgreSQL, воспользуйтесь командой:

yc managed-postgresql cluster list-operations <имя_или_идентификатор_кластера>

Результат:

+----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+
|          ID          |     CREATED AT      |      CREATED BY      |     MODIFIED AT     | STATUS |          DESCRIPTION           |
+----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+
| c5m7ll6pq3j8******** | 2024-08-08 19:05:42 | mdb-maintainer       | 2024-08-15 19:20:05 | DONE   | Modify PostgreSQL cluster      |
| c5mb0no66172******** | 2024-06-19 12:48:40 | mdb-maintainer       | 2024-06-26 12:50:14 | DONE   | Modify PostgreSQL cluster      |
| c5m6of9he7op******** | 2023-11-13 19:25:21 | ajeef73j5iq9******** | 2023-11-13 19:32:00 | DONE   | Create PostgreSQL cluster      |
+----------------------+---------------------+----------------------+---------------------+---- ---+--------------------------------+

Идентификатор кластера можно получить со списком кластеров в каталоге.

По умолчанию информация об операциях выводится в текстовом формате. Чтобы получить более подробную информацию, укажите формат yaml или json для выводимых данных с помощью флага --format:

yc managed-postgresql cluster list-operations c9qk2926qqu9******** --format yaml

Результат:

- id: c9q2m9jrootm********
  description: Create PostgreSQL cluster
  created_at: "2024-08-06T06:38:13.724389Z"
  created_by: ajej2i98kcjd********
  modified_at: "2024-08-06T06:46:33.101402Z"
  done: true
  metadata:
    '@type': type.googleapis.com/yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata
    cluster_id: c9qk2926qqu9********
...

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Воспользуйтесь методом Cluster.ListOperations и выполните запрос, например, с помощью cURL:
```
curl \
  --request GET \
  --header "Authorization: Bearer $IAM_TOKEN" \
  --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<идентификатор_кластера>/operations'
```
Идентификатор кластера можно запросить со списком кластеров в каталоге.
Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
```
export IAM_TOKEN="<IAM-токен>"
```
Клонируйте репозиторий cloudapi:
```
cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
```
Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

Воспользуйтесь вызовом ClusterService.ListOperations и выполните запрос, например, с помощью gRPCurl:

grpcurl \
  -format json \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
  -rpc-header "Authorization: Bearer $IAM_TOKEN" \
  -d '{
          "cluster_id": "<идентификатор_кластера>"
      }' \
  mdb.api.cloud.yandex.net:443 \
  yandex.cloud.mdb.postgresql.v1.ClusterService.ListOperations

Идентификатор кластера можно запросить со списком кластеров в каталоге.

Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

Получить подробную информацию об операции

Получите список операций для кластера.
Скопируйте идентификатор нужной операции.
Получите подробную информацию об операции:
CLI

REST API

gRPC API
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

Выполните команду:
```
yc operation get <идентификатор_операции>
```
Результат:
```
id: c9q2m9jrootm********
description: Create PostgreSQL cluster
created_at: "2024-08-06T06:38:13.724389Z"
created_by: ajej2i98kcjd********
modified_at: "2024-08-06T06:46:33.101402Z"
done: true
metadata:
  '@type': type.googleapis.com/yandex.cloud.mdb.postgresql.v1.CreateClusterMetadata
  cluster_id: c9qk2926qqu9********
response:
  '@type': type.googleapis.com/yandex.cloud.mdb.postgresql.v1.Cluster
...
```
1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
  export IAM_TOKEN="<IAM-токен>"
2. Воспользуйтесь методом Operation.Get и выполните запрос, например, с помощью cURL:
  curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://operation.api.cloud.yandex.net/operations/<идентификатор_операции>'
3. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.
1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:
  export IAM_TOKEN="<IAM-токен>"
2. Клонируйте репозиторий cloudapi:
  cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
  Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.
3. Воспользуйтесь вызовом OperationService.Get и выполните запрос, например, с помощью gRPCurl:
  grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/operation/operation_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "operation_id": "<идентификатор_операции>" }' \ operation.api.cloud.yandex.net:443 \ yandex.cloud.operation.OperationService.Get
4. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.

См. также

Работа с операциями

Получение информации об имеющихся кластерах PostgreSQL

Получить список кластеров БД в каталогеПолучить список кластеров БД в каталоге

Получить детальную информацию о кластереПолучить детальную информацию о кластере

Посмотреть операции с кластерамиПосмотреть операции с кластерами

Получить список операцийПолучить список операций

Получить подробную информацию об операцииПолучить подробную информацию об операции

См. такжеСм. также

Была ли статья полезна?

Получить список кластеров БД в каталоге

Получить детальную информацию о кластере

Посмотреть операции с кластерами

Получить список операций

Получить подробную информацию об операции

См. также