H2h2o
PortService

Creates a new Port for a SandboxEngine.

Authorization: Only the creator of the parent SandboxEngine is allowed to call this method.

post/v1/{parent}/ports

Request

Path parameters

parentstring required

Required. SandboxEngine resource name.

Query parameters

portIdstring required

Required. The port number to expose (1024-65535). This will become the port ID in the resource name.

Request body

namestring

Identifier. Resource name of the Port.

displayNamestring

Optional. Human-readable display name for this port.

publicboolean

Optional. Whether this port should be publicly accessible. If false, the port is only accessible within the cluster.

internalUrlstring

Output only. URL for accessing this port from within the Kubernetes cluster.

publicUrlstring

Output only. URL for accessing this port from outside the cluster. Only set when public is true.

createTimestring date-time

Output only. Time when this port was created.

creatorstring

Output only. Name of an entity that created this port.

creatorDisplayNamestring

Output only. Display name of the entity that created this port.

updateTimestring date-time nullable

Output only. Time when this port was last updated.

updaterstring

Output only. Name of an entity that last updated this port.

updaterDisplayNamestring

Output only. Display name of the entity that last updated this port.

state'STATE_UNSPECIFIED' | 'STATE_PENDING' | 'STATE_READY' | 'STATE_FAILED' | 'STATE_DELETING'

The state of the port.

  • STATE_UNSPECIFIED: The state is not specified.
  • STATE_PENDING: The port infrastructure is being created.
  • STATE_READY: The port is ready and accessible.
  • STATE_FAILED: The port creation has failed.
  • STATE_DELETING: The port is being deleted.
failureReasonstring

Output only. Failure reason during the port creation. Only set when state is STATE_FAILED.

Response

A successful response.

Changes

No recorded changes to this operation across all 1 revision of this API.