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

描述
DCSMachine is the Schema for the dcsmachines 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

DCSMachineSpec defines the desired state of DCSMachine.

statusobject

DCSMachineStatus defines the observed state of DCSMachine.

.spec

描述
DCSMachineSpec defines the desired state of DCSMachine.
类型
object
必填
ipHostPoolRefvmTemplateName
属性类型描述
ipHostPoolRefobject

LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.

locationobject
providerIDstring
resourceobject
vmConfigobject
vmTemplateNamestring
vmUrnstring

.spec.ipHostPoolRef

描述
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
类型
object
属性类型描述
namestring

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

类型
object
必填
type
属性类型描述
namestring
typestring
urnstring

.spec.resource

类型
object
必填
type
属性类型描述
namestring
typestring
urnstring

.spec.vmConfig

类型
object
必填
dcsMachineCpuSpecdcsMachineMemorySpec
属性类型描述
cdRomDatastoreClusterNamestring
cdRomDatastoreNamestring
dcsMachineCpuSpecobject
dcsMachineDiskSpecarray
dcsMachineMemorySpecobject
dvSwitchNamestring
portGroupNamestring
portGroupUrnstring

.spec.vmConfig.dcsMachineCpuSpec

类型
object
必填
quantity
属性类型描述
quantityinteger

.spec.vmConfig.dcsMachineDiskSpec

类型
array

.spec.vmConfig.dcsMachineDiskSpec[]

类型
object
必填
quantity
属性类型描述
datastoreClusterNamestring
datastoreNamestring
datastoreUrnstring
formatstring
mountOptionsarray
optionsarray
pathstring
quantityinteger
systemVolumeboolean
wipeFilesystemboolean

.spec.vmConfig.dcsMachineDiskSpec[].mountOptions

类型
array

.spec.vmConfig.dcsMachineDiskSpec[].mountOptions[]

类型
string

.spec.vmConfig.dcsMachineDiskSpec[].options

类型
array

.spec.vmConfig.dcsMachineDiskSpec[].options[]

类型
string

.spec.vmConfig.dcsMachineMemorySpec

类型
object
必填
quantity
属性类型描述
quantityinteger

.status

描述
DCSMachineStatus defines the observed state of DCSMachine.
类型
object
属性类型描述
additionalNicarray
addressesarray

MachineAddresses is a slice of MachineAddress items to be used by infrastructure providers.

cdRomDatastoreUrnstring
cdRomDetachedboolean
cdRomFilestring
cdRomFileDeletedboolean
conditionsarray

Conditions provide observations of the operational state of a Cluster API resource.

failureDomainsobject

FailureDomains is a slice of FailureDomains.

networkConfigobject

DCSMachineNetworkConfig is the Pool IP entry projected onto a DCSMachine. It mirrors DCSIpHostname but excludes pool-owned fields that have no meaning on a per-Machine record (notably PersistentDisk, which is coordinated by the Pool).

readyboolean

.status.additionalNic

类型
array

.status.additionalNic[]

类型
object
属性类型描述
dnsstring
dvSwitchNamestring
gatewaystring
ipstring
ipv6string
maskstring
portGroupNamestring
portGroupUrnstring

.status.addresses

描述
MachineAddresses is a slice of MachineAddress items to be used by infrastructure providers.
类型
array

.status.addresses[]

描述
MachineAddress contains information for the node's address.
类型
object
必填
addresstype
属性类型描述
addressstring

address is the machine address.

typestring

type is the machine address type, one of Hostname, ExternalIP, InternalIP, ExternalDNS or InternalDNS.

.status.conditions

描述
Conditions provide observations of the operational state of a Cluster API resource.
类型
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.failureDomains

描述
FailureDomains is a slice of FailureDomains.
类型
object

.status.networkConfig

描述
DCSMachineNetworkConfig is the Pool IP entry projected onto a DCSMachine. It mirrors DCSIpHostname but excludes pool-owned fields that have no meaning on a per-Machine record (notably PersistentDisk, which is coordinated by the Pool).
类型
object
属性类型描述
additionNicarray
dnsstring
dvSwitchNamestring
gatewaystring
hostnamestring
ipstring
ipv6string
machineNamestring
maskstring
portGroupNamestring
portGroupUrnstring

.status.networkConfig.additionNic

类型
array

.status.networkConfig.additionNic[]

类型
object
属性类型描述
dnsstring
dvSwitchNamestring
gatewaystring
ipstring
ipv6string
maskstring
portGroupNamestring
portGroupUrnstring

API 端点

可用的 API 端点如下:

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

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsmachines

HTTP 方法
DELETE
描述
delete collection of DCSMachine
HTTP 响应
HTTP 状态码响应体
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP 方法
GET
描述
list objects of kind DCSMachine
HTTP 响应
HTTP 状态码响应体
200 - OKDCSMachineList schema
401 - UnauthorizedEmpty
HTTP 方法
POST
描述
create a new DCSMachine
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyDCSMachine schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKDCSMachine schema
201 - CreatedDCSMachine schema
202 - AcceptedDCSMachine schema
401 - UnauthorizedEmpty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsmachines/{name}

HTTP 方法
DELETE
描述
delete the specified DCSMachine
查询参数
参数类型描述
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 DCSMachine
HTTP 响应
HTTP 状态码响应体
200 - OKDCSMachine schema
401 - UnauthorizedEmpty
HTTP 方法
PATCH
描述
partially update the specified DCSMachine
查询参数
参数类型描述
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 - OKDCSMachine schema
401 - UnauthorizedEmpty
HTTP 方法
PUT
描述
replace the specified DCSMachine
查询参数
参数类型描述
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.
请求体参数
参数类型描述
bodyDCSMachine schemaapplication/json formatted
HTTP 响应
HTTP 状态码响应体
200 - OKDCSMachine schema
201 - CreatedDCSMachine schema
401 - UnauthorizedEmpty

/apis/infrastructure.cluster.x-k8s.io/v1beta1/namespaces/{namespace}/dcsmachines/{name}/status

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