VSphereDeploymentZone [infrastructure.cluster.x-k8s.io/v1beta1]

描述
VSphereDeploymentZone is the Schema for the vspheredeploymentzones API.
类型
object

规格

属性类型描述
apiVersionstring

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

kindstring

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

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

VSphereDeploymentZoneSpec defines the desired state of VSphereDeploymentZone.

statusobject

VSphereDeploymentZoneStatus contains the status for a VSphereDeploymentZone.

.spec

描述
VSphereDeploymentZoneSpec defines the desired state of VSphereDeploymentZone.
类型
object
必填
placementConstraint
属性类型描述
controlPlaneboolean

ControlPlane determines if this failure domain is suitable for use by control plane machines.

failureDomainstring

FailureDomain is the name of the VSphereFailureDomain used for this VSphereDeploymentZone

placementConstraintobject

PlacementConstraint encapsulates the placement constraints used within this deployment zone.

serverstring

Server is the address of the vSphere endpoint.

.spec.placementConstraint

描述
PlacementConstraint encapsulates the placement constraints used within this deployment zone.
类型
object
属性类型描述
folderstring

Folder is the name or inventory path of the folder in which the virtual machine is created/located.

resourcePoolstring

ResourcePool is the name or inventory path of the resource pool in which the virtual machine is created/located.

.status

描述
VSphereDeploymentZoneStatus contains the status for a VSphereDeploymentZone.
类型
object
属性类型描述
conditionsarray

Conditions defines current service state of the VSphereDeploymentZone.

readyboolean

Ready is true when the VSphereDeploymentZone resource is ready. If set to false, it will be ignored by VSphereClusters

v1beta2object

v1beta2 groups all the fields that will be added or modified in VSphereDeploymentZone's status with the V1Beta2 version.

.status.conditions

描述
Conditions defines current service state of the VSphereDeploymentZone.
类型
array

.status.conditions[]

描述
Condition defines an observation of a Cluster API resource operational state.
类型
object
必填
lastTransitionTimestatustype
属性类型描述
lastTransitionTimestring

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.

messagestring

message is a human readable message indicating details about the transition. This field may be empty.

reasonstring

reason is the reason for the condition's last transition in CamelCase. The specific API may choose whether or not this field is considered a guaranteed API. This field may be empty.

severitystring

severity provides an explicit classification of Reason code, so the users or machines can immediately understand the current situation and act accordingly. The Severity field MUST be set only when Status=False.

statusstring

status of the condition, one of True, False, Unknown.

typestring

type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to deconflict is important.

.status.v1beta2

描述
v1beta2 groups all the fields that will be added or modified in VSphereDeploymentZone's status with the V1Beta2 version.
类型
object
属性类型描述
conditionsarray

conditions represents the observations of a VSphereDeploymentZone's current state. Known condition types are Ready, VCenterAvailable, PlacementConstraintReady, FailureDomainValidated and Paused.

.status.v1beta2.conditions

描述
conditions represents the observations of a VSphereDeploymentZone's current state. Known condition types are Ready, VCenterAvailable, PlacementConstraintReady, FailureDomainValidated and Paused.
类型
array

.status.v1beta2.conditions[]

描述
Condition contains details for one aspect of the current state of this API Resource.
类型
object
必填
lastTransitionTimemessagereasonstatustype
属性类型描述
lastTransitionTimestring

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.

messagestring

message is a human readable message indicating details about the transition. This may be an empty string.

observedGenerationinteger

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.

reasonstring

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.

statusstring

status of the condition, one of True, False, Unknown.

typestring

type of condition in CamelCase or in foo.example.com/CamelCase.

API 端点

可用的 API 端点如下:

  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/vspheredeploymentzones
    • DELETE: delete collection of VSphereDeploymentZone
    • GET: list objects of kind VSphereDeploymentZone
    • POST: create a new VSphereDeploymentZone
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/vspheredeploymentzones/{name}
    • DELETE: delete the specified VSphereDeploymentZone
    • GET: read the specified VSphereDeploymentZone
    • PATCH: partially update the specified VSphereDeploymentZone
    • PUT: replace the specified VSphereDeploymentZone
  • /apis/infrastructure.cluster.x-k8s.io/v1beta1/vspheredeploymentzones/{name}/status
    • GET: read status of the specified VSphereDeploymentZone
    • PATCH: partially update status of the specified VSphereDeploymentZone
    • PUT: replace status of the specified VSphereDeploymentZone

/apis/infrastructure.cluster.x-k8s.io/v1beta1/vspheredeploymentzones

HTTP 方法
DELETE
描述
delete collection of VSphereDeploymentZone
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind VSphereDeploymentZone
HTTP 响应
HTTP 状态码响应体
200 - OKVSphereDeploymentZoneList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new VSphereDeploymentZone
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyVSphereDeploymentZone schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKVSphereDeploymentZone schema
201 - CreatedVSphereDeploymentZone schema
202 - AcceptedVSphereDeploymentZone schema
401 - UnauthorizedEmpty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/vspheredeploymentzones/{name}

HTTP 方法
DELETE
描述
delete the specified VSphereDeploymentZone
查询参数
参数类型描述
dryRunstringWhen 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 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
read the specified VSphereDeploymentZone
HTTP 响应
HTTP 状态码响应体
200 - OKVSphereDeploymentZone schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified VSphereDeploymentZone
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 - OKVSphereDeploymentZone schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified VSphereDeploymentZone
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyVSphereDeploymentZone schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKVSphereDeploymentZone schema
201 - CreatedVSphereDeploymentZone schema
401 - UnauthorizedEmpty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/vspheredeploymentzones/{name}/status

HTTP 方法
GET
描述
read status of the specified VSphereDeploymentZone
HTTP 响应
HTTP 状态码响应体
200 - OKVSphereDeploymentZone schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update status of the specified VSphereDeploymentZone
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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 - OKVSphereDeploymentZone schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace status of the specified VSphereDeploymentZone
查询参数
参数类型描述
dryRunstringWhen 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
fieldValidationstringfieldValidation 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.
请求体参数
参数类型描述
bodyVSphereDeploymentZone schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKVSphereDeploymentZone schema
201 - CreatedVSphereDeploymentZone schema
401 - UnauthorizedEmpty