IPAMClaim [k8s.cni.cncf.io/v1alpha1] - Network APIs | API reference

Specification
API endpoints

Description: IPAMClaim is the Schema for the IPAMClaim API
Type: object

Specification

Property Type Description

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`
`status`	`object`	IPAMClaimStatus contains the observed status of the IPAMClaim.

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

status

object

IPAMClaimStatus contains the observed status of the IPAMClaim.

.spec

Description

Type

object

Required

interface
network

Property Type Description

Property	Type	Description
`interface`	`string`	The pod interface name for which this allocation was created
`network`	`string`	The network name for which this persistent allocation was created

interface

string

The pod interface name for which this allocation was created

network

string

The network name for which this persistent allocation was created

.status

Description

IPAMClaimStatus contains the observed status of the IPAMClaim.

Type

object

Required

ips

Property Type Description

Property	Type	Description
`conditions`	`array`	Conditions contains details for one aspect of the current state of this API Resource
`conditions[]`	`object`	Condition contains details for one aspect of the current state of this API Resource.
`ips`	`array (string)`	The list of IP addresses (v4, v6) that were allocated for the pod interface
`ownerpod`	`object`	The name of the pod holding the IPAMClaim

conditions

array

Conditions contains details for one aspect of the current state of this API Resource

conditions[]

object

Condition contains details for one aspect of the current state of this API Resource.

ips

array (string)

The list of IP addresses (v4, v6) that were allocated for the pod interface

ownerpod

object

The name of the pod holding the IPAMClaim

.status.conditions

Description: Conditions contains details for one aspect of the current state of this API Resource
Type: array

.status.conditions[]

Description

Condition contains details for one aspect of the current state of this API Resource.

Type

object

Required

lastTransitionTime
message
reason
status
type

Property Type Description

Property	Type	Description
`lastTransitionTime`	`string`	lastTransitionTime is the 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`	message is a human readable message indicating details about the transition. This may be an empty string.
`observedGeneration`	`integer`	observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.
`reason`	`string`	reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.
`status`	`string`	status of the condition, one of True, False, Unknown.
`type`	`string`	type of condition in CamelCase or in foo.example.com/CamelCase.

lastTransitionTime

string

lastTransitionTime is the 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

message is a human readable message indicating details about the transition. This may be an empty string.

observedGeneration

integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

reason

string

reason contains a programmatic identifier indicating the reason for the condition’s last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

status

string

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

type

string

type of condition in CamelCase or in foo.example.com/CamelCase.

.status.ownerpod

Description: The name of the pod holding the IPAMClaim
Type: object

Property Type Description

Property	Type	Description
`name`	`string`

name

string

API endpoints

The following API endpoints are available:

/apis/k8s.cni.cncf.io/v1alpha1/ipamclaims
- GET: list objects of kind IPAMClaim
/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims
- DELETE: delete collection of IPAMClaim
- GET: list objects of kind IPAMClaim
- POST: create an IPAMClaim
/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims/{name}
- DELETE: delete an IPAMClaim
- GET: read the specified IPAMClaim
- PATCH: partially update the specified IPAMClaim
- PUT: replace the specified IPAMClaim
/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims/{name}/status
- GET: read status of the specified IPAMClaim
- PATCH: partially update status of the specified IPAMClaim
- PUT: replace status of the specified IPAMClaim

/apis/k8s.cni.cncf.io/v1alpha1/ipamclaims

HTTP method: GET
Description: list objects of kind IPAMClaim

Table 1. HTTP responses
HTTP code	Reponse body
200 - OK	`IPAMClaimList` schema
401 - Unauthorized	Empty

/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims

HTTP method: DELETE
Description: delete collection of IPAMClaim

Table 2. HTTP responses
HTTP code	Reponse body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind IPAMClaim

Table 3. HTTP responses
HTTP code	Reponse body
200 - OK	`IPAMClaimList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create an IPAMClaim

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`	`IPAMClaim` schema

Table 6. HTTP responses
HTTP code	Reponse body
200 - OK	`IPAMClaim` schema
201 - Created	`IPAMClaim` schema
202 - Accepted	`IPAMClaim` schema
401 - Unauthorized	Empty

/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims/{name}

Table 7. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the IPAMClaim

HTTP method: DELETE
Description: delete an IPAMClaim

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 IPAMClaim

Table 10. HTTP responses
HTTP code	Reponse body
200 - OK	`IPAMClaim` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified IPAMClaim

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	`IPAMClaim` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified IPAMClaim

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`	`IPAMClaim` schema

Table 15. HTTP responses
HTTP code	Reponse body
200 - OK	`IPAMClaim` schema
201 - Created	`IPAMClaim` schema
401 - Unauthorized	Empty

/apis/k8s.cni.cncf.io/v1alpha1/namespaces/{namespace}/ipamclaims/{name}/status

Table 16. Global path parameters
Parameter	Type	Description
`name`	`string`	name of the IPAMClaim

HTTP method: GET
Description: read status of the specified IPAMClaim

Table 17. HTTP responses
HTTP code	Reponse body
200 - OK	`IPAMClaim` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update status of the specified IPAMClaim

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	`IPAMClaim` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace status of the specified IPAMClaim

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`	`IPAMClaim` schema

Table 22. HTTP responses
HTTP code	Reponse body
200 - OK	`IPAMClaim` schema
201 - Created	`IPAMClaim` schema
401 - Unauthorized	Empty