Alauda Container Platform
  • 简体中文

    • VirtualMachineSnapshot [virtualmachinesnapshots.snapshot.kubevirt.io/v1beta1]

    描述
    VirtualMachineSnapshot defines the operation of snapshotting a VM
    类型
    object
    必填
    spec

    规格

    属性类型描述
    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

    VirtualMachineSnapshotSpec is the spec for a VirtualMachineSnapshot resource

    statusobject

    VirtualMachineSnapshotStatus is the status for a VirtualMachineSnapshot resource

    .spec

    描述
    VirtualMachineSnapshotSpec is the spec for a VirtualMachineSnapshot resource
    类型
    object
    必填
    source
    属性类型描述
    deletionPolicystring

    DeletionPolicy defines that to do with VirtualMachineSnapshot when VirtualMachineSnapshot is deleted

    failureDeadlinestring

    This time represents the number of seconds we permit the vm snapshot to take. In case we pass this deadline we mark this snapshot as failed. Defaults to DefaultFailureDeadline - 5min

    sourceobject

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

    .spec.source

    描述
    TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
    类型
    object
    必填
    kindname
    属性类型描述
    apiGroupstring

    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.

    kindstring

    Kind is the type of resource being referenced

    namestring

    Name is the name of resource being referenced

    .status

    描述
    VirtualMachineSnapshotStatus is the status for a VirtualMachineSnapshot resource
    类型
    object
    属性类型描述
    conditionsarray
    creationTimestring
    errorobject

    Error is the last error encountered during the snapshot/restore

    indicationsarray

    Deprecated: Use SourceIndications instead. This field will be removed in a future version.

    phasestring

    VirtualMachineSnapshotPhase is the current phase of the VirtualMachineSnapshot

    readyToUseboolean
    snapshotVolumesobject

    SnapshotVolumesLists includes the list of volumes which were included in the snapshot and volumes which were excluded from the snapshot

    sourceIndicationsarray
    sourceUIDstring

    UID is a type that holds unique ID values, including UUIDs. Because we don't ONLY use UUIDs, this is an alias to string. Being a type captures intent and helps make sure that UIDs and names do not get conflated.

    virtualMachineSnapshotContentNamestring

    .status.conditions

    类型
    array

    .status.conditions[]

    描述
    Condition defines conditions
    类型
    object
    必填
    statustype
    属性类型描述
    lastProbeTimestring
    lastTransitionTimestring
    messagestring
    reasonstring
    statusstring
    typestring

    ConditionType is the const type for Conditions

    .status.error

    描述
    Error is the last error encountered during the snapshot/restore
    类型
    object
    属性类型描述
    messagestring
    timestring

    .status.indications

    描述
    Deprecated: Use SourceIndications instead. This field will be removed in a future version.
    类型
    array

    .status.indications[]

    描述
    Indication is a way to indicate the state of the vm when taking the snapshot
    类型
    string

    .status.snapshotVolumes

    描述
    SnapshotVolumesLists includes the list of volumes which were included in the snapshot and volumes which were excluded from the snapshot
    类型
    object
    属性类型描述
    excludedVolumesarray
    includedVolumesarray

    .status.snapshotVolumes.excludedVolumes

    类型
    array

    .status.snapshotVolumes.excludedVolumes[]

    类型
    string

    .status.snapshotVolumes.includedVolumes

    类型
    array

    .status.snapshotVolumes.includedVolumes[]

    类型
    string

    .status.sourceIndications

    类型
    array

    .status.sourceIndications[]

    描述
    SourceIndication provides an indication of the source VM with its description message
    类型
    object
    必填
    indicationmessage
    属性类型描述
    indicationstring

    Indication is the indication type

    messagestring

    Message provides a description message of the indication

    API 端点

    可用的 API 端点如下：

    • /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots
      • DELETE: delete collection of VirtualMachineSnapshot
      • GET: list objects of kind VirtualMachineSnapshot
      • POST: create a new VirtualMachineSnapshot
    • /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots/{name}
      • DELETE: delete the specified VirtualMachineSnapshot
      • GET: read the specified VirtualMachineSnapshot
      • PATCH: partially update the specified VirtualMachineSnapshot
      • PUT: replace the specified VirtualMachineSnapshot
    • /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots/{name}/status
      • GET: read status of the specified VirtualMachineSnapshot
      • PATCH: partially update status of the specified VirtualMachineSnapshot
      • PUT: replace status of the specified VirtualMachineSnapshot

    /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots

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

    /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots/{name}

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

    /apis/snapshot.kubevirt.io/v1beta1/namespaces/{namespace}/virtualmachinesnapshots/{name}/status

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