https://pig.center/ru/docs/etcd/dev-guide/Recent content in Руководство для разработчиков on PIG.CENTERHugoru-RUTue, 08 Sep 2026 21:29:01 +0800https://pig.center/ru/docs/etcd/dev-guide/discovery_protocol/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/discovery_protocol/<p>Протокол службы обнаружения помогает новому участнику etcd найти остальных участников на этапе начальной инициализации кластера с помощью общего URL обнаружения.</p> <p>Протокол используется <em>только</em> при начальной инициализации и не подходит для реконфигурации во время выполнения или мониторинга кластера.</p> <p>Один новый токен обнаружения предназначен для инициализации одного <em>уникального</em> кластера etcd. Один токен может представлять только один кластер. После запуска протокола для токена его нельзя использовать для инициализации другого кластера, даже если первый процесс завершился с ошибкой на полпути.</p>https://pig.center/ru/docs/etcd/dev-guide/local_cluster/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/local_cluster/<p>Для тестирования и разработки быстрее и проще всего настроить локальный кластер. Промышленное развёртывание описано в разделе <a href="https://pig.center/ru/docs/etcd/op-guide/clustering/">кластеризации</a> .</p> <h2 id="local-standalone-cluster">Локальный автономный кластер </h2> <h3 id="starting-a-cluster">Запуск кластера </h3> <p>Чтобы развернуть автономный кластер etcd, выполните:</p> <div class="td-code td-code--untitled" id="td-code-10811d29-fence-0" data-td-code data-td-code-auto-id data-td-language="" data-td-line-count="2"> <div class="td-code__viewport" id="td-code-10811d29-fence-0-viewport" data-td-code-viewport><pre tabindex="0"><code>$ ./etcd ...</code></pre></div> </div> <p>Если бинарный файл <code>etcd</code> отсутствует в текущем рабочем каталоге, он может находиться в <code>$GOPATH/bin/etcd</code> или <code>/usr/local/bin/etcd</code>. Укажите правильный путь при запуске.</p> <p>Работающий участник etcd принимает клиентские запросы на <code>localhost:2379</code>.</p>https://pig.center/ru/docs/etcd/dev-guide/interacting_v3/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/interacting_v3/<p>Пользователи чаще всего взаимодействуют с etcd, устанавливая или получая значение ключа. В этом разделе описано, как это сделать с помощью etcdctl — командной строки для взаимодействия с сервером etcd. Концепции, описанные здесь, должны применимы к gRPC&ndash;API или API клиентской библиотеки.</p> <p>Версию API <code>2</code> или <code>3</code>, которую etcdctl использует для связи с etcd, задаёт переменная окружения <code>ETCDCTL_API</code>. По умолчанию etcdctl из master (3.4) использует API v3, а версии 3.3 и старше — API v2.</p>https://pig.center/ru/docs/etcd/dev-guide/api_grpc_gateway/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/api_grpc_gateway/<p>etcd v3 использует <a href="https://www.grpc.io/">gRPC</a> как протокол обмена сообщениями. Проект etcd включает основанный на gRPC <a href="https://github.com/etcd-io/etcd/tree/main/client/v3">клиент Go</a> и утилиту командной строки <a href="https://github.com/etcd-io/etcd/tree/main/etcdctl">etcdctl</a> для взаимодействия с кластером etcd через gRPC. Для языков без поддержки gRPC etcd предоставляет JSON-<a href="https://github.com/grpc-ecosystem/grpc-gateway">шлюз gRPC</a> . Он служит RESTful-прокси, преобразующим запросы HTTP/JSON в сообщения gRPC.</p> <h2 id="using-grpc-gateway">Использование шлюза gRPC </h2> <p>Шлюз принимает <a href="https://developers.google.com/protocol-buffers/docs/proto3#json">JSON-сопоставление</a> определений сообщений <a href="https://pig.center/ru/docs/etcd/dev-guide/api_reference_v3/">protocol buffer</a> etcd. Поля <code>key</code> и <code>value</code> определены как массивы байтов, поэтому в JSON их обязательно кодировать в base64. В следующих примерах используется <code>curl</code>, но подойдёт любой клиент HTTP/JSON.</p>https://pig.center/ru/docs/etcd/dev-guide/grpc_naming/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/grpc_naming/<p>etcd предоставляет резолвер gRPC для альтернативной системы имён, которая получает конечные точки из etcd при обнаружении служб gRPC. Механизм основан на наблюдении за обновлениями ключей с префиксом имени службы.</p> <p>Эта возможность является экспериментальной, поскольку зависит от пакета <a href="https://github.com/grpc/grpc-go/tree/4cedec40eb2ccfbe3f56bb15e894903111ada2d2/resolver">google.golang.org/grpc/resolver</a> , который всё ещё считается экспериментальным в grpc-go.</p> <h2 id="using-etcd-discovery-with-go-grpc">Использование обнаружения etcd с go-grpc </h2> <p>Клиент etcd предоставляет резолвер gRPC для разрешения конечных точек gRPC с бэкендом etcd. Резолвер инициализируется клиентом etcd:</p>https://pig.center/ru/docs/etcd/dev-guide/golang_embed_pkg/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/golang_embed_pkg/<p>Пакет go etcd <code>embed</code> предоставляет простой способ встраивания сервера etcd непосредственно в ваше приложение.</p> <p>Дополнительные сведения см. в документации пакета <a href="https://pkg.go.dev/go.etcd.io/etcd/server/v3/embed">embed</a> .</p>https://pig.center/ru/docs/etcd/dev-guide/limit/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/limit/<h2 id="request-size-limit">Ограничение размера запроса </h2> <p>etcd разработан для обработки небольших пар ключ-значение, характерных для метаданных. Более крупные запросы будут работать, но могут увеличить задержку других запросов. По умолчанию максимальный размер любого запроса составляет 1.5 MiB. Этот лимит можно настроить с помощью флага <code>--max-request-bytes</code> для сервера etcd.</p> <h2 id="storage-size-limit">Ограничение размера хранилища </h2> <p>По умолчанию ограничение размера хранилища составляет 2 GiB, настраивается с помощью флага <code>--quota-backend-bytes</code>. 8 GiB — рекомендуемый максимальный размер для обычных сред, etcd выдает предупреждение при запуске, если сконфигурированное значение превышает его.</p>https://pig.center/ru/docs/etcd/dev-guide/features/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/features/<p>В этом документе представлен обзор возможностей etcd, помогающий понять их назначение и связанный с ними процесс устаревания. Порядок разработки возможностей etcd описан в <a href="https://github.com/etcd-io/etcd/blob/main/Documentation/contributor-guide/features.md">рекомендациях для разработчиков</a> .</p> <p>Возможности etcd проходят три стадии: экспериментальную, стабильную и небезопасную. Получить их список можно командой <code>etcd --help</code>.</p> <h2 id="experimental">Экспериментальные </h2> <p>Чтобы получить обратную связь на раннем этапе, новые возможности обычно добавляются как экспериментальные. Их можно определить по имени флага с префиксом <code>--experimental</code>. При использовании экспериментальной возможности учитывайте следующее:</p>https://pig.center/ru/docs/etcd/dev-guide/api_reference_v3/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/api_reference_v3/<p>Этот справочник API автоматически создан из указанных файлов <code>.proto</code>.</p> <h5 id="service-auth-apietcdserverpbrpcproto">Служба <code>Auth</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Метод</th> <th scope="col">Тип запроса</th> <th scope="col">Тип ответа</th> <th scope="col">Описание</th> </tr> </thead> <tbody> <tr> <td>AuthEnable</td> <td>AuthEnableRequest</td> <td>AuthEnableResponse</td> <td>AuthEnable включает аутентификацию.</td> </tr> <tr> <td>AuthDisable</td> <td>AuthDisableRequest</td> <td>AuthDisableResponse</td> <td>AuthDisable отключает аутентификацию.</td> </tr> <tr> <td>AuthStatus</td> <td>AuthStatusRequest</td> <td>AuthStatusResponse</td> <td>AuthStatus отображает состояние аутентификации.</td> </tr> <tr> <td>Authenticate</td> <td>AuthenticateRequest</td> <td>AuthenticateResponse</td> <td>Authenticate обрабатывает запрос аутентификации.</td> </tr> <tr> <td>UserAdd</td> <td>AuthUserAddRequest</td> <td>AuthUserAddResponse</td> <td>UserAdd добавляет нового пользователя. Имя пользователя не может быть пустым.</td> </tr> <tr> <td>UserGet</td> <td>AuthUserGetRequest</td> <td>AuthUserGetResponse</td> <td>UserGet получает подробные сведения о пользователе.</td> </tr> <tr> <td>UserList</td> <td>AuthUserListRequest</td> <td>AuthUserListResponse</td> <td>UserList получает список всех пользователей.</td> </tr> <tr> <td>UserDelete</td> <td>AuthUserDeleteRequest</td> <td>AuthUserDeleteResponse</td> <td>UserDelete удаляет указанного пользователя.</td> </tr> <tr> <td>UserChangePassword</td> <td>AuthUserChangePasswordRequest</td> <td>AuthUserChangePasswordResponse</td> <td>UserChangePassword изменяет пароль указанного пользователя.</td> </tr> <tr> <td>UserGrantRole</td> <td>AuthUserGrantRoleRequest</td> <td>AuthUserGrantRoleResponse</td> <td>UserGrant предоставляет указанному пользователю роль.</td> </tr> <tr> <td>UserRevokeRole</td> <td>AuthUserRevokeRoleRequest</td> <td>AuthUserRevokeRoleResponse</td> <td>UserRevokeRole отзывает роль указанного пользователя.</td> </tr> <tr> <td>RoleAdd</td> <td>AuthRoleAddRequest</td> <td>AuthRoleAddResponse</td> <td>RoleAdd добавляет новую роль. Имя роли не может быть пустым.</td> </tr> <tr> <td>RoleGet</td> <td>AuthRoleGetRequest</td> <td>AuthRoleGetResponse</td> <td>RoleGet получает подробные сведения о роли.</td> </tr> <tr> <td>RoleList</td> <td>AuthRoleListRequest</td> <td>AuthRoleListResponse</td> <td>RoleList получает список всех ролей.</td> </tr> <tr> <td>RoleDelete</td> <td>AuthRoleDeleteRequest</td> <td>AuthRoleDeleteResponse</td> <td>RoleDelete удаляет указанную роль.</td> </tr> <tr> <td>RoleGrantPermission</td> <td>AuthRoleGrantPermissionRequest</td> <td>AuthRoleGrantPermissionResponse</td> <td>RoleGrantPermission предоставляет указанной роли разрешение на заданный ключ или диапазон.</td> </tr> <tr> <td>RoleRevokePermission</td> <td>AuthRoleRevokePermissionRequest</td> <td>AuthRoleRevokePermissionResponse</td> <td>RoleRevokePermission отзывает у указанной роли разрешение на ключ или диапазон.</td> </tr> </tbody> </table> </div> <h5 id="service-cluster-apietcdserverpbrpcproto">Служба <code>Cluster</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Метод</th> <th scope="col">Тип запроса</th> <th scope="col">Тип ответа</th> <th scope="col">Описание</th> </tr> </thead> <tbody> <tr> <td>MemberAdd</td> <td>MemberAddRequest</td> <td>MemberAddResponse</td> <td>MemberAdd добавляет участника в кластер.</td> </tr> <tr> <td>MemberRemove</td> <td>MemberRemoveRequest</td> <td>MemberRemoveResponse</td> <td>MemberRemove удаляет существующего участника из кластера.</td> </tr> <tr> <td>MemberUpdate</td> <td>MemberUpdateRequest</td> <td>MemberUpdateResponse</td> <td>MemberUpdate обновляет конфигурацию участника.</td> </tr> <tr> <td>MemberList</td> <td>MemberListRequest</td> <td>MemberListResponse</td> <td>MemberList перечисляет всех участников кластера.</td> </tr> <tr> <td>MemberPromote</td> <td>MemberPromoteRequest</td> <td>MemberPromoteResponse</td> <td>MemberPromote повышает обучающегося участника raft без права голоса до участника raft с правом голоса.</td> </tr> </tbody> </table> </div> <h5 id="service-kv-apietcdserverpbrpcproto">Служба <code>KV</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Метод</th> <th scope="col">Тип запроса</th> <th scope="col">Тип ответа</th> <th scope="col">Описание</th> </tr> </thead> <tbody> <tr> <td>Range</td> <td>RangeRequest</td> <td>RangeResponse</td> <td>Range получает ключи диапазона из хранилища ключей и значений.</td> </tr> <tr> <td>Put</td> <td>PutRequest</td> <td>PutResponse</td> <td>Put помещает заданный ключ в хранилище ключей и значений. Запрос put увеличивает ревизию хранилища и создаёт одно событие в истории событий.</td> </tr> <tr> <td>DeleteRange</td> <td>DeleteRangeRequest</td> <td>DeleteRangeResponse</td> <td>DeleteRange удаляет заданный диапазон из хранилища ключей и значений. Запрос удаления увеличивает ревизию хранилища и создаёт событие удаления в истории для каждого удалённого ключа.</td> </tr> <tr> <td>Txn</td> <td>TxnRequest</td> <td>TxnResponse</td> <td>Txn обрабатывает несколько запросов в одной транзакции. Запрос txn увеличивает ревизию хранилища ключей и значений и создаёт события с одной ревизией для каждого выполненного запроса. Многократное изменение одного ключа в одной txn недопустимо.</td> </tr> <tr> <td>Compact</td> <td>CompactionRequest</td> <td>CompactionResponse</td> <td>Compact компактизирует историю событий в хранилище ключей и значений etcd. Хранилище следует периодически компактизировать, иначе история событий будет расти бесконечно.</td> </tr> </tbody> </table> </div> <h5 id="service-lease-apietcdserverpbrpcproto">Служба <code>Lease</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Метод</th> <th scope="col">Тип запроса</th> <th scope="col">Тип ответа</th> <th scope="col">Описание</th> </tr> </thead> <tbody> <tr> <td>LeaseGrant</td> <td>LeaseGrantRequest</td> <td>LeaseGrantResponse</td> <td>LeaseGrant создаёт аренду, которая истекает, если сервер не получает keepAlive в течение заданного срока жизни. При истечении аренды все присоединённые к ней ключи истекают и удаляются. Каждый истёкший ключ создаёт событие удаления в истории событий.</td> </tr> <tr> <td>LeaseRevoke</td> <td>LeaseRevokeRequest</td> <td>LeaseRevokeResponse</td> <td>LeaseRevoke отзывает аренду. Все присоединённые к ней ключи истекают и удаляются.</td> </tr> <tr> <td>LeaseKeepAlive</td> <td>LeaseKeepAliveRequest</td> <td>LeaseKeepAliveResponse</td> <td>LeaseKeepAlive поддерживает аренду активной, передавая потоком запросы поддержания активности от клиента серверу и ответы от сервера клиенту.</td> </tr> <tr> <td>LeaseTimeToLive</td> <td>LeaseTimeToLiveRequest</td> <td>LeaseTimeToLiveResponse</td> <td>LeaseTimeToLive получает сведения об аренде.</td> </tr> <tr> <td>LeaseLeases</td> <td>LeaseLeasesRequest</td> <td>LeaseLeasesResponse</td> <td>LeaseLeases перечисляет все существующие аренды.</td> </tr> </tbody> </table> </div> <h5 id="service-maintenance-apietcdserverpbrpcproto">Служба <code>Maintenance</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Метод</th> <th scope="col">Тип запроса</th> <th scope="col">Тип ответа</th> <th scope="col">Описание</th> </tr> </thead> <tbody> <tr> <td>Alarm</td> <td>AlarmRequest</td> <td>AlarmResponse</td> <td>Alarm активирует, деактивирует и запрашивает аварийные сигналы о состоянии кластера.</td> </tr> <tr> <td>Status</td> <td>StatusRequest</td> <td>StatusResponse</td> <td>Status получает состояние участника.</td> </tr> <tr> <td>Defragment</td> <td>DefragmentRequest</td> <td>DefragmentResponse</td> <td>Defragment дефрагментирует базу данных бэкенда участника для освобождения места.</td> </tr> <tr> <td>Hash</td> <td>HashRequest</td> <td>HashResponse</td> <td>Hash вычисляет хеш всего пространства ключей бэкенда, включая сегменты key, lease и другие сегменты хранилища. Предназначено ТОЛЬКО для тестирования! Не полагайтесь на операцию в рабочей среде с текущими транзакциями, поскольку Hash не удерживает блокировки MVCC. Для проверки согласованности сегмента &ldquo;key&rdquo; используйте API &ldquo;HashKV&rdquo;.</td> </tr> <tr> <td>HashKV</td> <td>HashKVRequest</td> <td>HashKVResponse</td> <td>HashKV вычисляет хеш всех ключей MVCC до заданной ревизии. Перебирает только сегмент &ldquo;key&rdquo; в хранилище бэкенда.</td> </tr> <tr> <td>Snapshot</td> <td>SnapshotRequest</td> <td>SnapshotResponse</td> <td>Snapshot передаёт снимок всего бэкенда от участника клиенту потоком.</td> </tr> <tr> <td>MoveLeader</td> <td>MoveLeaderRequest</td> <td>MoveLeaderResponse</td> <td>MoveLeader запрашивает у текущего узла-лидера передачу лидерства назначенному узлу.</td> </tr> <tr> <td>Downgrade</td> <td>DowngradeRequest</td> <td>DowngradeResponse</td> <td>Downgrade запрашивает понижение версии, проверяет его допустимость или отменяет его для версии кластера. Поддерживается начиная с etcd 3.5.</td> </tr> </tbody> </table> </div> <h5 id="service-watch-apietcdserverpbrpcproto">Служба <code>Watch</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Метод</th> <th scope="col">Тип запроса</th> <th scope="col">Тип ответа</th> <th scope="col">Описание</th> </tr> </thead> <tbody> <tr> <td>Watch</td> <td>WatchRequest</td> <td>WatchResponse</td> <td>Watch наблюдает за происходящими или уже произошедшими событиями. Ввод и вывод являются потоками: входной поток создаёт и отменяет наблюдателей, выходной отправляет события. Один RPC watch может наблюдать несколько диапазонов ключей и одновременно передавать события нескольких наблюдений. Всю историю событий можно наблюдать с последней ревизии компактизации.</td> </tr> </tbody> </table> </div> <h5 id="message-alarmmember-apietcdserverpbrpcproto">Сообщение <code>AlarmMember</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>memberID</td> <td>memberID — идентификатор участника, связанного с активированным аварийным сигналом.</td> <td>uint64</td> </tr> <tr> <td>alarm</td> <td>alarm — тип активированного аварийного сигнала.</td> <td>AlarmType</td> </tr> </tbody> </table> </div> <h5 id="message-alarmrequest-apietcdserverpbrpcproto">Сообщение <code>AlarmRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>action</td> <td>action — тип отправляемого запроса аварийного сигнала. Действие может GET состояния сигналов, ACTIVATE сигнал или DEACTIVATE активированный сигнал.</td> <td>AlarmAction</td> </tr> <tr> <td>memberID</td> <td>memberID — идентификатор участника, связанного с сигналом. Если memberID равен 0, запрос относится ко всем участникам.</td> <td>uint64</td> </tr> <tr> <td>alarm</td> <td>alarm — тип аварийного сигнала, рассматриваемого запросом.</td> <td>AlarmType</td> </tr> </tbody> </table> </div> <h5 id="message-alarmresponse-apietcdserverpbrpcproto">Сообщение <code>AlarmResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>alarms</td> <td>alarms — список аварийных сигналов, связанных с запросом.</td> <td>(slice of) AlarmMember</td> </tr> </tbody> </table> </div> <h5 id="message-authdisablerequest-apietcdserverpbrpcproto">Сообщение <code>AuthDisableRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authdisableresponse-apietcdserverpbrpcproto">Сообщение <code>AuthDisableResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authenablerequest-apietcdserverpbrpcproto">Сообщение <code>AuthEnableRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authenableresponse-apietcdserverpbrpcproto">Сообщение <code>AuthEnableResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authroleaddrequest-apietcdserverpbrpcproto">Сообщение <code>AuthRoleAddRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name — имя роли, добавляемой в систему аутентификации.</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authroleaddresponse-apietcdserverpbrpcproto">Сообщение <code>AuthRoleAddResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authroledeleterequest-apietcdserverpbrpcproto">Сообщение <code>AuthRoleDeleteRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authroledeleteresponse-apietcdserverpbrpcproto">Сообщение <code>AuthRoleDeleteResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authrolegetrequest-apietcdserverpbrpcproto">Сообщение <code>AuthRoleGetRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authrolegetresponse-apietcdserverpbrpcproto">Сообщение <code>AuthRoleGetResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>perm</td> <td></td> <td>(slice of) authpb.Permission</td> </tr> </tbody> </table> </div> <h5 id="message-authrolegrantpermissionrequest-apietcdserverpbrpcproto">Сообщение <code>AuthRoleGrantPermissionRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name — имя роли, которой будет предоставлено разрешение.</td> <td>string</td> </tr> <tr> <td>perm</td> <td>perm — разрешение, предоставляемое роли.</td> <td>authpb.Permission</td> </tr> </tbody> </table> </div> <h5 id="message-authrolegrantpermissionresponse-apietcdserverpbrpcproto">Сообщение <code>AuthRoleGrantPermissionResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authrolelistrequest-apietcdserverpbrpcproto">Сообщение <code>AuthRoleListRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authrolelistresponse-apietcdserverpbrpcproto">Сообщение <code>AuthRoleListResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>roles</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> </div> <h5 id="message-authrolerevokepermissionrequest-apietcdserverpbrpcproto">Сообщение <code>AuthRoleRevokePermissionRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> <tr> <td>key</td> <td></td> <td>bytes</td> </tr> <tr> <td>range_end</td> <td></td> <td>bytes</td> </tr> </tbody> </table> </div> <h5 id="message-authrolerevokepermissionresponse-apietcdserverpbrpcproto">Сообщение <code>AuthRoleRevokePermissionResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authstatusrequest-apietcdserverpbrpcproto">Сообщение <code>AuthStatusRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authstatusresponse-apietcdserverpbrpcproto">Сообщение <code>AuthStatusResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>enabled</td> <td></td> <td>bool</td> </tr> <tr> <td>authRevision</td> <td>authRevision — текущая ревизия хранилища аутентификации</td> <td>uint64</td> </tr> </tbody> </table> </div> <h5 id="message-authuseraddrequest-apietcdserverpbrpcproto">Сообщение <code>AuthUserAddRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>password</td> <td></td> <td>string</td> </tr> <tr> <td>options</td> <td></td> <td>authpb.UserAddOptions</td> </tr> <tr> <td>hashedPassword</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authuseraddresponse-apietcdserverpbrpcproto">Сообщение <code>AuthUserAddResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authuserchangepasswordrequest-apietcdserverpbrpcproto">Сообщение <code>AuthUserChangePasswordRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name — имя пользователя, пароль которого изменяется.</td> <td>string</td> </tr> <tr> <td>password</td> <td>password — новый пароль пользователя. Обратите внимание: это поле будет удалено на уровне API.</td> <td>string</td> </tr> <tr> <td>hashedPassword</td> <td>hashedPassword — новый пароль пользователя. Обратите внимание: это поле будет инициализировано на уровне API.</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authuserchangepasswordresponse-apietcdserverpbrpcproto">Сообщение <code>AuthUserChangePasswordResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authuserdeleterequest-apietcdserverpbrpcproto">Сообщение <code>AuthUserDeleteRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td>name — имя удаляемого пользователя.</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authuserdeleteresponse-apietcdserverpbrpcproto">Сообщение <code>AuthUserDeleteResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authusergetrequest-apietcdserverpbrpcproto">Сообщение <code>AuthUserGetRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authusergetresponse-apietcdserverpbrpcproto">Сообщение <code>AuthUserGetResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>roles</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> </div> <h5 id="message-authusergrantrolerequest-apietcdserverpbrpcproto">Сообщение <code>AuthUserGrantRoleRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>user</td> <td>user — имя пользователя, которому следует предоставить указанную роль.</td> <td>string</td> </tr> <tr> <td>role</td> <td>role — имя роли, предоставляемой пользователю.</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authusergrantroleresponse-apietcdserverpbrpcproto">Сообщение <code>AuthUserGrantRoleResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authuserlistrequest-apietcdserverpbrpcproto">Сообщение <code>AuthUserListRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> </tbody> </table> </div> <h5 id="message-authuserlistresponse-apietcdserverpbrpcproto">Сообщение <code>AuthUserListResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>users</td> <td></td> <td>(slice of) string</td> </tr> </tbody> </table> </div> <h5 id="message-authuserrevokerolerequest-apietcdserverpbrpcproto">Сообщение <code>AuthUserRevokeRoleRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>role</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authuserrevokeroleresponse-apietcdserverpbrpcproto">Сообщение <code>AuthUserRevokeRoleResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="message-authenticaterequest-apietcdserverpbrpcproto">Сообщение <code>AuthenticateRequest</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>name</td> <td></td> <td>string</td> </tr> <tr> <td>password</td> <td></td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-authenticateresponse-apietcdserverpbrpcproto">Сообщение <code>AuthenticateResponse</code> (api/etcdserverpb/rpc.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>(versionpb.etcd_version_msg)</td> <td></td> <td>option</td> </tr> <tr> <td>header</td> <td></td> <td>ResponseHeader</td> </tr> <tr> <td>token</td> <td>token — авторизованный токен, который можно использовать в последующих RPC</td> <td>string</td> </tr> </tbody> </table> </div> <h5 id="message-compactionrequest-apietcdserverpbrpcproto">Сообщение <code>CompactionRequest</code> (api/etcdserverpb/rpc.proto) </h5> <p>CompactionRequest компактизирует хранилище ключей и значений до заданной ревизии. Все замещённые ключи с ревизией меньше ревизии компактизации удаляются.</p>https://pig.center/ru/docs/etcd/dev-guide/api_concurrency_reference_v3/Mon, 01 Jan 0001 00:00:00 +0000https://pig.center/ru/docs/etcd/dev-guide/api_concurrency_reference_v3/<p>Этот справочник API автоматически создан из указанных файлов <code>.proto</code>.</p> <h5 id="service-lock-serveretcdserverapiv3lockv3lockpbv3lockproto">служба <code>Lock</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <p>Служба блокировок предоставляет клиентские средства блокировки через интерфейс gRPC.</p> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Метод</th> <th scope="col">Тип запроса</th> <th scope="col">Тип ответа</th> <th scope="col">Описание</th> </tr> </thead> <tbody> <tr> <td>Lock</td> <td>LockRequest</td> <td>LockResponse</td> <td>Lock получает распределённую совместную блокировку с указанным именем. При успехе возвращается уникальный ключ, существующий, пока вызывающая сторона удерживает блокировку. Вместе с транзакциями ключ позволяет безопасно гарантировать, что etcd обновляется только при владении блокировкой. Блокировка удерживается до вызова Unlock для ключа или истечения аренды владельца.</td> </tr> <tr> <td>Unlock</td> <td>UnlockRequest</td> <td>UnlockResponse</td> <td>Unlock принимает ключ, возвращённый Lock, и освобождает блокировку. Следующий ожидающий вызов Lock пробуждается и получает владение блокировкой.</td> </tr> </tbody> </table> </div> <h5 id="message-lockrequest-serveretcdserverapiv3lockv3lockpbv3lockproto">сообщение <code>LockRequest</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>name</td> <td>name — идентификатор получаемой распределённой совместной блокировки.</td> <td>bytes</td> </tr> <tr> <td>lease</td> <td>lease — идентификатор аренды, привязанной к владению блокировкой. Если удерживающая блокировку аренда истекает или отзывается, блокировка освобождается автоматически. Вызовы Lock с одной арендой считаются одним получением; повторная блокировка с той же арендой ничего не делает.</td> <td>int64</td> </tr> </tbody> </table> </div> <h5 id="message-lockresponse-serveretcdserverapiv3lockv3lockpbv3lockproto">сообщение <code>LockResponse</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>etcdserverpb.ResponseHeader</td> </tr> <tr> <td>key</td> <td>key — ключ, существующий в etcd, пока вызывающая Lock сторона владеет блокировкой. Пользователи не должны изменять ключ, иначе поведение блокировки не определено.</td> <td>bytes</td> </tr> </tbody> </table> </div> <h5 id="message-unlockrequest-serveretcdserverapiv3lockv3lockpbv3lockproto">сообщение <code>UnlockRequest</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>key</td> <td>key — ключ владения блокировкой, выданный Lock.</td> <td>bytes</td> </tr> </tbody> </table> </div> <h5 id="message-unlockresponse-serveretcdserverapiv3lockv3lockpbv3lockproto">сообщение <code>UnlockResponse</code> (server/etcdserver/api/v3lock/v3lockpb/v3lock.proto) </h5> <div class="td-table-scroll td-table-scroll--static"> <table> <thead> <tr> <th scope="col">Поле</th> <th scope="col">Описание</th> <th scope="col">Тип</th> </tr> </thead> <tbody> <tr> <td>header</td> <td></td> <td>etcdserverpb.ResponseHeader</td> </tr> </tbody> </table> </div> <h5 id="service-election-serveretcdserverapiv3electionv3electionpbv3electionproto">служба <code>Election</code> (server/etcdserver/api/v3election/v3electionpb/v3election.proto) </h5> <p>Служба выборов предоставляет клиентские средства выборов через интерфейс gRPC.</p>