DBService | API reference | Red Hat Advanced Cluster Security for Kubernetes 4.5

CancelRestoreProcess

DELETE /v1/db/restore/{id}

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Name

Description

Required

Default

Pattern

null

Return Type

Object

Content Type

application/json

Responses

Table 1. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	`Object`
0	An unexpected error response.	RuntimeError

Samples

GetActiveRestoreProcess

GET /v1/db/restore

Description

Parameters

Return Type

V1GetActiveDBRestoreProcessResponse

Content Type

application/json

Responses

Table 2. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetActiveDBRestoreProcessResponse
0	An unexpected error response.	RuntimeError

Samples

GetExportCapabilities

GET /v1/db/exportcaps

Description

Parameters

Return Type

V1GetDBExportCapabilitiesResponse

Content Type

application/json

Responses

Table 3. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetDBExportCapabilitiesResponse
0	An unexpected error response.	RuntimeError

Samples

InterruptRestoreProcess

POST /v1/db/interruptrestore/{processId}/{attemptId}

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
processId		X	null
attemptId		X	null

Name

Description

Required

Default

Pattern

processId

null

attemptId

null

Return Type

V1InterruptDBRestoreProcessResponse

Content Type

application/json

Responses

Table 4. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1InterruptDBRestoreProcessResponse
0	An unexpected error response.	RuntimeError

Samples

Common object reference

DBExportManifestEncodingType

The encoding of the file data in the restore body, usually for compression purposes.

Enum Values
UNKNOWN
UNCOMPREESSED
DEFLATED

Enum Values

UNKNOWN

UNCOMPREESSED

DEFLATED

DBRestoreProcessStatusResumeInfo

Field Name	Required	Nullable	Type	Description	Format
pos			String		int64

Field Name

Required

Nullable

Type

Description

Format

pos

String

int64

DBRestoreRequestHeaderLocalFileInfo

LocalFileInfo provides information about the file on the local machine of the user initiating the restore process, in order to provide information to other users about ongoing restore processes.

Field Name	Required	Nullable	Type	Description	Format
path			String	The full path of the file.
bytesSize			String	The size of the file, in bytes. 0 if unknown.	int64

Field Name

Required

Nullable

Type

Description

Format

path

String

The full path of the file.

bytesSize

String

The size of the file, in bytes. 0 if unknown.

int64

ProtobufAny

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON representation

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

Field Name Required Nullable Type Description Format

Field Name	Required	Nullable	Type	Description	Format
typeUrl			String	A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
value			byte[]	Must be a valid serialized protocol buffer of the above specified type.	byte

typeUrl

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

value

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

RuntimeError

Field Name

Required

Nullable

Type

Description

Format

error

String

code

Integer

int32

message

String

details

List of ProtobufAny

V1DBExportFormat

DBExportFormat describes a format (= a collection of files) for the database export.

Field Name

Required

Nullable

Type

Description

Format

formatName

String

files

List of V1DBExportFormatFile

V1DBExportFormatFile

Field Name

Required

Nullable

Type

Description

Format

name

String

optional

Boolean

V1DBExportManifest

A DB export manifest describes the file contents of a restore request. To prevent data loss, a manifest is always interpreted as binding, i.e., the server must ensure that it will read and make use of every file listed in the manifest, otherwise it must reject the request.

Field Name

Required

Nullable

Type

Description

Format

files

List of V1DBExportManifestFile

V1DBExportManifestFile

A single file in the restore body.

Field Name	Type	Description	Format
name	String	The name of the file. This may or may not be a (relative) file path and up to the server to interpret. For databases exported as ZIP files, this is the path relative to the root of the archive.
encoding	DBExportManifestEncodingType		UNKNOWN, UNCOMPREESSED, DEFLATED,
encodedSize	String		int64
decodedSize	String		int64
decodedCrc32	Long	The CRC32 (IEEE) checksum of the decoded(!) data.	int64

Field Name

Required

Nullable

Type

Description

Format

name

String

The name of the file. This may or may not be a (relative) file path and up to the server to interpret. For databases exported as ZIP files, this is the path relative to the root of the archive.

encoding

DBExportManifestEncodingType

UNKNOWN, UNCOMPREESSED, DEFLATED,

encodedSize

String

int64

decodedSize

String

int64

decodedCrc32

Long

The CRC32 (IEEE) checksum of the decoded(!) data.

int64

V1DBRestoreProcessMetadata

The metadata of an ongoing or completed restore process. This is the static metadata, which will not change (i.e., it is not a status).

Field Name

Required

Nullable

Type

Description

Format

String

An ID identifying the restore process. Auto-assigned.

header

V1DBRestoreRequestHeader

startTime

Date

The time at which the restore process was started.

date-time

initiatingUserName

String

The user who initiated the database restore process.

V1DBRestoreProcessStatus

Field Name

Required

Nullable

Type

Description

Format

metadata

V1DBRestoreProcessMetadata

attemptId

String

state

V1DBRestoreProcessStatusState

UNKNOWN, NOT_STARTED, IN_PROGRESS, PAUSED, COMPLETED,

resumeInfo

DBRestoreProcessStatusResumeInfo

error

String

bytesRead

String

int64

filesProcessed

String

int64

V1DBRestoreProcessStatusState

Enum Values
UNKNOWN
NOT_STARTED
IN_PROGRESS
PAUSED
COMPLETED

Enum Values

UNKNOWN

NOT_STARTED

IN_PROGRESS

PAUSED

COMPLETED

V1DBRestoreRequestHeader

Field Name

Required

Nullable

Type

Description

Format

formatName

String

The name of the database export format. Mandatory.

manifest

V1DBExportManifest

localFile

DBRestoreRequestHeaderLocalFileInfo

V1GetActiveDBRestoreProcessResponse

Field Name

Required

Nullable

Type

Description

Format

activeStatus

V1DBRestoreProcessStatus

V1GetDBExportCapabilitiesResponse

Field Name

Required

Nullable

Type

Description

Format

formats

List of V1DBExportFormat

supportedEncodings

List of DBExportManifestEncodingType

V1InterruptDBRestoreProcessResponse

Field Name

Required

Nullable

Type

Description

Format

resumeInfo

DBRestoreProcessStatusResumeInfo