Get

Returns the specified Private Endpoint resource.

To get the list of all available PrivateEndpoint resources, make a List request.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const GetPrivateEndpointRequest =
  cloudApi.vpc.privatelink_private_endpoint_service.GetPrivateEndpointRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.PrivateEndpointServiceClient);

  const result = await client.get(
    GetPrivateEndpointRequest.fromPartial({
      privateEndpointId: "privateEndpointId",
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.vpc.v1.privatelink.private_endpoint_service_pb2 import GetPrivateEndpointRequest
from yandex.cloud.vpc.v1.privatelink.private_endpoint_service_pb2_grpc import (
    PrivateEndpointServiceStub,
)

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(PrivateEndpointServiceStub)
response = service.Get(GetPrivateEndpointRequest(private_endpoint_id="privateEndpointId"))
print(response)

GetPrivateEndpointRequest

privateEndpointId : string

ID of the PrivateEndpoint resource to return.

To get PrivateEndpoint resource ID make a PrivateEndpointService.List request.

PrivateEndpoint

Status

Status of the private endpoint.

• STATUS_UNSPECIFIED

  Status of the private endpoint.

• PENDING

  Private endpoint is still creating / updating.

• AVAILABLE

  Private endpoint is available.

• DELETING

  Private endpoint is deleting.

ObjectStorage

Yandex Cloud Object Storage.

DnsOptions

privateDnsRecordsEnabled : bool

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

EndpointAddress

Private endpoint ip address details.

subnetId : string

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

address : string

IP address of the private endpoint.

addressId : string

ID of the private endpoint address.

id : string

ID of the private endpoint. Generated at creation time.

folderId : string

ID of the folder that the private endpoint belongs to.

createdAt : 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 : 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]*.

networkId : string

ID of the network that the private endpoint belongs to.

status : Status

Status of the private endpoint.

address : EndpointAddress

Private endpoint ip address details.

dnsOptions : DnsOptions

Private endpoint dns options.

One of service

Service to connect with via private endpoint.

• objectStorage : ObjectStorage

  Yandex Cloud Object Storage.

EndpointAddress

Private endpoint ip address details.

subnetId : string

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

address : string

IP address of the private endpoint.

addressId : string

ID of the private endpoint address.

DnsOptions

privateDnsRecordsEnabled : bool

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

ObjectStorage

Yandex Cloud Object Storage.

---