Get Logical Port

GET

/network/v1/workspaces/{workspace}/engines/qibdo/logical-ports/{id}

curl --request GET \
  --url https://example.com/network/v1/workspaces/example/engines/qibdo/logical-ports/example

Returns a network port by unique ID.

Parameters

Path Parameters

workspace

required

string

id

required

string

Responses

200

OK

Media type application/json

object

id

Unique identifier for this port.

stringOutput only

subnet_id

required

The subnet this port draws its address from.

string

vm_id

required

The virtual machine this port is attached to.

string

workspace_id

The workspace that owns this port.

stringOutput only

requested_ipv4

An optional requested static IPv4 address. When omitted, the address is assigned automatically from the subnet’s range. The assigned address is reported in ipv4_address.

string

requested_ipv6

An optional requested static IPv6 address. When omitted, the address is assigned automatically from the subnet’s range. The assigned address is reported in ipv6_address.

string

ipv4_address

The assigned IPv4 address.

stringOutput only

ipv6_address

The assigned IPv6 address.

stringOutput only

mac_address

The assigned hardware (MAC) address of the interface.

stringOutput only

state

Current lifecycle state of the port (pending, ready, failed).

string format: enum Output only

Allowed values: LOGICAL_PORT_STATE_UNSPECIFIED LOGICAL_PORT_STATE_PENDING LOGICAL_PORT_STATE_READY LOGICAL_PORT_STATE_FAILED

firewall_policy_id

An optional firewall policy applied to this interface. When omitted, the default deny-inbound / allow-egress policy is enforced.

string

provider_resource_id

The provider-assigned logical-switch-port identifier. Populated once the port is provisioned.

stringOutput only

create_time

When this port was created.

string format: date-time Output only

update_time

When this port was last updated.

string format: date-time Output only

network_name

The network this port attaches to, as the interface must name it. Populated once the port is provisioned, and fully qualified, so a machine attaches to it correctly no matter where the machine itself runs. Treat the value as an opaque handle: it is resolved by the network that owns the subnet, and its form is not part of this contract.

stringOutput only

Example

{
  "state": "LOGICAL_PORT_STATE_UNSPECIFIED"
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}