Red Hat Summit Red Hat SummitApoyoConsolaDesarrolladoresIniciar una pruebaContacto

Este contenido no está disponible en el idioma seleccionado.

Chapter 20. IPAddress [networking.k8s.io/v1]

Description
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
Type
object

20.1. Specification
Copiar enlace

Expand
PropertyTypeDescription

apiVersion

string

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

string

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

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

spec

object

IPAddressSpec describe the attributes in an IP Address.

20.1.1. .spec
Copiar enlace

Description
IPAddressSpec describe the attributes in an IP Address.
Type
object
Required
  • parentRef
Expand
PropertyTypeDescription

parentRef

object

ParentReference describes a reference to a parent object.

20.1.2. .spec.parentRef
Copiar enlace

Description
ParentReference describes a reference to a parent object.
Type
object
Required
  • resource
  • name
Expand
PropertyTypeDescription

group

string

Group is the group of the object being referenced.

name

string

Name is the name of the object being referenced.

namespace

string

Namespace is the namespace of the object being referenced.

resource

string

Resource is the resource of the object being referenced.

20.2. API endpoints
Copiar enlace

The following API endpoints are available:

  • /apis/networking.k8s.io/v1/ipaddresses

    • DELETE: delete collection of IPAddress
    • GET: list or watch objects of kind IPAddress
    • POST: create an IPAddress

  • /apis/networking.k8s.io/v1/watch/ipaddresses

    • GET: watch individual changes to a list of IPAddress. deprecated: use the 'watch' parameter with a list operation instead.

  • /apis/networking.k8s.io/v1/ipaddresses/{name}

    • DELETE: delete an IPAddress
    • GET: read the specified IPAddress
    • PATCH: partially update the specified IPAddress
    • PUT: replace the specified IPAddress

  • /apis/networking.k8s.io/v1/watch/ipaddresses/{name}

    • GET: watch changes to an object of kind IPAddress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.

20.2.1. /apis/networking.k8s.io/v1/ipaddresses
Copiar enlace

HTTP method
DELETE
Description
delete collection of IPAddress
Expand
Table 20.1. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 20.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind IPAddress
Expand
Table 20.3. HTTP responses
HTTP codeReponse body

200 - OK

IPAddressList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create an IPAddress
Expand
Table 20.4. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 20.5. Body parameters
ParameterTypeDescription

body

IPAddress schema

 
Expand
Table 20.6. HTTP responses
HTTP codeReponse body

200 - OK

IPAddress schema

201 - Created

IPAddress schema

202 - Accepted

IPAddress schema

401 - Unauthorized

Empty

20.2.2. /apis/networking.k8s.io/v1/watch/ipaddresses
Copiar enlace

HTTP method
GET
Description
watch individual changes to a list of IPAddress. deprecated: use the 'watch' parameter with a list operation instead.
Expand
Table 20.7. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

20.2.3. /apis/networking.k8s.io/v1/ipaddresses/{name}
Copiar enlace

Expand
Table 20.8. Global path parameters
ParameterTypeDescription

name

string

name of the IPAddress

HTTP method
DELETE
Description
delete an IPAddress
Expand
Table 20.9. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

Expand
Table 20.10. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified IPAddress
Expand
Table 20.11. HTTP responses
HTTP codeReponse body

200 - OK

IPAddress schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified IPAddress
Expand
Table 20.12. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 20.13. HTTP responses
HTTP codeReponse body

200 - OK

IPAddress schema

201 - Created

IPAddress schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified IPAddress
Expand
Table 20.14. Query parameters
ParameterTypeDescription

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Expand
Table 20.15. Body parameters
ParameterTypeDescription

body

IPAddress schema

 
Expand
Table 20.16. HTTP responses
HTTP codeReponse body

200 - OK

IPAddress schema

201 - Created

IPAddress schema

401 - Unauthorized

Empty

20.2.4. /apis/networking.k8s.io/v1/watch/ipaddresses/{name}
Copiar enlace

Expand
Table 20.17. Global path parameters
ParameterTypeDescription

name

string

name of the IPAddress

HTTP method
GET
Description
watch changes to an object of kind IPAddress. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
Expand
Table 20.18. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

Volver arriba
Red Hat logoGithubredditYoutubeTwitter

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Ayudamos a los usuarios de Red Hat a innovar y alcanzar sus objetivos con nuestros productos y servicios con contenido en el que pueden confiar. Explore nuestras recientes actualizaciones.

Hacer que el código abierto sea más inclusivo

Red Hat se compromete a reemplazar el lenguaje problemático en nuestro código, documentación y propiedades web. Para más detalles, consulte el Blog de Red Hat.

Acerca de Red Hat

Ofrecemos soluciones reforzadas que facilitan a las empresas trabajar en plataformas y entornos, desde el centro de datos central hasta el perímetro de la red.

Theme

© 2025 Red Hat