IPAddress v1beta1

IPAddress represents a single IP of a single IP Family.

apiVersion: networking.k8s.io/v1beta1

import "k8s.io/api/networking/v1beta1"

IPAddress

IPAddress represents a single IP of a single IP Family. The object is designed to be used by APIs that operate on IP addresses. The object is used by the Service core API for allocation of IP addresses. An IP address can be represented in different formats, to guarantee the uniqueness of the IP, the name of the object is the IP address in canonical format, four decimal digits separated by dots suppressing leading zeros for IPv4 and the representation defined by RFC 5952 for IPv6. Valid: 192.168.1.5 or 2001:db8::1 or 2001:db8:aaaa:bbbb:cccc:dddd:eeee:1 Invalid: 10.01.2.3 or 2001:db8:0:0:0::1

• apiVersion: networking.k8s.io/v1beta1

• kind: IPAddress

• metadata (ObjectMeta)

  Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• spec (IPAddressSpec)

  spec is the desired state of the IPAddress. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

IPAddressSpec

IPAddressSpec describe the attributes in an IP Address.

• parentRef (ParentReference), required

  ParentRef references the resource that an IPAddress is attached to. An IPAddress must reference a parent object.

  ParentReference describes a reference to a parent object.

  • parentRef.name (string), required

    Name is the name of the object being referenced.

  • parentRef.resource (string), required

    Resource is the resource of the object being referenced.

  • parentRef.group (string)

    Group is the group of the object being referenced.

  • parentRef.namespace (string)

    Namespace is the namespace of the object being referenced.

IPAddressList

IPAddressList contains a list of IPAddress.

• apiVersion: networking.k8s.io/v1beta1

• kind: IPAddressList

• metadata (ListMeta)

  Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

• items ([]IPAddress), required

  items is the list of IPAddresses.

Operations

get read the specified IPAddress

HTTP Request

GET /apis/networking.k8s.io/v1beta1/ipaddresses/{name}

Parameters

• name (in path): string, required

  name of the IPAddress

• pretty (in query): string

  pretty

Response

200 (IPAddress): OK

401: Unauthorized

list list or watch objects of kind IPAddress

HTTP Request

GET /apis/networking.k8s.io/v1beta1/ipaddresses

Parameters

• allowWatchBookmarks (in query): boolean

  allowWatchBookmarks

• continue (in query): string

  continue

• fieldSelector (in query): string

  fieldSelector

• labelSelector (in query): string

  labelSelector

• limit (in query): integer

  limit

• pretty (in query): string

  pretty

• resourceVersion (in query): string

  resourceVersion

• resourceVersionMatch (in query): string

  resourceVersionMatch

• sendInitialEvents (in query): boolean

  sendInitialEvents

• timeoutSeconds (in query): integer

  timeoutSeconds

• watch (in query): boolean

  watch

Response

200 (IPAddressList): OK

401: Unauthorized

create create an IPAddress

HTTP Request

POST /apis/networking.k8s.io/v1beta1/ipaddresses

Parameters

• body: IPAddress, required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

  fieldValidation

• pretty (in query): string

  pretty

Response

200 (IPAddress): OK

201 (IPAddress): Created

202 (IPAddress): Accepted

401: Unauthorized

update replace the specified IPAddress

HTTP Request

PUT /apis/networking.k8s.io/v1beta1/ipaddresses/{name}

Parameters

• name (in path): string, required

  name of the IPAddress

• body: IPAddress, required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

  fieldValidation

• pretty (in query): string

  pretty

Response

200 (IPAddress): OK

201 (IPAddress): Created

401: Unauthorized

patch partially update the specified IPAddress

HTTP Request

PATCH /apis/networking.k8s.io/v1beta1/ipaddresses/{name}

Parameters

• name (in path): string, required

  name of the IPAddress

• body: Patch, required

• dryRun (in query): string

  dryRun

• fieldManager (in query): string

  fieldManager

• fieldValidation (in query): string

  fieldValidation

• force (in query): boolean

  force

• pretty (in query): string

  pretty

Response

200 (IPAddress): OK

201 (IPAddress): Created

401: Unauthorized

delete delete an IPAddress

HTTP Request

DELETE /apis/networking.k8s.io/v1beta1/ipaddresses/{name}

Parameters

• name (in path): string, required

  name of the IPAddress

• body: DeleteOptions

• dryRun (in query): string

  dryRun

• gracePeriodSeconds (in query): integer

  gracePeriodSeconds

• pretty (in query): string

  pretty

• propagationPolicy (in query): string

  propagationPolicy

Response

200 (Status): OK

202 (Status): Accepted

401: Unauthorized

deletecollection delete collection of IPAddress

HTTP Request

DELETE /apis/networking.k8s.io/v1beta1/ipaddresses

Parameters

• body: DeleteOptions

• continue (in query): string

  continue

• dryRun (in query): string

  dryRun

• fieldSelector (in query): string

  fieldSelector

• gracePeriodSeconds (in query): integer

  gracePeriodSeconds

• labelSelector (in query): string

  labelSelector

• limit (in query): integer

  limit

• pretty (in query): string

  pretty

• propagationPolicy (in query): string

  propagationPolicy

• resourceVersion (in query): string

  resourceVersion

• resourceVersionMatch (in query): string

  resourceVersionMatch

• sendInitialEvents (in query): boolean

  sendInitialEvents

• timeoutSeconds (in query): integer

  timeoutSeconds

Response

200 (Status): OK

401: Unauthorized