VolumeSnapshotLocation [velero.io/v1]

描述
VolumeSnapshotLocation is a location where Velero stores volume snapshots.
类型
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

VolumeSnapshotLocationSpec defines the specification for a Velero VolumeSnapshotLocation.

statusobject

VolumeSnapshotLocationStatus describes the current status of a Velero VolumeSnapshotLocation.

.spec

描述
VolumeSnapshotLocationSpec defines the specification for a Velero VolumeSnapshotLocation.
类型
object
必填
provider
属性类型描述
configobject

Config is for provider-specific configuration fields.

credentialobject

Credential contains the credential information intended to be used with this location

providerstring

Provider is the provider of the volume storage.

.spec.config

描述
Config is for provider-specific configuration fields.
类型
object

.spec.credential

描述
Credential contains the credential information intended to be used with this location
类型
object
必填
key
属性类型描述
keystring

The key of the secret to select from. Must be a valid secret key.

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optionalboolean

Specify whether the Secret or its key must be defined

.status

描述
VolumeSnapshotLocationStatus describes the current status of a Velero VolumeSnapshotLocation.
类型
object
属性类型描述
phasestring

VolumeSnapshotLocationPhase is the lifecycle phase of a Velero VolumeSnapshotLocation.

API 端点

可用的 API 端点如下:

  • /apis/velero.io/v1/namespaces/{namespace}/volumesnapshotlocations
    • DELETE: delete collection of VolumeSnapshotLocation
    • GET: list objects of kind VolumeSnapshotLocation
    • POST: create a new VolumeSnapshotLocation
  • /apis/velero.io/v1/namespaces/{namespace}/volumesnapshotlocations/{name}
    • DELETE: delete the specified VolumeSnapshotLocation
    • GET: read the specified VolumeSnapshotLocation
    • PATCH: partially update the specified VolumeSnapshotLocation
    • PUT: replace the specified VolumeSnapshotLocation

/apis/velero.io/v1/namespaces/{namespace}/volumesnapshotlocations

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

/apis/velero.io/v1/namespaces/{namespace}/volumesnapshotlocations/{name}

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