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

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

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

yc managed-sharded-postgresql cluster list

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

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

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

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.yandexcloud.kz/managed-spqr/v1/clusters' \
     --url-query folderId=<идентификатор_каталога>
   

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

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

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

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

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

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

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

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

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

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

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

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

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

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.yandexcloud.kz/managed-spqr/v1/clusters/<идентификатор_кластера>'
   

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

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

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

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

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

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

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

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

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

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

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

Результат:

+----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+
|          ID          |     CREATED AT      |      CREATED BY      |     MODIFIED AT     | STATUS |          DESCRIPTION           |
+----------------------+---------------------+----------------------+---------------------+--------+--------------------------------+
| c5m7ll6pq3j8******** | 2025-11-28 19:05:42 | ajeef73j5iq9******** | 2025-11-28 19:08:05 | DONE   | Add shard to SPQR cluster      |
| c5mb0no66172******** | 2025-11-19 12:48:40 | ajeef73j5iq9******** | 2025-11-19 12:50:14 | DONE   | Add shard to SPQR cluster      |
| c5m6of9he7op******** | 2025-11-13 19:25:21 | ajeef73j5iq9******** | 2025-11-13 19:32:00 | DONE   | Create SPQR cluster            |
+----------------------+---------------------+----------------------+---------------------+---- ---+--------------------------------+

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

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

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

Результат:

- id: c9q2m9jrootm********
  description: Add shard to SPQR cluster
  created_at: "2025-12-11T09:14:15.564589Z"
  created_by: ajej2i98kcjd********
  modified_at: "2025-12-11T09:15:20.619684Z"
  done: true
  metadata:
    '@type': type.googleapis.com/yandex.cloud.mdb.spqr.v1.AddClusterShardMetadata
    cluster_id: c9qk2926qqu9********
    shard_name: shard2
  response:
    '@type': type.googleapis.com/yandex.cloud.mdb.spqr.v1.Shard
    name: shard2
    cluster_id: c9qk2926qqu9********
...

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

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

   curl \
     --request GET \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.yandexcloud.kz/managed-spqr/v1/clusters/<идентификатор_кластера>/operations'
   

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

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

1. Получите IAM-токен для аутентификации в API и поместите токен в переменную среды окружения:

   export IAM_TOKEN="<IAM-токен>"
   

2. Клонируйте репозиторий cloudapi:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Далее предполагается, что содержимое репозитория находится в директории ~/cloudapi/.

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

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

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

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

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. Убедитесь, что запрос был выполнен успешно, изучив ответ сервера.