Get

Returns the specified Subnet resource.

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

TypeScript

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

const GetSubnetRequest = cloudApi.vpc.subnet_service.GetSubnetRequest;

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

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.vpc.v1.subnet_service_pb2 import GetSubnetRequest
from yandex.cloud.vpc.v1.subnet_service_pb2_grpc import SubnetServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(SubnetServiceStub)
response = service.Get(GetSubnetRequest(subnet_id="subnetId"))
print(response)

GetSubnetRequest

subnetId : string

ID of the Subnet resource to return. To get the subnet ID use a SubnetService.List request.

Subnet

A Subnet resource. For more information, see Subnets.

id : string

ID of the subnet.

folderId : string

ID of the folder that the subnet belongs to.

createdAt : google.protobuf.Timestamp

Creation timestamp in RFC3339 text format.

name : string

Name of the subnet. The name must be 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

Optional description of the subnet. 0-256 characters long.

labels : string

Resource labels, 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 the subnet belongs to.

zoneId : string

ID of the availability zone where the subnet resides.

v4CidrBlocks : string

CIDR block. The range of internal addresses that are defined for this subnet. This field can be set only at Subnet resource creation time and cannot be changed. For example, 10.0.0.0/22 or 192.168.0.0/24. Minimum subnet size is /28, maximum subnet size is /16.

v6CidrBlocks : string

IPv6 not available yet.

routeTableId : string

ID of route table the subnet is linked to.

dhcpOptions : DhcpOptions

DHCP options for the subnet.

DhcpOptions

domainNameServers : string

A list of DHCP servers for this subnet.

domainName : string

A domain name to us as a suffix when resolving host names in this subnet.

ntpServers : string

List of NTP servers for this subnet.

---