BareMetal API, gRPC: PublicSubnetService.GetPublicSubnet
Returns the specific PublicSubnet resource.
To get the list of available PublicSubnet resources, make a [List] request.
https://google.aip.dev/130 --)
gRPC request
rpc GetPublicSubnet (GetPublicSubnetRequest) returns (PublicSubnet)
GetPublicSubnetRequest
{
"cloud_id": "string",
"folder_id": "string",
"public_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. |
|
public_subnet_id |
string ID of the PublicSubnet resource to return. To get the public subnet ID use a [PublicSubnetService.List] request. |
PublicSubnet
{
"public_subnet_id": "string",
"cloud_id": "string",
"folder_id": "string",
"name": "string",
"description": "string",
"hardware_pool_ids": [
"string"
],
"type": "Type",
// Includes only one of the fields `auto_allocation`, `manual_allocation`
"auto_allocation": {
"prefix_length": "int64"
},
"manual_allocation": {
"cidr": "string",
"public_prefix_pool_id": "string"
},
// end of the list of possible fields
"prefix_length": "int64",
"cidr": "string",
"dhcp_options": {
"start_ip": "string",
"end_ip": "string"
},
"gateway_ip": "string",
"public_prefix_pool_id": "string",
"create_time": "google.protobuf.Timestamp",
"update_time": "google.protobuf.Timestamp",
"annotations": "map<string, string>",
"deletion_unlock_time": "google.protobuf.Timestamp"
}
A PublicSubnet resource.
|
Field |
Description |
|
public_subnet_id |
string ID of the public subnet. |
|
cloud_id |
string ID of the cloud that the public subnet belongs to. |
|
folder_id |
string ID of the folder that the public 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 public subnet. The maximum string length in characters is 1024. |
|
hardware_pool_ids[] |
string IDs of the hardware pool that the public subnet belongs to. |
|
type |
enum Type Type of the public subnet (dedicated or ephemeral). Cannot be set on creation. It's DEDICATED by default. EPHEMERAL networks are created only within the server.
|
|
auto_allocation |
Automatic CIDR allocation from the system public prefix pool. Includes only one of the fields Method for allocating CIDR block to the public subnet. |
|
manual_allocation |
Manual CIDR allocation with explicit CIDR from user's own public prefix pool (BYOIP). Includes only one of the fields Method for allocating CIDR block to the public subnet. |
|
prefix_length |
int64 Prefix length of the public subnet CIDR block. |
|
cidr |
string CIDR block for the public subnet. |
|
dhcp_options |
DHCP options for the public subnet. |
|
gateway_ip |
string Gateway IP address for the public subnet. |
|
public_prefix_pool_id |
string ID of the public prefix pool that the public subnet belongs to. |
|
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 |
|
deletion_unlock_time |
Timestamp when deletion of the public subnet is allowed. |
AutoAllocation
|
Field |
Description |
|
prefix_length |
int64 Prefix length of the public subnet CIDR block. Acceptable values are 1 to 31, inclusive. |
ManualAllocation
|
Field |
Description |
|
cidr |
string CIDR block of the public subnet. Must be within the public prefix pool CIDR block. |
|
public_prefix_pool_id |
string ID of the public prefix pool that the CIDR block belongs to. To get a list of available public prefix pools, use the [PublicPrefixPoolService.List] request. |
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). |