Ce contenu n'est pas disponible dans la langue sélectionnée.

Chapter 32. ServiceCIDR [networking.k8s.io/v1]


Description
ServiceCIDR defines a range of IP addresses using CIDR format (e.g. 192.168.0.0/24 or 2001:db2::/64). This range is used to allocate ClusterIPs to Service objects.
Type
object

32.1. Specification

Expand
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

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

ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services.

status

object

ServiceCIDRStatus describes the current state of the ServiceCIDR.

32.1.1. .spec

Description
ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services.
Type
object
Expand
PropertyTypeDescription

cidrs

array (string)

CIDRs defines the IP blocks in CIDR notation (e.g. "192.168.0.0/24" or "2001:db8::/64") from which to assign service cluster IPs. Max of two CIDRs is allowed, one of each IP family. This field is immutable.

32.1.2. .status

Description
ServiceCIDRStatus describes the current state of the ServiceCIDR.
Type
object
Expand
PropertyTypeDescription

conditions

array (Condition)

conditions holds an array of metav1.Condition that describe the state of the ServiceCIDR. Current service state

32.2. API endpoints

The following API endpoints are available:

  • /apis/networking.k8s.io/v1/servicecidrs

    • DELETE: delete collection of ServiceCIDR
    • GET: list or watch objects of kind ServiceCIDR
    • POST: create a ServiceCIDR
  • /apis/networking.k8s.io/v1/watch/servicecidrs

    • GET: watch individual changes to a list of ServiceCIDR. deprecated: use the 'watch' parameter with a list operation instead.
  • /apis/networking.k8s.io/v1/servicecidrs/{name}

    • DELETE: delete a ServiceCIDR
    • GET: read the specified ServiceCIDR
    • PATCH: partially update the specified ServiceCIDR
    • PUT: replace the specified ServiceCIDR
  • /apis/networking.k8s.io/v1/watch/servicecidrs/{name}

    • GET: watch changes to an object of kind ServiceCIDR. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
  • /apis/networking.k8s.io/v1/servicecidrs/{name}/status

    • GET: read status of the specified ServiceCIDR
    • PATCH: partially update status of the specified ServiceCIDR
    • PUT: replace status of the specified ServiceCIDR

32.2.1. /apis/networking.k8s.io/v1/servicecidrs

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

Expand
Table 32.2. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
list or watch objects of kind ServiceCIDR
Expand
Table 32.3. HTTP responses
HTTP codeReponse body

200 - OK

ServiceCIDRList schema

401 - Unauthorized

Empty

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

Expand
Table 32.5. Body parameters
ParameterTypeDescription

body

ServiceCIDR schema

 
Expand
Table 32.6. HTTP responses
HTTP codeReponse body

200 - OK

ServiceCIDR schema

201 - Created

ServiceCIDR schema

202 - Accepted

ServiceCIDR schema

401 - Unauthorized

Empty

32.2.2. /apis/networking.k8s.io/v1/watch/servicecidrs

HTTP method
GET
Description
watch individual changes to a list of ServiceCIDR. deprecated: use the 'watch' parameter with a list operation instead.
Expand
Table 32.7. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

32.2.3. /apis/networking.k8s.io/v1/servicecidrs/{name}

Expand
Table 32.8. Global path parameters
ParameterTypeDescription

name

string

name of the ServiceCIDR

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

Expand
Table 32.10. HTTP responses
HTTP codeReponse body

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

HTTP method
GET
Description
read the specified ServiceCIDR
Expand
Table 32.11. HTTP responses
HTTP codeReponse body

200 - OK

ServiceCIDR schema

401 - Unauthorized

Empty

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

Expand
Table 32.13. HTTP responses
HTTP codeReponse body

200 - OK

ServiceCIDR schema

201 - Created

ServiceCIDR schema

401 - Unauthorized

Empty

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

Expand
Table 32.15. Body parameters
ParameterTypeDescription

body

ServiceCIDR schema

 
Expand
Table 32.16. HTTP responses
HTTP codeReponse body

200 - OK

ServiceCIDR schema

201 - Created

ServiceCIDR schema

401 - Unauthorized

Empty

32.2.4. /apis/networking.k8s.io/v1/watch/servicecidrs/{name}

Expand
Table 32.17. Global path parameters
ParameterTypeDescription

name

string

name of the ServiceCIDR

HTTP method
GET
Description
watch changes to an object of kind ServiceCIDR. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
Expand
Table 32.18. HTTP responses
HTTP codeReponse body

200 - OK

WatchEvent schema

401 - Unauthorized

Empty

32.2.5. /apis/networking.k8s.io/v1/servicecidrs/{name}/status

Expand
Table 32.19. Global path parameters
ParameterTypeDescription

name

string

name of the ServiceCIDR

HTTP method
GET
Description
read status of the specified ServiceCIDR
Expand
Table 32.20. HTTP responses
HTTP codeReponse body

200 - OK

ServiceCIDR schema

401 - Unauthorized

Empty

HTTP method
PATCH
Description
partially update status of the specified ServiceCIDR
Expand
Table 32.21. 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.

Expand
Table 32.22. HTTP responses
HTTP codeReponse body

200 - OK

ServiceCIDR schema

201 - Created

ServiceCIDR schema

401 - Unauthorized

Empty

HTTP method
PUT
Description
replace status of the specified ServiceCIDR
Expand
Table 32.23. 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.

Expand
Table 32.24. Body parameters
ParameterTypeDescription

body

ServiceCIDR schema

 
Expand
Table 32.25. HTTP responses
HTTP codeReponse body

200 - OK

ServiceCIDR schema

201 - Created

ServiceCIDR schema

401 - Unauthorized

Empty

Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat