Chapter 18. OverlappingRangeIPReservation [whereabouts.cni.cncf.io/v1alpha1]
- Description
- OverlappingRangeIPReservation is the Schema for the OverlappingRangeIPReservations API
- Type
-
object - Required
-
spec
-
18.1. Specification
| Property | Type | Description |
|---|---|---|
|
|
| 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 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 |
|
| Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| OverlappingRangeIPReservationSpec defines the desired state of OverlappingRangeIPReservation |
18.1.1. .spec
- Description
- OverlappingRangeIPReservationSpec defines the desired state of OverlappingRangeIPReservation
- Type
-
object - Required
-
podref
-
| Property | Type | Description |
|---|---|---|
|
|
| |
|
|
| |
|
|
|
18.2. API endpoints
The following API endpoints are available:
/apis/whereabouts.cni.cncf.io/v1alpha1/overlappingrangeipreservations-
GET: list objects of kind OverlappingRangeIPReservation
-
/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/overlappingrangeipreservations-
DELETE: delete collection of OverlappingRangeIPReservation -
GET: list objects of kind OverlappingRangeIPReservation -
POST: create an OverlappingRangeIPReservation
-
/apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/overlappingrangeipreservations/{name}-
DELETE: delete an OverlappingRangeIPReservation -
GET: read the specified OverlappingRangeIPReservation -
PATCH: partially update the specified OverlappingRangeIPReservation -
PUT: replace the specified OverlappingRangeIPReservation
-
18.2.1. /apis/whereabouts.cni.cncf.io/v1alpha1/overlappingrangeipreservations
- HTTP method
-
GET - Description
- list objects of kind OverlappingRangeIPReservation
| HTTP code | Reponse body |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | Empty |
18.2.2. /apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/overlappingrangeipreservations
- HTTP method
-
DELETE - Description
- delete collection of OverlappingRangeIPReservation
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- list objects of kind OverlappingRangeIPReservation
| HTTP code | Reponse body |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | Empty |
- HTTP method
-
POST - Description
- create an OverlappingRangeIPReservation
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | Empty |
18.2.3. /apis/whereabouts.cni.cncf.io/v1alpha1/namespaces/{namespace}/overlappingrangeipreservations/{name}
| Parameter | Type | Description |
|---|---|---|
|
|
| name of the OverlappingRangeIPReservation |
- HTTP method
-
DELETE - Description
- delete an OverlappingRangeIPReservation
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 |
| HTTP code | Reponse body |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | Empty |
- HTTP method
-
GET - Description
- read the specified OverlappingRangeIPReservation
| HTTP code | Reponse body |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | Empty |
- HTTP method
-
PATCH - Description
- partially update the specified OverlappingRangeIPReservation
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| HTTP code | Reponse body |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | Empty |
- HTTP method
-
PUT - Description
- replace the specified OverlappingRangeIPReservation
| Parameter | Type | Description |
|---|---|---|
|
|
| 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 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. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | Empty |
