Связаться с намиПопробовать бесплатно

BareMetal API, REST: PrivateSubnet.Get

Статья создана
Обновлена 8 августа 2025 г.

Returns the specific PrivateSubnet resource.

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

HTTP request

GET https://baremetal.api.cloud.yandex.net/baremetal/v1alpha/privateSubnets/{privateSubnetId}

Path parameters

Field

Description

privateSubnetId

string

Required field. ID of the PrivateSubnet resource to return.

To get the private subnet ID use a PrivateSubnetService.List request.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "cloudId": "string",
  "folderId": "string",
  "name": "string",
  "description": "string",
  "status": "string",
  "zoneId": "string",
  "hardwarePoolId": "string",
  "vrfOptions": {
    "vrfId": "string",
    "cidr": "string",
    "dhcpOptions": {
      "startIp": "string",
      "endIp": "string"
    },
    "gatewayIp": "string"
  },
  "createdAt": "string",
  "labels": "object"
}

A PrivateSubnet resource.

Field

Description

id

string

ID of the private subnet.

cloudId

string

ID of the cloud that the private subnet belongs to.

folderId

string

ID of the folder that the private subnet belongs to.

name

string

Name of the private subnet.
The name is unique within the folder.

description

string

Optional description of the private subnet.

status

enum (Status)

Status of the private subnet.

  • STATUS_UNSPECIFIED: Unspecified private subnet status.
  • CREATING: Private subnet is being created.
  • READY: Private subnet is ready to use.
  • UPDATING: Private subnet is being updated.
  • DELETING: Private subnet is being deleted.
  • ERROR: Private subnet encountered a problem and cannot operate.

zoneId

string

ID of the availability zone where the server resides.

hardwarePoolId

string

ID of the hardware pool that the private subnet belongs to.

vrfOptions

VrfOptions

Optional VRF options for the private subnet. If missing, the private subnet will be unrouted,
i.e. it will lack a DHCP server and routing capabilities between this subnet and other private
subnets.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

labels

object (map<string, string>)

Resource labels as key:value pairs.

VrfOptions

VRF options for the private subnet.

Field

Description

vrfId

string

ID of the VRF.

cidr

string

CIDR block for the subnet.

dhcpOptions

DhcpOptions

DHCP options for the subnet.

gatewayIp

string

Gateway IP address for the subnet.

DhcpOptions

DHCP options for a subnet.

Field

Description

startIp

string

Start IP address of the DHCP range (inclusive).

endIp

string

End IP address of the DHCP range (inclusive).
Предыдущая
Overview
Следующая
List