--- api_metadata: apiVersion: "networking.k8s.io/v1beta1" import: "k8s.io/api/networking/v1beta1" kind: "ServiceCIDR" content_type: "api_reference" description: "ServiceCIDR defines a range of IP addresses using CIDR format (e." title: "ServiceCIDR v1beta1" weight: 10 auto_generated: true --- `apiVersion: networking.k8s.io/v1beta1` `import "k8s.io/api/networking/v1beta1"` ## ServiceCIDR {#ServiceCIDR} 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.

- **apiVersion**: networking.k8s.io/v1beta1 - **kind**: ServiceCIDR - **metadata** (}}">ObjectMeta) Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **spec** (}}">ServiceCIDRSpec) spec is the desired state of the ServiceCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status - **status** (}}">ServiceCIDRStatus) status represents the current state of the ServiceCIDR. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status ## ServiceCIDRSpec {#ServiceCIDRSpec} ServiceCIDRSpec define the CIDRs the user wants to use for allocating ClusterIPs for Services.

- **cidrs** ([]string) *Atomic: will be replaced during a merge* 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. ## ServiceCIDRStatus {#ServiceCIDRStatus} ServiceCIDRStatus describes the current state of the ServiceCIDR.

- **conditions** ([]Condition) *Patch strategy: merge on key `type`* *Map: unique values on key type will be kept during a merge* conditions holds an array of metav1.Condition that describe the state of the ServiceCIDR. Current service state *Condition contains details for one aspect of the current state of this API Resource.* - **conditions.lastTransitionTime** (Time), required 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. *Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers.* - **conditions.message** (string), required message is a human readable message indicating details about the transition. This may be an empty string. - **conditions.reason** (string), required 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. - **conditions.status** (string), required status of the condition, one of True, False, Unknown. - **conditions.type** (string), required type of condition in CamelCase or in foo.example.com/CamelCase. - **conditions.observedGeneration** (int64) 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. ## ServiceCIDRList {#ServiceCIDRList} ServiceCIDRList contains a list of ServiceCIDR objects.

- **apiVersion**: networking.k8s.io/v1beta1 - **kind**: ServiceCIDRList - **metadata** (}}">ListMeta) Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata - **items** ([]}}">ServiceCIDR), required items is the list of ServiceCIDRs. ## Operations {#Operations}

### `get` read the specified ServiceCIDR #### HTTP Request GET /apis/networking.k8s.io/v1beta1/servicecidrs/{name} #### Parameters - **name** (*in path*): string, required name of the ServiceCIDR - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ServiceCIDR): OK 401: Unauthorized ### `get` read status of the specified ServiceCIDR #### HTTP Request GET /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status #### Parameters - **name** (*in path*): string, required name of the ServiceCIDR - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ServiceCIDR): OK 401: Unauthorized ### `list` list or watch objects of kind ServiceCIDR #### HTTP Request GET /apis/networking.k8s.io/v1beta1/servicecidrs #### Parameters - **allowWatchBookmarks** (*in query*): boolean }}">allowWatchBookmarks - **continue** (*in query*): string }}">continue - **fieldSelector** (*in query*): string }}">fieldSelector - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **sendInitialEvents** (*in query*): boolean }}">sendInitialEvents - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds - **watch** (*in query*): boolean }}">watch #### Response 200 (}}">ServiceCIDRList): OK 401: Unauthorized ### `create` create a ServiceCIDR #### HTTP Request POST /apis/networking.k8s.io/v1beta1/servicecidrs #### Parameters - **body**: }}">ServiceCIDR, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ServiceCIDR): OK 201 (}}">ServiceCIDR): Created 202 (}}">ServiceCIDR): Accepted 401: Unauthorized ### `update` replace the specified ServiceCIDR #### HTTP Request PUT /apis/networking.k8s.io/v1beta1/servicecidrs/{name} #### Parameters - **name** (*in path*): string, required name of the ServiceCIDR - **body**: }}">ServiceCIDR, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ServiceCIDR): OK 201 (}}">ServiceCIDR): Created 401: Unauthorized ### `update` replace status of the specified ServiceCIDR #### HTTP Request PUT /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status #### Parameters - **name** (*in path*): string, required name of the ServiceCIDR - **body**: }}">ServiceCIDR, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ServiceCIDR): OK 201 (}}">ServiceCIDR): Created 401: Unauthorized ### `patch` partially update the specified ServiceCIDR #### HTTP Request PATCH /apis/networking.k8s.io/v1beta1/servicecidrs/{name} #### Parameters - **name** (*in path*): string, required name of the ServiceCIDR - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ServiceCIDR): OK 201 (}}">ServiceCIDR): Created 401: Unauthorized ### `patch` partially update status of the specified ServiceCIDR #### HTTP Request PATCH /apis/networking.k8s.io/v1beta1/servicecidrs/{name}/status #### Parameters - **name** (*in path*): string, required name of the ServiceCIDR - **body**: }}">Patch, required - **dryRun** (*in query*): string }}">dryRun - **fieldManager** (*in query*): string }}">fieldManager - **fieldValidation** (*in query*): string }}">fieldValidation - **force** (*in query*): boolean }}">force - **pretty** (*in query*): string }}">pretty #### Response 200 (}}">ServiceCIDR): OK 201 (}}">ServiceCIDR): Created 401: Unauthorized ### `delete` delete a ServiceCIDR #### HTTP Request DELETE /apis/networking.k8s.io/v1beta1/servicecidrs/{name} #### Parameters - **name** (*in path*): string, required name of the ServiceCIDR - **body**: }}">DeleteOptions - **dryRun** (*in query*): string }}">dryRun - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy #### Response 200 (}}">Status): OK 202 (}}">Status): Accepted 401: Unauthorized ### `deletecollection` delete collection of ServiceCIDR #### HTTP Request DELETE /apis/networking.k8s.io/v1beta1/servicecidrs #### Parameters - **body**: }}">DeleteOptions - **continue** (*in query*): string }}">continue - **dryRun** (*in query*): string }}">dryRun - **fieldSelector** (*in query*): string }}">fieldSelector - **gracePeriodSeconds** (*in query*): integer }}">gracePeriodSeconds - **labelSelector** (*in query*): string }}">labelSelector - **limit** (*in query*): integer }}">limit - **pretty** (*in query*): string }}">pretty - **propagationPolicy** (*in query*): string }}">propagationPolicy - **resourceVersion** (*in query*): string }}">resourceVersion - **resourceVersionMatch** (*in query*): string }}">resourceVersionMatch - **sendInitialEvents** (*in query*): boolean }}">sendInitialEvents - **timeoutSeconds** (*in query*): integer }}">timeoutSeconds #### Response 200 (}}">Status): OK 401: Unauthorized