BareMetal API, REST: PrivateSubnet.Get
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. |
|
description |
string Optional description of the private subnet. |
|
status |
enum (Status) Status of the private subnet.
|
|
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 |
Optional VRF options for the private subnet. If missing, the private subnet will be unrouted, |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
labels |
object (map<string, string>) Resource labels as |
VrfOptions
VRF options for the private subnet.
|
Field |
Description |
|
vrfId |
string ID of the VRF. |
|
cidr |
string CIDR block for the subnet. |
|
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). |