Подключиться
Yandex Virtual Private Cloud

SubnetService

Набор методов для управления подсетями.

Вызов Описание
Get Возвращает указанный ресурс Subnet.
List Возвращает список доступных подсетей в указанном каталоге.
Create Создает подсеть в указанных каталоге и сети.
Update Обновляет параметры указанной подсети.
Delete Удаляет указанную подсеть.
ListOperations Возвращает список операций для указанной подсети.

Вызовы SubnetService

Get

Возвращает указанный ресурс Subnet.
Чтобы получить список доступных подсетей, используйте запрос List.

rpc Get (GetSubnetRequest) returns (Subnet)

GetSubnetRequest

Поле Описание
subnet_id string
Обязательное поле. Идентификатор возвращаемого ресурса Subnet.
Чтобы получить идентификатор подсети, используйте запрос SubnetService.List. Максимальная длина строки в символах — 50.

Subnet

Поле Описание
id string
Идентификатор подсети.
folder_id string
Идентификатор каталога, которому принадлежит подсеть.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
name string
Имя подсети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание подсети. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Метки ресурса в формате ключ:значение. Максимум 64 метки на ресурс.
network_id string
Идентификатор облачной сети, к которой принадлежит подсеть.
zone_id string
Идентификатор зоны доступности, где находится подсеть.
v4_cidr_blocks[] string
v6_cidr_blocks[] string
IPv6 еще не доступен.

List

Возвращает список доступных подсетей в указанном каталоге.

rpc List (ListSubnetsRequest) returns (ListSubnetsResponse)

ListSubnetsRequest

Поле Описание
folder_id string
Обязательное поле. Идентификатор каталога для получения списка подсетей. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
page_size int64
Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListSubnetsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
page_token string
Токен страницы. Установите значение page_token равным значению поля ListSubnetsResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter string
  1. Имя поля. В настоящее время фильтрация осуществляется только по полю Subnet.name.
  2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений.
  3. Значение. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$.
Максимальная длина строки в символах — 1000.

ListSubnetsResponse

Поле Описание
subnets[] Subnet
Список подсетей.
next_page_token string
Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListSubnetsRequest.page_size, используйте next_page_token в качестве значения параметра ListSubnetsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token, для перебора страниц результатов.

Subnet

Поле Описание
id string
Идентификатор подсети.
folder_id string
Идентификатор каталога, которому принадлежит подсеть.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
name string
Имя подсети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание подсети. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Метки ресурса в формате ключ:значение. Максимум 64 метки на ресурс.
network_id string
Идентификатор облачной сети, к которой принадлежит подсеть.
zone_id string
Идентификатор зоны доступности, где находится подсеть.
v4_cidr_blocks[] string
v6_cidr_blocks[] string
IPv6 еще не доступен.

Create

Создает подсеть в указанных каталоге и сети. Метод запускает асинхронную операцию, которую можно отменить перед тем, как она завершится.

rpc Create (CreateSubnetRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:CreateSubnetMetadata

    Operation.response:Subnet

CreateSubnetRequest

Поле Описание
folder_id string
Обязательное поле. Идентификатор каталога, в котором создается подсеть. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50.
name string
Имя подсети. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание подсети. Максимальная длина строки в символах — 256.
labels map<string,string>
Метки ресурса в формате ключ:значение. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
network_id string
Обязательное поле. Идентификатор облачной сети, в которой создается подсеть. Максимальная длина строки в символах — 50.
zone_id string
Идентификатор зоны доступности, где находится подсеть. Чтобы получить список доступных зон, используйте запрос yandex.cloud.compute.v1.ZoneService.List. Максимальная длина строки в символах — 50.
v4_cidr_blocks[] string
v6_cidr_blocks[] string
Диапазоны IPv6 еще не доступны.
route_table_id string
ID of route table the subnet is linked to. Максимальная длина строки в символах — 50.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<CreateSubnetMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<Subnet>
в случае успешного выполнения операции.

CreateSubnetMetadata

Поле Описание
subnet_id string
Идентификатор создаваемой подсети.

Subnet

Поле Описание
id string
Идентификатор подсети.
folder_id string
Идентификатор каталога, которому принадлежит подсеть.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
name string
Имя подсети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание подсети. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Метки ресурса в формате ключ:значение. Максимум 64 метки на ресурс.
network_id string
Идентификатор облачной сети, к которой принадлежит подсеть.
zone_id string
Идентификатор зоны доступности, где находится подсеть.
v4_cidr_blocks[] string
v6_cidr_blocks[] string
IPv6 еще не доступен.

Update

Обновляет параметры указанной подсети. Метод запускает асинхронную операцию, которую можно отменить перед тем, как она завершится.

rpc Update (UpdateSubnetRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:UpdateSubnetMetadata

    Operation.response:Subnet

UpdateSubnetRequest

Поле Описание
subnet_id string
Обязательное поле. Идентификатор обновляемого ресурса Subnet. Максимальная длина строки в символах — 50.
update_mask google.protobuf.FieldMask
Маска, определяющая, какие поля ресурса Subnet будут обновлены.
name string
Имя подсети. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
description string
Описание подсети. Максимальная длина строки в символах — 256.
labels map<string,string>
Метки ресурса в формате ключ:значение. Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]*. Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]*.
route_table_id string
ID of route table the subnet is linked to. Максимальная длина строки в символах — 50.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<UpdateSubnetMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<Subnet>
в случае успешного выполнения операции.

