BareMetal API, gRPC: PrivateSubnetService.GetPrivateSubnet
Returns the specific PrivateSubnet resource.
To get the list of available PrivateSubnet resources, make a [List] request.
https://google.aip.dev/130 --)
gRPC request
rpc GetPrivateSubnet (GetPrivateSubnetRequest) returns (PrivateSubnet)
GetPrivateSubnetRequest
{
"cloud_id": "string",
"folder_id": "string",
"private_subnet_id": "string"
}
|
Field |
Description |
|
cloud_id |
string ID of the parent cloud. To get the cloud ID, use a yandex.cloud.resourcemanager.v1.CloudService.List request. |
|
folder_id |
string ID of the parent folder. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. |
|
private_subnet_id |
string ID of the PrivateSubnet resource to return. To get the private subnet ID use a [PrivateSubnetService.List] request. |
PrivateSubnet
{
"private_subnet_id": "string",
"cloud_id": "string",
"folder_id": "string",
"name": "string",
"description": "string",
"state": "State",
"hardware_pool_id": "string",
"vrf_options": {
"vrf_id": "string",
"cidr": "string",
"dhcp_options": {
"start_ip": "string",
"end_ip": "string"
},
"gateway_ip": "string"
},
"create_time": "google.protobuf.Timestamp",
"update_time": "google.protobuf.Timestamp",
"annotations": "map<string, string>",
"zone_id": "string"
}
A PrivateSubnet resource.
|
Field |
Description |
|
private_subnet_id |
string ID of the private subnet. |
|
cloud_id |
string ID of the cloud that the private subnet belongs to. |
|
folder_id |
string ID of the folder that the private subnet belongs to. |
|
name |
string Name of the public subnet. The string length in characters must be 2-63. Value must match the regular expression |
|
description |
string Optional description of the private subnet. The maximum string length in characters is 1024. |
|
state |
enum State State of the private subnet.
|
|
hardware_pool_id |
string ID of the hardware pool that the private subnet belongs to. The maximum string length in characters is 20. |
|
vrf_options |
Optional VRF options for the private subnet. If missing, the private subnet will be unrouted, |
|
create_time |
Creation timestamp. |
|
update_time |
Update timestamp. |
|
annotations |
object (map<string, string>) Resource annotations as The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression |
|
zone_id |
string ID of the availability zone where the server resides. |
VrfOptions
VRF options for the private subnet.
|
Field |
Description |
|
vrf_id |
string ID of the VRF. |
|
cidr |
string CIDR block for the subnet. |
|
dhcp_options |
DHCP options for the subnet. |
|
gateway_ip |
string Gateway IP address for the subnet. |
DhcpOptions
DHCP options for a subnet.
|
Field |
Description |
|
start_ip |
string Start IP address of the DHCP range (inclusive). |
|
end_ip |
string End IP address of the DHCP range (inclusive). |