Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex Virtual Private Cloud
  • Начало работы
  • DDoS Protection
  • Управление доступом
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
          • Overview
          • Get
          • List
          • Create
          • Update
          • Delete
          • ListOperations
  • Аудитные логи Audit Trails
  • История изменений
  • Вопросы и ответы
  • Обучающие курсы

В этой статье:

  • gRPC request
  • UpdatePrivateEndpointRequest
  • AddressSpec
  • InternalIpv4AddressSpec
  • DnsOptions
  • operation.Operation
  • UpdatePrivateEndpointMetadata
  • PrivateEndpoint
  • EndpointAddress
  • DnsOptions
  • ObjectStorage
  1. Справочник API
  2. gRPC (англ.)
  3. Virtual Private Cloud API
  4. PrivateEndpoint
  5. Update

Virtual Private Cloud API, gRPC: PrivateEndpointService.Update

Статья создана
Yandex Cloud
Обновлена 24 апреля 2025 г.
  • gRPC request
  • UpdatePrivateEndpointRequest
  • AddressSpec
  • InternalIpv4AddressSpec
  • DnsOptions
  • operation.Operation
  • UpdatePrivateEndpointMetadata
  • PrivateEndpoint
  • EndpointAddress
  • DnsOptions
  • ObjectStorage

Updates the specified private endpoint.

gRPC requestgRPC request

rpc Update (UpdatePrivateEndpointRequest) returns (operation.Operation)

UpdatePrivateEndpointRequestUpdatePrivateEndpointRequest

{
  "private_endpoint_id": "string",
  "update_mask": "google.protobuf.FieldMask",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "address_spec": {
    // Includes only one of the fields `address_id`, `internal_ipv4_address_spec`
    "address_id": "string",
    "internal_ipv4_address_spec": {
      "subnet_id": "string",
      "address": "string"
    }
    // end of the list of possible fields
  },
  "dns_options": {
    "private_dns_records_enabled": "bool"
  }
}

Field

Description

private_endpoint_id

string

Required field. ID of the private endpoint to update.

To get the private endpoint ID make a PrivateEndpointService.List
request.

update_mask

google.protobuf.FieldMask

Field mask that specifies which attributes of the PrivateEndpoint should be
updated.

name

string

New name for the private endpoint.
The name must be unique within the folder.

description

string

New description of the private endpoint.

labels

object (map<string, string>)

Private endpoint labels as key:value pairs.

Existing set of labels is completely replaced by the provided set, so if
you just want to add or remove a label:

  1. Get the current set of labels with a PrivateEndpointService.Get
    request.
  2. Add or remove a label in this set.
  3. Send the new set in this field.

address_spec

AddressSpec

Private endpoint address specification.

dns_options

DnsOptions

Private endpoint dns options.

AddressSpecAddressSpec

Field

Description

address_id

string

ID of IP address to associate with private endpoint.

Includes only one of the fields address_id, internal_ipv4_address_spec.

internal_ipv4_address_spec

InternalIpv4AddressSpec

Internal ipv4 address specification.

Includes only one of the fields address_id, internal_ipv4_address_spec.

InternalIpv4AddressSpecInternalIpv4AddressSpec

Field

Description

subnet_id

string

Required field. ID of the subnet that address belongs to.

address

string

Value of address.

DnsOptionsDnsOptions

Field

Description

private_dns_records_enabled

bool

If enabled - vpc will create private dns records for specified service.

operation.Operationoperation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "private_endpoint_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "network_id": "string",
    "status": "Status",
    "address": {
      "subnet_id": "string",
      "address": "string",
      "address_id": "string"
    },
    "dns_options": {
      "private_dns_records_enabled": "bool"
    },
    // Includes only one of the fields `object_storage`
    "object_storage": "ObjectStorage"
    // end of the list of possible fields
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

UpdatePrivateEndpointMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

PrivateEndpoint

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

UpdatePrivateEndpointMetadataUpdatePrivateEndpointMetadata

Field

Description

private_endpoint_id

string

ID of the private endpoint that is being updated.

PrivateEndpointPrivateEndpoint

Field

Description

id

string

ID of the private endpoint. Generated at creation time.

folder_id

string

ID of the folder that the private endpoint belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the private endpoint.
The name is unique within the folder.
Value must match the regular expression
\\|[a-zA-Z]([-_a-zA-Z0-9]{0,61}[a-zA-Z0-9])?.

description

string

Description of the private endpoint. 0-256 characters long.

labels

object (map<string, string>)

Private endpoint labels as key:value pairs.
No more than 64 per resource.
The maximum string length in characters for each value is 63.
Each value must match the regular expression [-_0-9a-z]*.
The string length in characters for each key must be 1-63.
Each key must match the regular expression [a-z][-_0-9a-z]*.

network_id

string

ID of the network that the private endpoint belongs to.

status

enum Status

Status of the private endpoint.

  • STATUS_UNSPECIFIED
  • PENDING: Private endpoint is still creating / updating.
  • AVAILABLE: Private endpoint is available.
  • DELETING: Private endpoint is deleting.

address

EndpointAddress

Private endpoint ip address details.

dns_options

DnsOptions

Private endpoint dns options.

object_storage

ObjectStorage

Yandex Cloud Object Storage.

Includes only one of the fields object_storage.

Service to connect with via private endpoint.

EndpointAddressEndpointAddress

Private endpoint ip address details.

Field

Description

subnet_id

string

ID of the subnet that the private endpoint address belongs to.

address

string

IP address of the private endpoint.

address_id

string

ID of the private endpoint address.

DnsOptionsDnsOptions

Field

Description

private_dns_records_enabled

bool

If enabled - vpc will create private dns records for specified service.

ObjectStorageObjectStorage

Yandex Cloud Object Storage.

Field

Description

Empty

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

Предыдущая
Create
Следующая
Delete
Проект Яндекса
© 2025 ООО «Яндекс.Облако»