Network instances

A network instance is a network's presence on one node: the pipelines generated for that node from the network's blueprints. Instances are created, updated and removed automatically when their network changes, so they cannot be managed directly. Use this service to see which networks a node takes part in, follow its network pipelines, turn them on or off, and read their logs. The node needs pipelines enabled.

Get network instances

Get all network instances on a node, each with its pipelines.

REST

GET/v1/nodes/{node_id}/network-instances

Path parameters

• node_idstring

  The ID of the node to fetch network instances from.

Example

TypeScript

import { NanopingClient } from "@nanoping/api";

const client = new NanopingClient({ baseUrl: "http://127.0.0.1:10565" });

const response = await client.networkInstances.getNetworkInstances({
  nodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"
});

Python

from nanoping_api import NanopingClient

client = NanopingClient("http://127.0.0.1:10565")

response = client.network_instances.get_network_instances(
    node_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
)

curl

curl 'http://127.0.0.1:10565/v1/nodes/<node_id>/network-instances'

Response

• networkInstancesNetworkInstance[]

  The network instances of the node.

gRPC

rpc getNetworkInstances(GetNetworkInstancesRequest) returns (GetNetworkInstancesResponse)

Method /nanopinggrpc.networks.NetworkInstances/getNetworkInstances

Request

• node_idstring

  The ID of the node to fetch network instances from.

Response

• network_instancesNetworkInstance[]

  The network instances of the node.

Example

Go

