Перейти к основному содержимому

NetworkResponsePagedResponse

Обычная страница результатов: её возвращают все списочные эндпоинты этого API.

items object[]nullable

Элементы на этой странице.

  • Array [
    • idstring<uuid>

    Идентификатор сети.

    projectIdstring<uuid>

    Идентификатор проекта, которому принадлежит сеть.

    namestringnullable

    Отображаемое имя сети, если оно задано.

    typeNetworkType (string)

    Тип ресурса.

    Возможные значения: [Wan, Lan]

    operationResourceOperation (string)

    Последняя (или выполняемая сейчас) операция, записанная для ресурса.

    Возможные значения: [Provision, Deprovision, AttachVm, ConfigureVm, DetachVm, Start, Stop, Reboot, CreateBackup, DeleteBackup, RestoreVmFromBackup, CreatePortForward, DeletePortForward, UpdatePortForward, Resize, RebuildVm]

    operationStatusApiOperationStatus (string)

    Текущий статус асинхронной операции.

    Возможные значения: [Queued, InProgress, Compensation, Succeeded, Failed]

    statusResourceStatus (string)

    Текущее состояние ресурса.

    Возможные значения: [creating, active, updating, deleting, failed]

    createdAtstring<date-time>

    Дата и время создания сети (UTC).

    subnet object

    Адресация сети: CIDR-блок, шлюз и пул адресов.

    cidr IPNetwork (string)

    CIDR-блок, описывающий подсеть или сетевой диапазон.

    baseAddress IPAddress (string)

    Первый адрес диапазона сети.

    addressFamilyAddressFamily (string)

    Семейство адресов: IPv4 или IPv6.

    Возможные значения: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]

    scopeIdinteger<int64>

    Идентификатор области (scope) IPv6-адреса.

    isIPv6Multicastboolean

    Является ли адрес IPv6 multicast-адресом.

    isIPv6LinkLocalboolean

    Является ли адрес IPv6 link-local адресом.

    isIPv6SiteLocalboolean

    Является ли адрес IPv6 site-local адресом.

    isIPv6Teredoboolean

    Является ли адрес IPv6-адресом Teredo.

    isIPv6UniqueLocalboolean

    Является ли адрес IPv6 unique-local адресом.

    isIPv4MappedToIPv6boolean

    Является ли адрес IPv4-адресом, отображённым в пространство IPv6.

    addressinteger<int64>deprecated

    Значение IP-адреса.

    prefixLengthinteger<int32>

    Длина префикса сети в битах — то самое /24 в записи 10.0.0.0/24.

    poolStartIp IPAddress (string)

    Первый IP-адрес в пуле выделения.

    addressFamilyAddressFamily (string)

    Семейство адресов: IPv4 или IPv6.

    Возможные значения: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]

    scopeIdinteger<int64>

    Идентификатор области (scope) IPv6-адреса.

    isIPv6Multicastboolean

    Является ли адрес IPv6 multicast-адресом.

    isIPv6LinkLocalboolean

    Является ли адрес IPv6 link-local адресом.

    isIPv6SiteLocalboolean

    Является ли адрес IPv6 site-local адресом.

    isIPv6Teredoboolean

    Является ли адрес IPv6-адресом Teredo.

    isIPv6UniqueLocalboolean

    Является ли адрес IPv6 unique-local адресом.

    isIPv4MappedToIPv6boolean

    Является ли адрес IPv4-адресом, отображённым в пространство IPv6.

    addressinteger<int64>deprecated

    Значение IP-адреса.

    poolEndIpInclusive IPAddress (string)

    Последний IP-адрес, входящий в пул выделения.

    addressFamilyAddressFamily (string)

    Семейство адресов: IPv4 или IPv6.

    Возможные значения: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]

    scopeIdinteger<int64>

    Идентификатор области (scope) IPv6-адреса.

    isIPv6Multicastboolean

    Является ли адрес IPv6 multicast-адресом.

    isIPv6LinkLocalboolean

    Является ли адрес IPv6 link-local адресом.

    isIPv6SiteLocalboolean

    Является ли адрес IPv6 site-local адресом.

    isIPv6Teredoboolean

    Является ли адрес IPv6-адресом Teredo.

    isIPv6UniqueLocalboolean

    Является ли адрес IPv6 unique-local адресом.

    isIPv4MappedToIPv6boolean

    Является ли адрес IPv4-адресом, отображённым в пространство IPv6.

    addressinteger<int64>deprecated

    Значение IP-адреса.

    gatewayIp IPAddress (string)

    IP-адрес шлюза для подсети.

    addressFamilyAddressFamily (string)

    Семейство адресов: IPv4 или IPv6.

    Возможные значения: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]

    scopeIdinteger<int64>

    Идентификатор области (scope) IPv6-адреса.

    isIPv6Multicastboolean

    Является ли адрес IPv6 multicast-адресом.

    isIPv6LinkLocalboolean

    Является ли адрес IPv6 link-local адресом.

    isIPv6SiteLocalboolean

    Является ли адрес IPv6 site-local адресом.

    isIPv6Teredoboolean

    Является ли адрес IPv6-адресом Teredo.

    isIPv6UniqueLocalboolean

    Является ли адрес IPv6 unique-local адресом.

    isIPv4MappedToIPv6boolean

    Является ли адрес IPv4-адресом, отображённым в пространство IPv6.

    addressinteger<int64>deprecated

    Значение IP-адреса.

    vmsInterfaces object[]nullable

    Машины, подключённые к сети, и их адреса.

  • Array [
    • vmIdstring<uuid>

    Идентификатор подключённой машины.

    vmNamestringnullable

    Имя машины, если оно известно.

    ip IPAddress (string)

    Сам IP-адрес в записи через точки.

    addressFamilyAddressFamily (string)

    Семейство адресов: IPv4 или IPv6.

    Возможные значения: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]

    scopeIdinteger<int64>

    Идентификатор области (scope) IPv6-адреса.

    isIPv6Multicastboolean

    Является ли адрес IPv6 multicast-адресом.

    isIPv6LinkLocalboolean

    Является ли адрес IPv6 link-local адресом.

    isIPv6SiteLocalboolean

    Является ли адрес IPv6 site-local адресом.

    isIPv6Teredoboolean

    Является ли адрес IPv6-адресом Teredo.

    isIPv6UniqueLocalboolean

    Является ли адрес IPv6 unique-local адресом.

    isIPv4MappedToIPv6boolean

    Является ли адрес IPv4-адресом, отображённым в пространство IPv6.

    addressinteger<int64>deprecated

    Значение IP-адреса.

  • ]
    • publicIp object

    Публичный IP-адрес, привязанный к сети, если он есть.

    idstring<uuid>

    Идентификатор публичного IP-адреса.

    ip IPAddress (string)

    Сам IP-адрес в записи через точки.

    addressFamilyAddressFamily (string)

    Семейство адресов: IPv4 или IPv6.

    Возможные значения: [Unknown, Unspecified, Unix, InterNetwork, ImpLink, Pup, Chaos, NS, Ipx, Iso, Osi, Ecma, DataKit, Ccitt, Sna, DecNet, DataLink, Lat, HyperChannel, AppleTalk, NetBios, VoiceView, FireFox, Banyan, Atm, InterNetworkV6, Cluster, Ieee12844, Irda, NetworkDesigners, Max, Packet, ControllerAreaNetwork]

    scopeIdinteger<int64>

    Идентификатор области (scope) IPv6-адреса.

    isIPv6Multicastboolean

    Является ли адрес IPv6 multicast-адресом.

    isIPv6LinkLocalboolean

    Является ли адрес IPv6 link-local адресом.

    isIPv6SiteLocalboolean

    Является ли адрес IPv6 site-local адресом.

    isIPv6Teredoboolean

    Является ли адрес IPv6-адресом Teredo.

    isIPv6UniqueLocalboolean

    Является ли адрес IPv6 unique-local адресом.

    isIPv4MappedToIPv6boolean

    Является ли адрес IPv4-адресом, отображённым в пространство IPv6.

    addressinteger<int64>deprecated

    Значение IP-адреса.

    geolocationstringnullable

    Географическое расположение публичного IP-адреса.

    portForwardRules object[]nullable

    Правила проброса портов, настроенные на публичном IP-адресе.

  • Array [
    • vmIdstring<uuid>

    Идентификатор машины, к которой относится правило.

    vmNamestringnullable

    Имя целевой машины, если оно известно.

    statusPortForwardStatus (string)

    Текущее состояние ресурса.

    Возможные значения: [Created, Creating, Updating, Deleting]

    rule object

    Параметры правила: протокол, режим и порты.

    modePortForwardMode (string)

    Режим, определяющий поведение ресурса.

    Возможные значения: [SpecificPorts, AllPorts]

    protocolPortForwardProtocol (string)

    Протокол, используемый ресурсом или правилом проброса.

    Возможные значения: [Tcp, Udp, TcpUdp]

    externalPortinteger<int32>nullable

    Внешний порт, если он применим для выбранного режима.

    internalPortinteger<int32>nullable

    Внутренний порт на стороне машины, куда пересылается трафик, если это применимо для выбранного режима.

  • ]
  • ]
    • totalinteger<int32>

    Общее количество элементов на всех страницах.

    pageinteger<int32>

    Текущий номер страницы, начиная с 1.

    pageSizeinteger<int32>

    Количество элементов на странице.

    totalPagesinteger<int32>

    Общее количество доступных страниц.

    hasNextPageboolean

    Есть ли следующая страница.

    NetworkResponsePagedResponse
    {
      "items": [
        {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "projectId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "type": "Wan",
          "operation": "Provision",
          "operationStatus": "Queued",
          "status": "creating",
          "createdAt": "2024-07-29T15:51:28.071Z",
          "subnet": {
            "cidr": "10.0.0.0/24",
            "poolStartIp": "192.168.0.1",
            "poolEndIpInclusive": "192.168.0.1",
            "gatewayIp": "192.168.0.1"
          },
          "vmsInterfaces": [
            {
              "vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "vmName": "string",
              "ip": "192.168.0.1"
            }
          ],
          "publicIp": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ip": "192.168.0.1",
            "geolocation": "string",
            "portForwardRules": [
              {
                "vmId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "vmName": "string",
                "status": "Created",
                "rule": {
                  "mode": "SpecificPorts",
                  "protocol": "Tcp",
                  "externalPort": 0,
                  "internalPort": 0
                }
              }
            ]
          }
        }
      ],
      "total": 0,
      "page": 0,
      "pageSize": 0,
      "totalPages": 0,
      "hasNextPage": true
    }