IPAddress v1alpha1

    apiVersion: networking.k8s.io/v1alpha1

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

    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

    IPAddressSpec describe the attributes in an IP Address.

    • parentRef (ParentReference)

      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.group (string)

        Group is the group of the object being referenced.

      • parentRef.name (string)

        Name is the name of the object being referenced.

      • parentRef.namespace (string)

        Namespace is the namespace of the object being referenced.

      • parentRef.resource (string)

        Resource is the resource of the object being referenced.

      • parentRef.uid (string)

        UID is the uid of the object being referenced.

    IPAddressList contains a list of IPAddress.

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the IPAddress

    • pretty (in query): string

      pretty

    Response

    200 (IPAddress): OK

    401: Unauthorized

    list or watch objects of kind IPAddress

    HTTP Request

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

    Parameters

    • allowWatchBookmarks (in query): boolean

      allowWatchBookmarks

    • continue (in query): string

    • fieldSelector (in query): string

      fieldSelector

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    • sendInitialEvents (in query): boolean

    • timeoutSeconds (in query): integer

      timeoutSeconds

    • watch (in query): boolean

    Response

    200 (): OK

    401: Unauthorized

    HTTP Request

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

    Parameters

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation (in query): string

      fieldValidation

    Response

    200 (IPAddress): OK

    201 (): Created

    202 (IPAddress): Accepted

    401: Unauthorized

    update replace the specified IPAddress

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the IPAddress

    • body: IPAddress, required

    • dryRun (in query): string

    • fieldManager (in query): string

      fieldManager

    • fieldValidation (in query): string

    • pretty (in query): string

      pretty

    Response

    200 (IPAddress): OK

    201 (): Created

    401: Unauthorized

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the IPAddress

    • body: , required

    • dryRun (in query): string

      dryRun

    • fieldManager (in query): string

    • fieldValidation

    • force (in query): boolean

    • pretty (in query): string

      pretty

    Response

    200 (IPAddress): OK

    201 (): Created

    401: Unauthorized

    delete delete an IPAddress

    HTTP Request

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

    Parameters

    • name (in path): string, required

      name of the IPAddress

    • body:

    • dryRun (in query): string

      dryRun

    • gracePeriodSeconds (in query): integer

    • pretty (in query): string

      pretty

    • propagationPolicy (in query): string

    Response

    200 (): OK

    202 (Status): Accepted

    401: Unauthorized

    HTTP Request

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

    Parameters

    • body: DeleteOptions

    • continue (in query): string

    • dryRun (in query): string

      dryRun

    • fieldSelector (in query): string

    • gracePeriodSeconds (in query): integer

      gracePeriodSeconds

    • labelSelector (in query): string

    • limit (in query): integer

      limit

    • pretty (in query): string

    • propagationPolicy (in query): string

      propagationPolicy

    • resourceVersion (in query): string

    • resourceVersionMatch (in query): string

      resourceVersionMatch

    • sendInitialEvents (in query): boolean

    Response

    401: Unauthorized