NetworkService
Набор методов для управления облачными сетями.
Вызов | Описание |
---|---|
Get | Возвращает указанный ресурс Network. |
List | Возвращает список доступных ресурсов Network в указанном каталоге. |
Create | Создает облачную сеть в указанном каталоге. |
Update | Обновляет параметры указанной облачной сети. |
Delete | Удаляет указанную облачную сеть. |
ListSubnets | Возвращает список доступных подсетей в указанной облачной сети. |
ListOperations | Возвращает список операций для указанной облачной сети. |
Вызовы NetworkService
Get
Возвращает указанный ресурс Network.
Чтобы получить список доступных ресурсов Network, используйте запрос List.
rpc Get (GetNetworkRequest) returns (Network)
GetNetworkRequest
Поле | Описание |
---|---|
network_id | string Обязательное поле. Идентификатор возвращаемого ресурса Network. Чтобы получить идентификатор облачной сети, используйте запрос NetworkService.List. Максимальная длина строки в символах — 50. |
Network
Поле | Описание |
---|---|
id | string Идентификатор облачной сети. |
folder_id | string Идентификатор каталога, которому принадлежит сеть. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
name | string Имя облачной сети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. |
description | string Описание облачной сети. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 метки на ресурс. |
default_security_group_id | string Идентификатор группы безопасности по умолчанию. |
List
Возвращает список доступных ресурсов Network в указанном каталоге.
rpc List (ListNetworksRequest) returns (ListNetworksResponse)
ListNetworksRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога для получения списка облачных сетей. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListNetworksResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListNetworksResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
filter | string
|
ListNetworksResponse
Поле | Описание |
---|---|
networks[] | Network Список ресурсов Network. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListNetworkSubnetsRequest.page_size, используйте next_page_token в качестве значения параметра ListNetworkSubnetsRequest.page_token в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения next_page_token , для перебора страниц результатов. |
Network
Поле | Описание |
---|---|
id | string Идентификатор облачной сети. |
folder_id | string Идентификатор каталога, которому принадлежит сеть. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
name | string Имя облачной сети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. |
description | string Описание облачной сети. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 метки на ресурс. |
default_security_group_id | string Идентификатор группы безопасности по умолчанию. |
Create
Создает облачную сеть в указанном каталоге. Метод запускает асинхронную операцию, которую можно отменить перед тем, как она завершится.
rpc Create (CreateNetworkRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:CreateNetworkMetadata
Operation.response:Network
CreateNetworkRequest
Поле | Описание |
---|---|
folder_id | string Обязательное поле. Идентификатор каталога, в котором создается облачная сеть. Чтобы получить идентификатор каталога, используйте запрос yandex.cloud.resourcemanager.v1.FolderService.List. Максимальная длина строки в символах — 50. |
name | string Имя облачной сети. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению ` |
description | string Описание облачной сети. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
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<CreateNetworkMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Network> в случае успешного выполнения операции. |
CreateNetworkMetadata
Поле | Описание |
---|---|
network_id | string Идентификатор создаваемой облачной сети. |
Network
Поле | Описание |
---|---|
id | string Идентификатор облачной сети. |
folder_id | string Идентификатор каталога, которому принадлежит сеть. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
name | string Имя облачной сети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. |
description | string Описание облачной сети. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 метки на ресурс. |
default_security_group_id | string Идентификатор группы безопасности по умолчанию. |
Update
Обновляет параметры указанной облачной сети. Метод запускает асинхронную операцию, которую можно отменить перед тем, как она завершится.
rpc Update (UpdateNetworkRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:UpdateNetworkMetadata
Operation.response:Network
UpdateNetworkRequest
Поле | Описание |
---|---|
network_id | string Обязательное поле. Идентификатор обновляемого ресурса Network. Для получения идентификатора облачной сети используйте запрос NetworkService.List. Максимальная длина строки в символах — 50. |
update_mask | google.protobuf.FieldMask Маска, определяющая, какие поля облачной сети будут обновлены. |
name | string Имя облачной сети. Имя должно быть уникальным в каталоге. Значение должно соответствовать регулярному выражению ` |
description | string Описание облачной сети. Максимальная длина строки в символах — 256. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Не более 64 на ресурс. Максимальная длина строки в символах для каждого значения — 63. Каждое значение должно соответствовать регулярному выражению [-_0-9a-z]* . Длина строки в символах для каждого ключа должна быть от 1 до 63. Каждый ключ должен соответствовать регулярному выражению [a-z][-_0-9a-z]* . |
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<UpdateNetworkMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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<Network> в случае успешного выполнения операции. |
UpdateNetworkMetadata
Поле | Описание |
---|---|
network_id | string Идентификатор обновляемого ресурса Network. |
Network
Поле | Описание |
---|---|
id | string Идентификатор облачной сети. |
folder_id | string Идентификатор каталога, которому принадлежит сеть. |
created_at | google.protobuf.Timestamp Время создания ресурса в формате в RFC3339. |
name | string Имя облачной сети. Имя должно быть уникальным в каталоге. Длина имени должна быть от 3 до 63 символов. |
description | string Описание облачной сети. Длина описания должна быть от 0 до 256 символов. |
labels | map<string,string> Метки ресурса в формате ключ:значение . Максимум 64 метки на ресурс. |
default_security_group_id | string Идентификатор группы безопасности по умолчанию. |
Delete
Удаляет указанную облачную сеть.
rpc Delete (DeleteNetworkRequest) returns (operation.Operation)
Метаданные и результат операции:
Operation.metadata:DeleteNetworkMetadata
Operation.response:google.protobuf.Empty
DeleteNetworkRequest
Поле | Описание |
---|---|
network_id | string Обязательное поле. Идентификатор обновляемого ресурса Network. Чтобы получить идентификатор облачной сети, используйте запрос NetworkService.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<DeleteNetworkMetadata> Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс 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> в случае успешного выполнения операции. |
DeleteNetworkMetadata
Поле | Описание |
---|---|
network_id | string Идентификатор удаляемой облачной сети. |
ListSubnets
Возвращает список доступных подсетей в указанной облачной сети.
rpc ListSubnets (ListNetworkSubnetsRequest) returns (ListNetworkSubnetsResponse)
ListNetworkSubnetsRequest
Поле | Описание |
---|---|
network_id | string Обязательное поле. Идентификатор ресурса Network для получения списка подсетей. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListNetworkSubnetsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListNetworkSubnetsResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListNetworkSubnetsResponse
Поле | Описание |
---|---|
subnets[] | Subnet Список подсетей, принадлежащих облачной сети, указанной в запросе. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListNetworkSubnetsRequest.page_size, используйте next_page_token в качестве значения параметра ListNetworkSubnetsRequest.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 еще не доступен. |
ListOperations
Возвращает список операций для указанной облачной сети.
rpc ListOperations (ListNetworkOperationsRequest) returns (ListNetworkOperationsResponse)
ListNetworkOperationsRequest
Поле | Описание |
---|---|
network_id | string Обязательное поле. Идентификатор ресурса Network, для которого запрашивается список операций. Максимальная длина строки в символах — 50. |
page_size | int64 Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем page_size , сервис вернет значение ListNetworkOperationsResponse.next_page_token, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
page_token | string Токен страницы. Установите значение page_token равным значению поля ListNetworkOperationsResponse.next_page_token прошлого запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
ListNetworkOperationsResponse
Поле | Описание |
---|---|
operations[] | operation.Operation Список операций для указанной облачной сети. |
next_page_token | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем ListNetworkOperationsRequest.page_size, используйте next_page_token в качестве значения параметра ListNetworkOperationsRequest.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 . |