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

NetworkResponsePagedResponse

Общая страница результатов, используемая конечными точками списка в этом API.

items object[]nullable

Товары на этой странице.

  • Array [
  • idstring<uuid>

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

    projectIdstring<uuid>

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

    namestringnullable

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

    typeNetworkType (string)

    Типовой дискриминатор ресурса.

    Possible values: [Wan, Lan]

    operationResourceOperation (string)

    Допустимое значение для поля операции.

    Possible values: [Provision, Deprovision, AttachVm, ConfigureVm, DetachVm, Start, Stop, Reboot, CreateBackup, DeleteBackup, RestoreVmFromBackup, CreatePortForward, DeletePortForward, UpdatePortForward, Resize, RebuildVm]

    operationStatusApiOperationStatus (string)

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

    Possible values: [Queued, InProgress, Compensation, Succeeded, Failed]

    createdAtstring<date-time>

    Дата и время (UTC), когда сеть была создана.

    subnet object

    Допустимое значение для поля subnet.

    cidr IPNetwork (string)

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

    baseAddress IPAddress (string)

    Допустимое значение для поля base address.

    addressFamilyAddressFamily (string)

    Допустимое значение для поля address family.

    Possible values: [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>

    Уникальный идентификатор области.

    isIPv6Multicastboolean

    Логический флаг, управляющий параметром is ipv6 multicast.

    isIPv6LinkLocalboolean

    Логический флаг, управляющий параметром is ipv6 link local.

    isIPv6SiteLocalboolean

    Логический флаг, управляющий параметром is ipv6 site local.

    isIPv6Teredoboolean

    Логический флаг, управляющий параметром is ipv6 teredo.

    isIPv6UniqueLocalboolean

    Логический флаг, управляющий параметром is ipv6 unique local.

    isIPv4MappedToIPv6boolean

    Логический флаг, управляющий параметром is ipv4 mapped to ipv6.

    addressinteger<int64>deprecated

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

    prefixLengthinteger<int32>

    Значение поля prefix length.

    poolStartIp IPAddress (string)

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

    addressFamilyAddressFamily (string)

    Допустимое значение для поля address family.

    Possible values: [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>

    Уникальный идентификатор области.

    isIPv6Multicastboolean

    Логический флаг, управляющий параметром is ipv6 multicast.

    isIPv6LinkLocalboolean

    Логический флаг, управляющий параметром is ipv6 link local.

    isIPv6SiteLocalboolean

    Логический флаг, управляющий параметром is ipv6 site local.

    isIPv6Teredoboolean

    Логический флаг, управляющий параметром is ipv6 teredo.

    isIPv6UniqueLocalboolean

    Логический флаг, управляющий параметром is ipv6 unique local.

    isIPv4MappedToIPv6boolean

    Логический флаг, управляющий параметром is ipv4 mapped to ipv6.

    addressinteger<int64>deprecated

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

    poolEndIpInclusive IPAddress (string)

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

    addressFamilyAddressFamily (string)

    Допустимое значение для поля address family.

    Possible values: [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>

    Уникальный идентификатор области.

    isIPv6Multicastboolean

    Логический флаг, управляющий параметром is ipv6 multicast.

    isIPv6LinkLocalboolean

    Логический флаг, управляющий параметром is ipv6 link local.

    isIPv6SiteLocalboolean

    Логический флаг, управляющий параметром is ipv6 site local.

    isIPv6Teredoboolean

    Логический флаг, управляющий параметром is ipv6 teredo.

    isIPv6UniqueLocalboolean

    Логический флаг, управляющий параметром is ipv6 unique local.

    isIPv4MappedToIPv6boolean

    Логический флаг, управляющий параметром is ipv4 mapped to ipv6.

    addressinteger<int64>deprecated

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

    gatewayIp IPAddress (string)

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

    addressFamilyAddressFamily (string)

    Допустимое значение для поля address family.

    Possible values: [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>

    Уникальный идентификатор области.

    isIPv6Multicastboolean

    Логический флаг, управляющий параметром is ipv6 multicast.

    isIPv6LinkLocalboolean

    Логический флаг, управляющий параметром is ipv6 link local.

    isIPv6SiteLocalboolean

    Логический флаг, управляющий параметром is ipv6 site local.

    isIPv6Teredoboolean

    Логический флаг, управляющий параметром is ipv6 teredo.

    isIPv6UniqueLocalboolean

    Логический флаг, управляющий параметром is ipv6 unique local.

    isIPv4MappedToIPv6boolean

    Логический флаг, управляющий параметром is ipv4 mapped to ipv6.

    addressinteger<int64>deprecated

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

    vmsInterfaces object[]nullable

    Виртуальные машины, подключенные к сети, и их адреса.

  • Array [
  • vmIdstring<uuid>

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

    vmNamestringnullable

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

    ip IPAddress (string)

    Допустимое значение для поля ip.

    addressFamilyAddressFamily (string)

    Допустимое значение для поля address family.

    Possible values: [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>

    Уникальный идентификатор области.

    isIPv6Multicastboolean

    Логический флаг, управляющий параметром is ipv6 multicast.

    isIPv6LinkLocalboolean

    Логический флаг, управляющий параметром is ipv6 link local.

    isIPv6SiteLocalboolean

    Логический флаг, управляющий параметром is ipv6 site local.

    isIPv6Teredoboolean

    Логический флаг, управляющий параметром is ipv6 teredo.

    isIPv6UniqueLocalboolean

    Логический флаг, управляющий параметром is ipv6 unique local.

    isIPv4MappedToIPv6boolean

    Логический флаг, управляющий параметром is ipv4 mapped to ipv6.

    addressinteger<int64>deprecated

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

  • ]
  • publicIp object

    Допустимое значение для поля публичного IP-адреса.

    idstring<uuid>

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

    ip IPAddress (string)

    Допустимое значение для поля ip.

    addressFamilyAddressFamily (string)

    Допустимое значение для поля address family.

    Possible values: [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>

    Уникальный идентификатор области.

    isIPv6Multicastboolean

    Логический флаг, управляющий параметром is ipv6 multicast.

    isIPv6LinkLocalboolean

    Логический флаг, управляющий параметром is ipv6 link local.

    isIPv6SiteLocalboolean

    Логический флаг, управляющий параметром is ipv6 site local.

    isIPv6Teredoboolean

    Логический флаг, управляющий параметром is ipv6 teredo.

    isIPv6UniqueLocalboolean

    Логический флаг, управляющий параметром is ipv6 unique local.

    isIPv4MappedToIPv6boolean

    Логический флаг, управляющий параметром is ipv4 mapped to ipv6.

    addressinteger<int64>deprecated

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

    geolocationstringnullable

    Географическое местоположение, связанное с общедоступным IP-адресом.

    portForwardRules object[]nullable

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

  • Array [
  • vmIdstring<uuid>

    Идентификатор виртуальной машины, на которую нацелено правило.

    vmNamestringnullable

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

    statusPortForwardStatus (string)

    Текущий статус ресурса.

    Possible values: [Created, Creating, Updating, Deleting]

    rule object

    Допустимое значение для поля rule.

    modePortForwardMode (string)

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

    Possible values: [SpecificPorts, AllPorts]

    protocolPortForwardProtocol (string)

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

    Possible values: [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",
    "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
    }