import (
    client "github.com/nanoping-labs/nanoping-api-go/v11"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

c, err := client.Connect("127.0.0.1:10432")
defer c.Close()

response, err := c.NetworkInstances.GetNetworkInstances(ctx, &networks.GetNetworkInstancesRequest{
    NodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
})

Go (generated gRPC)

import (
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

conn, err := grpc.NewClient("127.0.0.1:10432", grpc.WithTransportCredentials(insecure.NewCredentials()))
defer conn.Close()
stub := networks.NewNetworkInstancesClient(conn)

response, err := stub.GetNetworkInstances(ctx, &networks.GetNetworkInstancesRequest{
    NodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
})

Stream network instances

Stream changes to the network instances on a node. Nothing is sent when the stream opens; an event is sent each time an instance is created, updated or deleted, and an update is also sent when one of its pipelines changes. The stream ends if the connection to the node is lost.

REST

GET/v1/streams/nodes/{node_id}/network-instances

Server-sent events. A : ready comment is sent when the stream is ready, then each message is a data: line holding the response below. A failure after that is an error event.

Path parameters

• node_idstring

  The ID of the node to stream network instances from.

Example

TypeScript

import { NanopingClient } from "@nanoping/api";

const client = new NanopingClient({ baseUrl: "http://127.0.0.1:10565" });

for await (const response of client.networkInstances.streamNetworkInstances({
  nodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"
})) {
}

Python

from nanoping_api import NanopingClient

client = NanopingClient("http://127.0.0.1:10565")

for response in client.network_instances.stream_network_instances(
    node_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
):
    print(response)

curl

curl -N 'http://127.0.0.1:10565/v1/streams/nodes/<node_id>/network-instances'

Response messages

• createStreamNetworkInstanceCreateEventone of event

  A network instance was created.

• updateStreamNetworkInstanceUpdateEventone of event

  A network instance was updated.

• deleteStreamNetworkInstanceDeleteEventone of event

  A network instance was deleted.

gRPC

rpc streamNetworkInstances(StreamNetworkInstancesRequest) returns (stream StreamNetworkInstanceEvent)

Method /nanopinggrpc.networks.NetworkInstances/streamNetworkInstances

Request

• node_idstring

  The ID of the node to stream network instances from.

Response messages

• createStreamNetworkInstanceCreateEventone of event

  A network instance was created.

• updateStreamNetworkInstanceUpdateEventone of event

  A network instance was updated.

• deleteStreamNetworkInstanceDeleteEventone of event

  A network instance was deleted.

Example

Go

import (
    client "github.com/nanoping-labs/nanoping-api-go/v11"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

c, err := client.Connect("127.0.0.1:10432")
defer c.Close()

stream, err := c.NetworkInstances.StreamNetworkInstances(ctx, &networks.StreamNetworkInstancesRequest{
    NodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
})
for response, err := range client.Receive(stream) {
    if err != nil {
        return err
    }
}

Go (generated gRPC)

import (
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

conn, err := grpc.NewClient("127.0.0.1:10432", grpc.WithTransportCredentials(insecure.NewCredentials()))
defer conn.Close()
stub := networks.NewNetworkInstancesClient(conn)

stream, err := stub.StreamNetworkInstances(ctx, &networks.StreamNetworkInstancesRequest{
    NodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
})
for {
    response, err := stream.Recv()
    if err != nil {
        return err
    }
}

Get network pipelines

Get the network instance pipelines on a node, optionally filtered. A pipeline must match every filter that is set.

REST

GET/v1/nodes/{node_id}/network-pipelines

Path parameters

• node_idstring

  The ID of the node to fetch network instance pipelines from.

Query parameters

• optional_network_idstringone of network_id

  Only return pipelines belonging to this network ID.

• optional_instance_idstringone of instance_id

  Only return pipelines belonging to this network instance ID.

• optional_blueprint_idstringone of blueprint_id

  Only return pipelines generated from this blueprint ID.

Example

TypeScript

import { NanopingClient } from "@nanoping/api";

const client = new NanopingClient({ baseUrl: "http://127.0.0.1:10565" });

const response = await client.networkInstances.getNetworkPipelines({
  nodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
  optionalNetworkId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
  optionalInstanceId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
  optionalBlueprintId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"
});

Python

from nanoping_api import NanopingClient

client = NanopingClient("http://127.0.0.1:10565")

response = client.network_instances.get_network_pipelines(
    node_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    optional_network_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    optional_instance_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    optional_blueprint_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
)

curl

curl 'http://127.0.0.1:10565/v1/nodes/<node_id>/network-pipelines'

Response

• networkPipelinesNetworkPipeline[]

  The network instance pipelines.

gRPC

rpc getNetworkPipelines(GetNetworkPipelinesRequest) returns (GetNetworkPipelinesResponse)

Method /nanopinggrpc.networks.NetworkInstances/getNetworkPipelines

Request

• node_idstring

  The ID of the node to fetch network instance pipelines from.

• optional_network_idstringone of network_id

  Only return pipelines belonging to this network ID.

• optional_instance_idstringone of instance_id

  Only return pipelines belonging to this network instance ID.

• optional_blueprint_idstringone of blueprint_id

  Only return pipelines generated from this blueprint ID.

Response

• network_pipelinesNetworkPipeline[]

  The network instance pipelines.

Example

Go

import (
    client "github.com/nanoping-labs/nanoping-api-go/v11"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

c, err := client.Connect("127.0.0.1:10432")
defer c.Close()

response, err := c.NetworkInstances.GetNetworkPipelines(ctx, &networks.GetNetworkPipelinesRequest{
    NodeId:      "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    NetworkId:   &networks.GetNetworkPipelinesRequest_OptionalNetworkId{OptionalNetworkId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
    InstanceId:  &networks.GetNetworkPipelinesRequest_OptionalInstanceId{OptionalInstanceId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
    BlueprintId: &networks.GetNetworkPipelinesRequest_OptionalBlueprintId{OptionalBlueprintId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
})

Go (generated gRPC)

import (
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

conn, err := grpc.NewClient("127.0.0.1:10432", grpc.WithTransportCredentials(insecure.NewCredentials()))
defer conn.Close()
stub := networks.NewNetworkInstancesClient(conn)

response, err := stub.GetNetworkPipelines(ctx, &networks.GetNetworkPipelinesRequest{
    NodeId:      "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    NetworkId:   &networks.GetNetworkPipelinesRequest_OptionalNetworkId{OptionalNetworkId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
    InstanceId:  &networks.GetNetworkPipelinesRequest_OptionalInstanceId{OptionalInstanceId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
    BlueprintId: &networks.GetNetworkPipelinesRequest_OptionalBlueprintId{OptionalBlueprintId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
})

Stream network pipelines

Stream changes to the network instance pipelines on a node. Nothing is sent when the stream opens; an event is sent each time a pipeline is created, updated or deleted. The stream ends if the connection to the node is lost.

REST

GET/v1/streams/nodes/{node_id}/network-pipelines

Server-sent events. A : ready comment is sent when the stream is ready, then each message is a data: line holding the response below. A failure after that is an error event.

Path parameters

• node_idstring

  The ID of the node to stream network instance pipelines from.

Example

TypeScript

import { NanopingClient } from "@nanoping/api";

const client = new NanopingClient({ baseUrl: "http://127.0.0.1:10565" });

for await (const response of client.networkInstances.streamNetworkPipelines({
  nodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"
})) {
}

Python

from nanoping_api import NanopingClient

client = NanopingClient("http://127.0.0.1:10565")

for response in client.network_instances.stream_network_pipelines(
    node_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
):
    print(response)

curl

curl -N 'http://127.0.0.1:10565/v1/streams/nodes/<node_id>/network-pipelines'

Response messages

• createStreamNetworkPipelineCreateEventone of event

  A pipeline was created.

• updateStreamNetworkPipelineUpdateEventone of event

  A pipeline was updated.

• deleteStreamNetworkPipelineDeleteEventone of event

  A pipeline was deleted.

gRPC

rpc streamNetworkPipelines(StreamNetworkPipelinesRequest) returns (stream StreamNetworkPipelineEvent)

Method /nanopinggrpc.networks.NetworkInstances/streamNetworkPipelines

Request

• node_idstring

  The ID of the node to stream network instance pipelines from.

Response messages

• createStreamNetworkPipelineCreateEventone of event

  A pipeline was created.

• updateStreamNetworkPipelineUpdateEventone of event

  A pipeline was updated.

• deleteStreamNetworkPipelineDeleteEventone of event

  A pipeline was deleted.

Example

Go

import (
    client "github.com/nanoping-labs/nanoping-api-go/v11"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

c, err := client.Connect("127.0.0.1:10432")
defer c.Close()

stream, err := c.NetworkInstances.StreamNetworkPipelines(ctx, &networks.StreamNetworkPipelinesRequest{
    NodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
})
for response, err := range client.Receive(stream) {
    if err != nil {
        return err
    }
}

Go (generated gRPC)

import (
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

conn, err := grpc.NewClient("127.0.0.1:10432", grpc.WithTransportCredentials(insecure.NewCredentials()))
defer conn.Close()
stub := networks.NewNetworkInstancesClient(conn)

stream, err := stub.StreamNetworkPipelines(ctx, &networks.StreamNetworkPipelinesRequest{
    NodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
})
for {
    response, err := stream.Recv()
    if err != nil {
        return err
    }
}

Toggle network pipeline

Enable or disable a network instance pipeline on a node, which starts or stops the pipeline. Each call flips the current state. Fails with a not found error if no matching pipeline exists.

REST

POST/v1/nodes/{node_id}/network-pipelines/toggle

Path parameters

• node_idstring

  The ID of the node the pipeline runs on.

Request body

• optionalPipelineIdstringone of pipeline_id

  The pipeline's pipeline_id.

• optionalInstancePipelineIdstringone of instance_pipeline_id

  The pipeline's id.

Example

TypeScript

import { NanopingClient } from "@nanoping/api";

const client = new NanopingClient({ baseUrl: "http://127.0.0.1:10565" });

await client.networkInstances.toggleNetworkPipeline({
  nodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
  optionalPipelineId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
  optionalInstancePipelineId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"
});

Python

from nanoping_api import NanopingClient

client = NanopingClient("http://127.0.0.1:10565")

client.network_instances.toggle_network_pipeline(
    node_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    optional_pipeline_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    optional_instance_pipeline_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
)

curl

curl -X POST 'http://127.0.0.1:10565/v1/nodes/<node_id>/network-pipelines/toggle' \
  -H 'Content-Type: application/json' \
  -d '{
    "optionalPipelineId": "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    "optionalInstancePipelineId": "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"
  }'

Response

No fields.

gRPC

rpc toggleNetworkPipeline(ToggleNetworkPipelineRequest) returns (ToggleNetworkPipelineResponse)

Method /nanopinggrpc.networks.NetworkInstances/toggleNetworkPipeline

Request

• node_idstring

  The ID of the node the pipeline runs on.

• optional_pipeline_idstringone of pipeline_id

  The pipeline's pipeline_id.

• optional_instance_pipeline_idstringone of instance_pipeline_id

  The pipeline's id.

Response

No fields.

Example

Go

import (
    client "github.com/nanoping-labs/nanoping-api-go/v11"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

c, err := client.Connect("127.0.0.1:10432")
defer c.Close()

_, err = c.NetworkInstances.ToggleNetworkPipeline(ctx, &networks.ToggleNetworkPipelineRequest{
    NodeId:             "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    PipelineId:         &networks.ToggleNetworkPipelineRequest_OptionalPipelineId{OptionalPipelineId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
    InstancePipelineId: &networks.ToggleNetworkPipelineRequest_OptionalInstancePipelineId{OptionalInstancePipelineId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
})

Go (generated gRPC)

import (
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

conn, err := grpc.NewClient("127.0.0.1:10432", grpc.WithTransportCredentials(insecure.NewCredentials()))
defer conn.Close()
stub := networks.NewNetworkInstancesClient(conn)

_, err = stub.ToggleNetworkPipeline(ctx, &networks.ToggleNetworkPipelineRequest{
    NodeId:             "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    PipelineId:         &networks.ToggleNetworkPipelineRequest_OptionalPipelineId{OptionalPipelineId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
    InstancePipelineId: &networks.ToggleNetworkPipelineRequest_OptionalInstancePipelineId{OptionalInstancePipelineId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f"},
})

Open log stream

Stream the log messages of a network instance on a node. The requested number of past lines is sent first, then new messages as they are logged, until the connection to the node is lost.

REST

GET/v1/streams/nodes/{node_id}/network-instances/{network_instance_id}/logs

Server-sent events. A : ready comment is sent when the stream is ready, then each message is a data: line holding the response below. A failure after that is an error event.

Path parameters

• node_idstring

  The ID of the node the network instance runs on.

• network_instance_idstring

  The ID of the network instance whose log to stream.

Query parameters

• optionsOptions

  Log stream options, such as how many past lines to send first.

Example

TypeScript

import { NanopingClient } from "@nanoping/api";

const client = new NanopingClient({ baseUrl: "http://127.0.0.1:10565" });

for await (const response of client.networkInstances.openLogStream({
  nodeId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
  networkInstanceId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
  options: {
    lines: "0"
  }
})) {
}

Python

from nanoping_api import NanopingClient, Options

client = NanopingClient("http://127.0.0.1:10565")

for response in client.network_instances.open_log_stream(
    node_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    network_instance_id="3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    options=Options(lines=0),
):
    print(response)

curl

curl -N 'http://127.0.0.1:10565/v1/streams/nodes/<node_id>/network-instances/<network_instance_id>/logs'

Response messages

• messagesMessage[]

  The log messages.

gRPC

rpc openLogStream(OpenNetworkInstanceLogStreamRequest) returns (stream NetworkInstanceLogStreamMessages)

Method /nanopinggrpc.networks.NetworkInstances/openLogStream

Request

• node_idstring

  The ID of the node the network instance runs on.

• network_instance_idstring

  The ID of the network instance whose log to stream.

• optionsOptions

  Log stream options, such as how many past lines to send first.

Response messages

• messagesMessage[]

  The log messages.

Example

Go

import (
    client "github.com/nanoping-labs/nanoping-api-go/v11"
    "github.com/nanoping-labs/nanoping-api-go/v11/logging"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

c, err := client.Connect("127.0.0.1:10432")
defer c.Close()

stream, err := c.NetworkInstances.OpenLogStream(ctx, &networks.OpenNetworkInstanceLogStreamRequest{
    NodeId:            "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    NetworkInstanceId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    Options: &logging.Options{
        OptionalLines: &logging.Options_Lines{Lines: 0},
    },
})
for response, err := range client.Receive(stream) {
    if err != nil {
        return err
    }
}

Go (generated gRPC)

import (
    "google.golang.org/grpc"
    "google.golang.org/grpc/credentials/insecure"
    "github.com/nanoping-labs/nanoping-api-go/v11/logging"
    "github.com/nanoping-labs/nanoping-api-go/v11/networks"
)

conn, err := grpc.NewClient("127.0.0.1:10432", grpc.WithTransportCredentials(insecure.NewCredentials()))
defer conn.Close()
stub := networks.NewNetworkInstancesClient(conn)

stream, err := stub.OpenLogStream(ctx, &networks.OpenNetworkInstanceLogStreamRequest{
    NodeId:            "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    NetworkInstanceId: "3f2b1c9e-8d4a-4f6b-9c2e-1a7d5e8b0c4f",
    Options: &logging.Options{
        OptionalLines: &logging.Options_Lines{Lines: 0},
    },
})
for {
    response, err := stream.Recv()
    if err != nil {
        return err
    }
}