Alauda Database Service for MySQL

MySQL-PXC Restore

Type
object

Specification

PropertyTypeDescription
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

PerconaXtraDBClusterRestoreSpec defines the desired state of PerconaXtraDBClusterRestore

statusobject

PerconaXtraDBClusterRestoreStatus defines the observed state of PerconaXtraDBClusterRestore

.spec

Description
PerconaXtraDBClusterRestoreSpec defines the desired state of PerconaXtraDBClusterRestore
Type
object
Required
backupNamepxcCluster
PropertyTypeDescription
backupNamestring
backupSourceobject
pitrobject
pxcClusterstring

.spec.backupSource

Type
object
PropertyTypeDescription
completedstring
destinationstring
lastscheduledstring
messagestring
s3object
secretstring
statestring
storageNamestring

.spec.backupSource.s3

Type
object
Required
bucketcredentialsSecret
PropertyTypeDescription
bucketstring
credentialsSecretstring
endpointUrlstring
regionstring

.spec.pitr

Type
object
Required
backupSourcedategtidSettype
PropertyTypeDescription
backupSourceobject
datestring
gtidSetstring
typestring

.spec.pitr.backupSource

Type
object
PropertyTypeDescription
completedstring
destinationstring
lastscheduledstring
messagestring
s3object
secretstring
statestring
storageNamestring

.spec.pitr.backupSource.s3

Type
object
Required
bucketcredentialsSecret
PropertyTypeDescription
bucketstring
credentialsSecretstring
endpointUrlstring
regionstring

.status

Description
PerconaXtraDBClusterRestoreStatus defines the observed state of PerconaXtraDBClusterRestore
Type
object
PropertyTypeDescription
commentsstring
completedstring
lastscheduledstring
statestring

API Endpoints

The following API endpoints are available:

  • /apis/pxc.percona.com/v1/namespaces/{namespace}/perconaxtradbclusterrestores
    • DELETE: delete collection of PerconaXtraDBClusterRestore
    • GET: list objects of kind PerconaXtraDBClusterRestore
    • POST: create a new PerconaXtraDBClusterRestore
  • /apis/pxc.percona.com/v1/namespaces/{namespace}/perconaxtradbclusterrestores/{name}
    • DELETE: delete the specified PerconaXtraDBClusterRestore
    • GET: read the specified PerconaXtraDBClusterRestore
    • PATCH: partially update the specified PerconaXtraDBClusterRestore
    • PUT: replace the specified PerconaXtraDBClusterRestore
  • /apis/pxc.percona.com/v1/namespaces/{namespace}/perconaxtradbclusterrestores/{name}/status
    • GET: read status of the specified PerconaXtraDBClusterRestore
    • PATCH: partially update status of the specified PerconaXtraDBClusterRestore
    • PUT: replace status of the specified PerconaXtraDBClusterRestore

/apis/pxc.percona.com/v1/namespaces/{namespace}/perconaxtradbclusterrestores

HTTP method
DELETE
Description
delete collection of PerconaXtraDBClusterRestore
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind PerconaXtraDBClusterRestore
HTTP responses
HTTP codeResponse body
200 - OKPerconaXtraDBClusterRestoreList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new PerconaXtraDBClusterRestore
Query parameters
ParameterTypeDescription
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.
Body parameters
ParameterTypeDescription
bodyPerconaXtraDBClusterRestore schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKPerconaXtraDBClusterRestore schema
201 - CreatedPerconaXtraDBClusterRestore schema
202 - AcceptedPerconaXtraDBClusterRestore schema
401 - UnauthorizedEmpty

/apis/pxc.percona.com/v1/namespaces/{namespace}/perconaxtradbclusterrestores/{name}

HTTP method
DELETE
Description
delete the specified PerconaXtraDBClusterRestore
Query parameters
ParameterTypeDescription
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 responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified PerconaXtraDBClusterRestore
HTTP responses
HTTP codeResponse body
200 - OKPerconaXtraDBClusterRestore schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified PerconaXtraDBClusterRestore
Query parameters
ParameterTypeDescription
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 responses
HTTP codeResponse body
200 - OKPerconaXtraDBClusterRestore schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified PerconaXtraDBClusterRestore
Query parameters
ParameterTypeDescription
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.
Body parameters
ParameterTypeDescription
bodyPerconaXtraDBClusterRestore schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKPerconaXtraDBClusterRestore schema
201 - CreatedPerconaXtraDBClusterRestore schema
401 - UnauthorizedEmpty

/apis/pxc.percona.com/v1/namespaces/{namespace}/perconaxtradbclusterrestores/{name}/status

HTTP method
GET
Description
read status of the specified PerconaXtraDBClusterRestore
HTTP responses
HTTP codeResponse body
200 - OKPerconaXtraDBClusterRestore schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified PerconaXtraDBClusterRestore
Query parameters
ParameterTypeDescription
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 responses
HTTP codeResponse body
200 - OKPerconaXtraDBClusterRestore schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified PerconaXtraDBClusterRestore
Query parameters
ParameterTypeDescription
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.
Body parameters
ParameterTypeDescription
bodyPerconaXtraDBClusterRestore schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKPerconaXtraDBClusterRestore schema
201 - CreatedPerconaXtraDBClusterRestore schema
401 - UnauthorizedEmpty