UpdateSubnetMetadata

Поле Описание
subnet_id string
Идентификатор обновляемого ресурса Subnet.

Subnet

Поле Описание
id string
Идентификатор подсети.
folder_id string
Идентификатор каталога, которому принадлежит подсеть.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
name string
Имя подсети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов.
description string
Описание подсети. Длина описания должна быть от 0 до 256 символов.
labels map<string,string>
Метки ресурса в формате ключ:значение. Максимум 64 метки на ресурс.
network_id string
Идентификатор облачной сети, к которой принадлежит подсеть.
zone_id string
Идентификатор зоны доступности, где находится подсеть.
v4_cidr_blocks[] string
v6_cidr_blocks[] string
IPv6 еще не доступен.

Delete

Удаляет указанную подсеть.

rpc Delete (DeleteSubnetRequest) returns (operation.Operation)

Метаданные и результат операции:

    Operation.metadata:DeleteSubnetMetadata

    Operation.response:google.protobuf.Empty

DeleteSubnetRequest

Поле Описание
subnet_id string
Обязательное поле. Идентификатор удаляемой подсети. Чтобы получить идентификатор подсети, используйте запрос SubnetService.List. Максимальная длина строки в символах — 50.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any<DeleteSubnetMetadata>
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any<google.protobuf.Empty>
в случае успешного выполнения операции.

DeleteSubnetMetadata

Поле Описание
subnet_id string
Идентификатор удаляемого ресурса Subnet.

ListOperations

Возвращает список операций для указанной подсети.

rpc ListOperations (ListSubnetOperationsRequest) returns (ListSubnetOperationsResponse)

ListSubnetOperationsRequest

Поле Описание
subnet_id string
Обязательное поле. Идентификатор ресурса Subnet, для которого запрашивается список операций. Максимальная длина строки в символах — 50.
page_size int64
Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size, сервис вернет значение ListNetworkOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
page_token string
Токен страницы. Установите значение page_token равным значению поля ListNetworkSubnetsResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.

ListSubnetOperationsResponse

Поле Описание
operations[] operation.Operation
Список операций для указанного ресурса Subnet.
next_page_token string
Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListNetworkSubnetsRequest.page_size, используйте next_page_token в качестве значения параметра ListNetworkSubnetsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token, для перебора страниц результатов.

Operation

Поле Описание
id string
Идентификатор операции.
description string
Описание операции. Длина описания должна быть от 0 до 256 символов.
created_at google.protobuf.Timestamp
Время создания ресурса в формате в RFC3339.
created_by string
Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.
modified_at google.protobuf.Timestamp
Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.
done bool
Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.
metadata google.protobuf.Any
Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.
result oneof: error или response
Результат операции. Если done == false и не было выявлено ошибок — значения полей error и response не заданы. Если done == false и была выявлена ошибка — задано значение поля error. Если done == true — задано значение ровно одного из полей error или response.
  error google.rpc.Status
Описание ошибки в случае сбоя или отмены операции.
  response google.protobuf.Any
Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.
В этой статье: