Immutable Infrastructure

简体中文

IPAddress [ipam.cluster.x-k8s.io/v1alpha1]

描述: IPAddress is the Schema for the ipaddress API.
类型: object

规格

属性	类型	描述
`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`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	spec is the desired state of IPAddress.

.spec

描述: spec is the desired state of IPAddress.
类型: object
必填: addressclaimRefpoolRefprefix

属性	类型	描述
`address`	`string`	address is the IP address.
`claimRef`	`object`	claimRef is a reference to the claim this IPAddress was created for.
`gateway`	`string`	gateway is the network gateway of the network the address is from.
`poolRef`	`object`	poolRef is a reference to the pool that this IPAddress was created from.
`prefix`	`integer`	prefix is the prefix of the address.

.spec.claimRef

描述: claimRef is a reference to the claim this IPAddress was created for.
类型: object

属性	类型	描述
`name`	`string`	Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

.spec.poolRef

描述: poolRef is a reference to the pool that this IPAddress was created from.
类型: object
必填: kindname

属性	类型	描述
`apiGroup`	`string`	APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.
`kind`	`string`	Kind is the type of resource being referenced
`name`	`string`	Name is the name of resource being referenced

API 端点

可用的 API 端点如下：

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses
- DELETE: delete collection of IPAddress
- GET: list objects of kind IPAddress
- POST: create a new IPAddress
/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses/{name}
- DELETE: delete the specified IPAddress
- GET: read the specified IPAddress
- PATCH: partially update the specified IPAddress
- PUT: replace the specified IPAddress

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses

HTTP 方法: DELETE
描述: delete collection of IPAddress
HTTP 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: list objects of kind IPAddress
HTTP 响应

HTTP 状态码	响应体
200 - OK	`IPAddressList` schema
401 - Unauthorized	Empty

HTTP 方法: POST
描述: create a new IPAddress

查询参数

参数	类型	描述
`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`	`IPAddress` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`IPAddress` schema
201 - Created	`IPAddress` schema
202 - Accepted	`IPAddress` schema
401 - Unauthorized	Empty

/apis/ipam.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/ipaddresses/{name}

HTTP 方法: DELETE
描述: delete the specified IPAddress

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP 方法: GET
描述: read the specified IPAddress
HTTP 响应

HTTP 状态码	响应体
200 - OK	`IPAddress` schema
401 - Unauthorized	Empty

HTTP 方法: PATCH
描述: partially update the specified IPAddress

查询参数

参数	类型	描述
`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 响应

HTTP 状态码	响应体
200 - OK	`IPAddress` schema
401 - Unauthorized	Empty

HTTP 方法: PUT
描述: replace the specified IPAddress

查询参数

参数	类型	描述
`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`	`IPAddress` schema	`application/json` formatted

HTTP 响应

HTTP 状态码	响应体
200 - OK	`IPAddress` schema
201 - Created	`IPAddress` schema
401 - Unauthorized	Empty