Search
SupportConsoleDevelopersStart a trialContact

Chapter 7. RangeAllocation [security.openshift.io/v1]

download PDF
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
  • range
  • data

7.1. Specification

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

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_v2

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".

7.2. API endpoints

The following API endpoints are available:

  • /apis/security.openshift.io/v1/rangeallocations

    • DELETE: delete collection of RangeAllocation
    • GET: list or watch objects of kind RangeAllocation
    • POST: create a RangeAllocation

  • /apis/security.openshift.io/v1/watch/rangeallocations

    • GET: 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 RangeAllocation
    • GET: read the specified RangeAllocation
    • PATCH: partially update the specified RangeAllocation
    • PUT: 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.

7.2.1. /apis/security.openshift.io/v1/rangeallocations

HTTP method
DELETE
Description
delete collection of RangeAllocation
Table 7.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

Table 7.2. HTTP responses
HTTP codeReponse body

200 - OK

Status_v9 schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind RangeAllocation
Table 7.3. HTTP responses
HTTP codeReponse body

200 - OK

RangeAllocationList schema

401 - Unauthorized

Empty

HTTP method
POST
Description
create a RangeAllocation
Table 7.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.

Table 7.5. Body parameters
ParameterTypeDescription

body

RangeAllocation schema

 
Table 7.6. HTTP responses
HTTP codeReponse body

200 - OK

RangeAllocation schema

201 - Created

RangeAllocation schema

202 - Accepted

RangeAllocation schema

401 - Unauthorized

Empty

7.2.2. /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.
Table 7.7. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

7.2.3. /apis/security.openshift.io/v1/rangeallocations/{name}

Table 7.8. Global path parameters
ParameterTypeDescription

name

string

name of the RangeAllocation

HTTP method
DELETE
Description
delete a RangeAllocation
Table 7.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

Table 7.10. HTTP responses
HTTP codeReponse body

200 - OK

Status_v9 schema

202 - Accepted

Status_v9 schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified RangeAllocation
Table 7.11. HTTP responses
HTTP codeReponse body

200 - OK

RangeAllocation schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update the specified RangeAllocation
Table 7.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.

Table 7.13. HTTP responses
HTTP codeReponse body

200 - OK

RangeAllocation schema

201 - Created

RangeAllocation schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace the specified RangeAllocation
Table 7.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.

Table 7.15. Body parameters
ParameterTypeDescription

body

RangeAllocation schema

 
Table 7.16. HTTP responses
HTTP codeReponse body

200 - OK

RangeAllocation schema

201 - Created

RangeAllocation schema

401 - Unauthorized

Empty

7.2.4. /apis/security.openshift.io/v1/watch/rangeallocations/{name}

Table 7.17. Global path parameters
ParameterTypeDescription

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.
Table 7.18. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.