Soon, all Red Hat OpenShift documentation will only be available on docs.redhat.com, the official location of all Red Hat product documentation. Get familiar with the updated experience today!
  1. Documentation
    2. history bug_report picture_as_pdf
×

IPAddressClaim [ipam.cluster.x-k8s.io/v1beta1]

Specification

Property Type Description

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

IPAddressClaimSpec is the desired state of an IPAddressClaim.

status

object

IPAddressClaimStatus is the observed status of a IPAddressClaim.

.spec

Description

IPAddressClaimSpec is the desired state of an IPAddressClaim.

Type

object

Required

  • poolRef

Property Type Description

poolRef

object

PoolRef is a reference to the pool from which an IP address should be created.

.spec.poolRef

Description

PoolRef is a reference to the pool from which an IP address should be created.

Type

object

Required

  • kind

  • name

Property Type Description

apiGroup

string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

kind

string

Kind is the type of resource being referenced

name

string

Name is the name of resource being referenced

.status

Description

IPAddressClaimStatus is the observed status of a IPAddressClaim.

Type

object

Property Type Description

addressRef

object

AddressRef is a reference to the address that was created for this claim.

conditions

array

Conditions summarises the current state of the IPAddressClaim

conditions[]

object

Condition defines an observation of a Cluster API resource operational state.

.status.addressRef

Description

AddressRef is a reference to the address that was created for this claim.

Type

object

Property Type Description

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

.status.conditions

Description

Conditions summarises the current state of the IPAddressClaim

Type

array

.status.conditions[]

Description

Condition defines an observation of a Cluster API resource operational state.

Type

object

Required

  • lastTransitionTime

  • status

  • type

Property Type Description

lastTransitionTime

string

Last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.

message

string

A human readable message indicating details about the transition. This field may be empty.

reason

string

The reason for the condition’s last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may not be empty.

severity

string

Severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

status

string

Status of the condition, one of True, False, Unknown.

type

string

Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

API endpoints

The following API endpoints are available:

  • /apis/ipam.cluster.x-k8s.io/v1beta1/ipaddressclaims

    • GET: list objects of kind IPAddressClaim

  • /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims

    • DELETE: delete collection of IPAddressClaim

    • GET: list objects of kind IPAddressClaim

    • POST: create an IPAddressClaim

  • /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}

    • DELETE: delete an IPAddressClaim

    • GET: read the specified IPAddressClaim

    • PATCH: partially update the specified IPAddressClaim

    • PUT: replace the specified IPAddressClaim

  • /apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}/status

    • GET: read status of the specified IPAddressClaim

    • PATCH: partially update status of the specified IPAddressClaim

    • PUT: replace status of the specified IPAddressClaim

/apis/ipam.cluster.x-k8s.io/v1beta1/ipaddressclaims

HTTP method

GET

Description

list objects of kind IPAddressClaim

Table 1. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaimList schema

401 - Unauthorized

Empty

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims

HTTP method

DELETE

Description

delete collection of IPAddressClaim

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

list objects of kind IPAddressClaim

Table 3. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaimList schema

401 - Unauthorized

Empty
HTTP method

POST

Description

create an IPAddressClaim

Table 4. Query parameters
Parameter Type Description

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.
Table 5. Body parameters
Parameter Type Description

body

IPAddressClaim schema
Table 6. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaim schema

201 - Created

IPAddressClaim schema

202 - Accepted

IPAddressClaim schema

401 - Unauthorized

Empty

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}

Table 7. Global path parameters
Parameter Type Description

name

string

name of the IPAddressClaim
HTTP method

DELETE

Description

delete an IPAddressClaim

Table 8. Query parameters
Parameter Type Description

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
Table 9. HTTP responses
HTTP code Reponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty
HTTP method

GET

Description

read the specified IPAddressClaim

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaim schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update the specified IPAddressClaim

Table 11. Query parameters
Parameter Type Description

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.
Table 12. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaim schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace the specified IPAddressClaim

Table 13. Query parameters
Parameter Type Description

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.
Table 14. Body parameters
Parameter Type Description

body

IPAddressClaim schema
Table 15. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaim schema

201 - Created

IPAddressClaim schema

401 - Unauthorized

Empty

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddressclaims/{name}/status

Table 16. Global path parameters
Parameter Type Description

name

string

name of the IPAddressClaim
HTTP method

GET

Description

read status of the specified IPAddressClaim

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaim schema

401 - Unauthorized

Empty
HTTP method

PATCH

Description

partially update status of the specified IPAddressClaim

Table 18. Query parameters
Parameter Type Description

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.
Table 19. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaim schema

401 - Unauthorized

Empty
HTTP method

PUT

Description

replace status of the specified IPAddressClaim

Table 20. Query parameters
Parameter Type Description

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.
Table 21. Body parameters
Parameter Type Description

body

IPAddressClaim schema
Table 22. HTTP responses
HTTP code Reponse body

200 - OK

IPAddressClaim schema

201 - Created

IPAddressClaim schema

401 - Unauthorized

Empty