RangeAllocation [security.openshift.io/v1]
- Description
RangeAllocation is used so we can easily expose a RangeAllocation typed for security group
Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.
- Type
`object`- Required
rangedata
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 |
data | string | data is a byte array representing the serialized state of a range allocation. It is a bitmap with each bit set to one to represent a range is taken. |
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 | metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
range | string | range is a string representing a unique label for a range of uids, "1000000000-2000000000/10000". |
API endpoints
The following API endpoints are available:
/apis/security.openshift.io/v1/rangeallocationsDELETE: delete collection of RangeAllocationGET: list or watch objects of kind RangeAllocationPOST: create a RangeAllocation
/apis/security.openshift.io/v1/watch/rangeallocationsGET: watch individual changes to a list of RangeAllocation. deprecated: use the 'watch' parameter with a list operation instead.
/apis/security.openshift.io/v1/rangeallocations/{name}DELETE: delete a RangeAllocationGET: read the specified RangeAllocationPATCH: partially update the specified RangeAllocationPUT: replace the specified RangeAllocation
/apis/security.openshift.io/v1/watch/rangeallocations/{name}GET: watch changes to an object of kind RangeAllocation. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
/apis/security.openshift.io/v1/rangeallocations
- HTTP method
`DELETE`- Description
delete collection of RangeAllocation
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 |
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | Status_v2 schema |
| 401 - Unauthorized | Empty |
- HTTP method
`GET`- Description
list or watch objects of kind RangeAllocation
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | RangeAllocationList schema |
| 401 - Unauthorized | Empty |
- HTTP method
`POST`- Description
create a RangeAllocation
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. |
Body parameters
| Parameter | Type | Description |
|---|---|---|
body | RangeAllocation schema |
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | RangeAllocation schema |
| 201 - Created | RangeAllocation schema |
| 202 - Accepted | RangeAllocation schema |
| 401 - Unauthorized | Empty |
/apis/security.openshift.io/v1/watch/rangeallocations
- HTTP method
`GET`- Description
watch individual changes to a list of RangeAllocation. deprecated: use the 'watch' parameter with a list operation instead.
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | WatchEvent schema |
| 401 - Unauthorized | Empty |
/apis/security.openshift.io/v1/rangeallocations/{name}
Global path parameters
| Parameter | Type | Description |
|---|---|---|
name | string | name of the RangeAllocation |
- HTTP method
`DELETE`- Description
delete a RangeAllocation
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 |
HTTP responses
- HTTP method
`GET`- Description
read the specified RangeAllocation
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | RangeAllocation schema |
| 401 - Unauthorized | Empty |
- HTTP method
`PATCH`- Description
partially update the specified RangeAllocation
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. |
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | RangeAllocation schema |
| 201 - Created | RangeAllocation schema |
| 401 - Unauthorized | Empty |
- HTTP method
`PUT`- Description
replace the specified RangeAllocation
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. |
Body parameters
| Parameter | Type | Description |
|---|---|---|
body | RangeAllocation schema |
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | RangeAllocation schema |
| 201 - Created | RangeAllocation schema |
| 401 - Unauthorized | Empty |
/apis/security.openshift.io/v1/watch/rangeallocations/{name}
Global path parameters
| Parameter | Type | Description |
|---|---|---|
name | string | name of the RangeAllocation |
- HTTP method
`GET`- Description
watch changes to an object of kind RangeAllocation. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
HTTP responses
| HTTP code | Reponse body |
|---|---|
| 200 - OK | WatchEvent schema |
| 401 - Unauthorized | Empty |