Virtual Private Cloud API, gRPC: PrivateEndpointService.Create

Written by

Yandex Cloud

Updated at December 17, 2024

gRPC request
CreatePrivateEndpointRequest
AddressSpec
InternalIpv4AddressSpec
DnsOptions
ObjectStorage
operation.Operation
CreatePrivateEndpointMetadata
PrivateEndpoint
EndpointAddress
DnsOptions
ObjectStorage

Creates an private endpoint in the specified folder and network.

gRPC request

rpc Create (CreatePrivateEndpointRequest) returns (operation.Operation)

CreatePrivateEndpointRequest

{
  "folder_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "network_id": "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"
  },
  // Includes only one of the fields `object_storage`
  "object_storage": "ObjectStorage"
  // end of the list of possible fields
}

Field	Description
folder_id	string Required field. ID of the folder to create a private endpoint in. To get a folder ID make a yandex.cloud.resourcemanager.v1.FolderService.List request.
name	string Name of the private endpoint. The name must be unique within the folder.
description	string Description of the private endpoint.
labels	object (map<string, string>) Private endpoint labels as `key:value` pairs.
network_id	string Required field. ID of the network to create a private endpoint in.
address_spec	AddressSpec Private endpoint address specification.
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.

AddressSpec

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.

InternalIpv4AddressSpec

Field

Description

subnet_id

string

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

address

string

Value of address.

DnsOptions

Field

Description

private_dns_records_enabled

bool

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

ObjectStorage

Yandex Cloud Object Storage.

Field	Description
Empty

operation.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	CreatePrivateEndpointMetadata 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.

CreatePrivateEndpointMetadata

Field

Description

private_endpoint_id

string

ID of the private endpoint that is being created.

PrivateEndpoint

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.

EndpointAddress

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.

DnsOptions

Field

Description

private_dns_records_enabled

bool

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

ObjectStorage

Yandex Cloud Object Storage.

Field	Description
Empty

Virtual Private Cloud API, gRPC: PrivateEndpointService.Create

gRPC requestgRPC request

CreatePrivateEndpointRequestCreatePrivateEndpointRequest

AddressSpecAddressSpec

InternalIpv4AddressSpecInternalIpv4AddressSpec

DnsOptionsDnsOptions

ObjectStorageObjectStorage

operation.Operationoperation.Operation

CreatePrivateEndpointMetadataCreatePrivateEndpointMetadata

PrivateEndpointPrivateEndpoint

EndpointAddressEndpointAddress

DnsOptionsDnsOptions

ObjectStorageObjectStorage

Was the article helpful?

gRPC request

CreatePrivateEndpointRequest

AddressSpec

InternalIpv4AddressSpec

DnsOptions

ObjectStorage

operation.Operation

CreatePrivateEndpointMetadata

PrivateEndpoint

EndpointAddress

DnsOptions

ObjectStorage