Requests that the server creates a logical snapshot in the fusion backend.
The request has:
- Vbucket
- No extras
- No key
- A value (JSON object encoding the arguments)
- datatype must be JSON and client must enable JSON when issuing HELO
The value is a JSON object with a number of fields, detailed below.
If the request is successful the server now holds a logical snapshot and preserves the data files that make that snapshot.
The following keys are accepted input. All keys are mandatory. Any key not shown in the following sections will be ignored.
-
The uuid to assign to the snapshot being created
"snapshotUuid"- The value is a string
-
The temporal validity of the preserved snapshot
"validity"- The value is an unsigned integer
- Timestamp, in seconds
{
"snapshotUuid": "some-snapshot-uuid",
"validity": 123456879
}
On success the response's payload returns a JSON object that contains the following keys:
-
Snapshot creation time
"createdAt"- Timestamp, in milliseconds
-
Log files related to the snapshot
"logFiles"- Timestamp, in milliseconds
-
Log manifest name
"logManifestName"- String
-
The uuid assigned to the created snapshot
"snapshotUUID"- String
-
The validity of the created snapshot
"validTill"- Timestamp, in milliseconds
-
The fusion version
"version"- Unsigned integer
-
The volume id
"volumeID"- String
Status::Einval (0x04)
Input validation failure (e.g. incorrect key length). The returned error context will contain details.
Status::NotMyVbucket (0x07)
Server does not own an active copy of the vbucket.
Status::Einternal (0x84)
This status code is used for unexpected internal failure.
Requests that the server releases a logical snapshot in the fusion backend.
The request has:
- Vbucket
- No extras
- No key
- A value (JSON object encoding the arguments)
- datatype must be JSON and client must enable JSON when issuing HELO
The value is a JSON object, detailed below.
If the request is successful the server now holds a logical snapshot and preserves the data files that make that snapshot.
The following keys are accepted input. All keys are mandatory. Any key not shown in the following sections will be ignored.
- The uuid to of the snapshot being released
"snapshotUuid"- The value is a string
{
"snapshotUuid": "some-snapshot-uuid"
}
The call returns Status::Success, an error code otherwise.
Status::Einval (0x04)
Input validation failure (e.g. incorrect arg format). The returned error context will contain details.
Status::NotMyVbucket (0x07)
Server does not own an active copy of the vbucket.
Status::Einternal (0x84)
This status code is used for unexpected internal failure.
Requests that the server mounts a kvstore for the given vbucket.
The request has:
- Vbucket
- No extras
- No key
- A value (JSON object encoding the arguments)
- datatype must be JSON and client must enable JSON when issuing HELO
The value is a JSON object, detailed below.
If the request is successful the server now holds a logical snapshot and preserves the data files that make that snapshot.
The following keys are accepted input. All keys are mandatory. Any key not shown in the following sections will be ignored.
- The uuid to of the snapshot being released
"mountPaths"- The value is an array of strings
{
"mountPaths": ["path1", "path2"]
}
The call returns Status::Success, an error code otherwise.
Status::Einval (0x04)
Input validation failure (e.g. incorrect arg format). The returned error context will contain details.
Status::Einternal (0x84)
This status code is used for unexpected internal failure.
TODO
Requests that the server forces a flush to disk of the magma write cache for the given vbucket and syncs the data to fusion.
The request has:
- Vbucket
- No extras
- No key
- No value
- datatype must be RAW
The call returns Status::Success, an error code otherwise.
Status::Einval (0x04)
Input validation failure (e.g. incorrect arg format). The returned error context will contain details.
Status::Einternal (0x84)
This status code is used for unexpected internal failure.
Requests that the server starts the Fusion Uploader for the given vbucket. That uploads data to FusionLogStore for the latest revision of the given kvstore. Unreferenced log files are also deleted as part of the upload process, which requires a valid FusionMetadataStore auth token set via SetFusionMetadataStoreAuthToken. The given term must be monotonic. It must be incremented every time the fusion uploader role is reassigned. The term is used to ensure zombie uploaders are fenced and are disallowed from deleting log files from FusionLogStore.
The request has:
- Vbucket
- No extras
- No key
- A value (JSON object encoding the arguments)
- datatype must be JSON and client must enable JSON when issuing HELO
The value is a JSON object, detailed below.
The following keys are accepted input. All keys are mandatory. Any key not shown in the following sections will be ignored.
- The uuid to of the snapshot being released
"term"- The value is a string representation of unsigned int (64bit)
{
"term": "1234"
}
The call returns Status::Success, an error code otherwise.
Status::Einval (0x04)
Input validation failure (e.g. incorrect arg format). The returned error context will contain details.
Status::Einternal (0x84)
This status code is used for unexpected internal failure.
Requests that the server stops the Fusion Uploader for the given vbucket.
The request has:
- Vbucket
- No extras
- No key
- No value
- datatype must be RAW
The call returns Status::Success, an error code otherwise.
Status::Einval (0x04)
Input validation failure (e.g. incorrect arg format). The returned error context will contain details.
Status::Einternal (0x84)
This status code is used for unexpected internal failure.
The command deletes data from the given FusionLogStore and FusionMetadataStore for all Fusion volumes except those that are specified as a parameter to the call.
The request has:
- No extras
- No key
- A value (JSON object encoding the arguments)
- datatype must be JSON and client must enable JSON when issuing HELO
The value is a JSON object with a number of fields, detailed below.
The following keys are accepted input. All keys are mandatory. Any key not shown in the following sections will be ignored.
-
The URI of the Logstore
"logstore_uri"- The value is a string
-
The URI of the Metadatastore
"metadatastore_uri"- The value is a string
-
The Auth token for accessing the Metadatastore
"metadatastore_auth_token"- The value is a string
-
The Fusion namespaces that must be excluded in the deletion
"namespaces"- The value is an array of strings
{
"logstore_uri": "uri1",
"metadatastore_uri": "uri2"
"metadatastore_auth_token": "some-token"
"namespaces": ["namespace-to-preserve", "another-one"]
}
{
"logstore_uri": "uri1",
"metadatastore_uri": "uri2"
"metadatastore_auth_token": "some-token"
"namespaces": []
}
The call returns Status::Success, an error code otherwise.
Status::Einval (0x04)
Input validation failure (e.g. incorrect params format). The returned error context will contain details.
Status::Einternal (0x84)
This status code is used for unexpected internal failure.
To request loading a vbucket from a snapshot, the command is extended from the format in BinaryProtocol.md, which is used for non-snapshot state changes.
The command value (JSON datatype) is extended to include a
"use_snapshot": "fusion" field.
Request:
- MUST have vbucket
- MUST have extra
- MUST NOT have key
- MUST have value
The command contains an extra section of one byte containing the vbucket state:
- Active
- Replica
Response:
- MUST NOT have extras
- MUST NOT have key
- MAY have value (error message)
Status::KeyEexists (0x02)
The node already has this vbucket.
Status::Einval (0x04)
Input validation failure.
Status::Einternal (0x84)
Unexpected internal failure.