b2_copy_part
Copies from an existing B2 file, storing it as a part of a large file which
has already been started (with
b2_start_large_file
).
When calling b2_copy_part
, by default the entire source file will be copied
to the destination. If you wish, you may supply a range
param to only copy
a portion of the source file over.
Request
The upload request is a POST.
Request HTTP Headers
Authorization
required
An account authorization token, obtained from
b2_authorize_account
.
The token must have the writeFiles
capability and the readFiles
capability
if the bucket is private.
Request HTTP Message Body Parameters
sourceFileId
required
The ID of the source file being copied.
largeFileId
required
The ID of the large file the part will belong to, as returned by
b2_start_large_file
.
partNumber
required
A number from 1 to 10000. The parts uploaded for one file must have contiguous numbers, starting with 1.
range
optional
The range of bytes to copy. If not provided, the whole source file will be copied.
sourceServerSideEncryption
optional
If present, specifies the parameters for Backblaze B2 to use for accessing the source file data using Server-Side Encryption. This parameter must be provided only if the source file has been encrypted using Server-Side Encryption with Customer-Managed Keys (SSE-C), and the provided encryption key must match the one with which the source file was encrypted. See. See Server-Side Encryption for details.
destinationServerSideEncryption
optional
If present, specifies the parameters for Backblaze B2 to use for encrypting the copied data before storing the destination file using Server-Side Encryption. This parameter must be provided only if the large file was started with Server-Side Encryption with Customer-Managed Keys (SSE-C), and the provided encryption key must match the one with which the large file was started. See Server-Side Encryption for details.
Response
Response HTTP Status 200
File successfully copied. The JSON response will contain the standard part information. For copied files, the action is always "copy".
fileId
The file ID for uploading this file.
partNumber
Which part this is.
contentLength
The number of bytes stored in the part.
contentSha1
The SHA1 of the bytes stored in the part.
contentMd5
optional
The MD5 of the bytes stored in the part. Not all parts have an MD5 checksum, so this field is optional, and set to null for parts that do not have one.
serverSideEncryption
optional
When the part is encrypted with Server-Side Encryption, the mode ("SSE-B2" or "SSE-C") and algorithm used to encrypt the data.
uploadTimestamp
This is a UTC time when this part was uploaded. It is a base 10 number of milliseconds since midnight, January 1, 1970 UTC. This fits in a 64 bit integer such as the type "long" in the programming language Java. It is intended to be compatible with Java's time long. For example, it can be passed directly into the java call Date.setTime(long time).
Response Errors
File not copied.
If possible the server will return a JSON error structure. Errors include:
status |
code |
description |
---|---|---|
400 |
bad_bucket_id |
The requested bucket ID does not match an existing bucket. |
400 |
bad_request |
The request had the wrong fields or illegal values. The message returned with the error will describe the problem. |
400 |
cannot_delete_non_empty_bucket |
A bucket must be empty before it can be deleted. To delete this bucket, first remove all of the files in the bucket, then try the delete operation again. |
400 |
source_too_large |
The source file being copied is too large. |
401 |
bad_auth_token |
The auth token used is not valid. Call b2_authorize_account again to either get a new one, or an error message describing the problem. |
401 |
expired_auth_token |
The auth token used has expired. Call b2_authorize_account again to get a new one. |
401 |
unauthorized |
The auth token used is valid, but does not authorize this call with these parameters. The capabilities of an auth token are determined by the application key used with b2_authorize_account. |
403 |
access_denied |
The provided customer-managed encryption key is wrong. |
403 |
transaction_cap_exceeded |
Transaction cap exceeded. To increase your cap, sign in to your B2 Cloud Storage account online. Then select the Caps & Alerts link in the B2 Cloud Storage section of the sidebar. |
404 |
not_found |
File is not in B2 Cloud Storage. |
405 |
method_not_allowed |
Only POST is supported |
408 |
request_timeout |
The service timed out reading the uploaded file |
416 |
range_not_satisfiable |
The Range header in the request is valid but cannot be satisfied for the file. |
Sample Code
Code
ACCOUNT_AUTHORIZATION_TOKEN=''; # Provided by b2_authorize_account
API_URL=''; # Provided by b2_authorize_account
SOURCE_FILE_ID=''; # The file you wish to copy
LARGE_FILE_ID=''; # Provided by b2_start_large_file
curl \
-H "Authorization: $ACCOUNT_AUTHORIZATION_TOKEN" \
-d "`printf '{"sourceFileId":"%s","largeFileId":"%s","partNumber":1,"range":"bytes=0-4999999"}' $SOURCE_FILE_ID $LARGE_FILE_ID`" \
"$API_URL/b2api/v2/b2_copy_part";
Output
{
"contentLength": 5000000,
"contentSha1": "e8daf2cae7b77beb23a246aec2c6d3ede06089c9",
"fileId": "LARGE_FILE_ID",
"partNumber": 1,
"uploadTimestamp": 1559581682460
}
Code
import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
public class B2CopyPart {
public static void main(String[] args) throws IOException {
final String apiUrl = ""; // Provided by b2_authorize_account
final String accountAuthorizationToken = ""; // Provided by b2_authorize_account
final String sourceFileId = ""; // The file you wish to copy
final String largeFileId = ""; // Provided by b2_start_large_file
final String partNumber = "1";
final URL url = new URL(apiUrl + "/b2api/v2/b2_copy_part");
final HttpURLConnection connection = (HttpURLConnection) url.openConnection();
try {
connection.setRequestMethod("POST");
connection.setRequestProperty("Authorization", accountAuthorizationToken);
connection.setDoOutput(true);
DataOutputStream writer = new DataOutputStream(connection.getOutputStream());
writer.write((
"{"
+ "\"sourceFileId\": \"" + sourceFileId + "\","
+ "\"largeFileId\": \"" + largeFileId + "\","
+ "\"partNumber\": " + partNumber
+ "}").getBytes(StandardCharsets.UTF_8)
);
final InputStream in = new BufferedInputStream(connection.getInputStream());
final String jsonResponse = inputStreamToString(in);
System.out.println(jsonResponse);
} finally {
connection.disconnect();
}
}
private static String inputStreamToString(InputStream in) throws IOException {
InputStreamReader reader = new InputStreamReader(in);
StringBuilder sb = new StringBuilder();
int c = reader.read();
while (c != -1) {
sb.append((char) c);
c = reader.read();
}
reader.close();
return sb.toString();
}
}
Output
{
"contentLength": 99212871,
"contentSha1": "c604542967a93466d4ed087956753161cfab3f31",
"fileId": "LARGE_FILE_ID",
"partNumber": 1,
"uploadTimestamp": 1559584243788
}
Code
import json
import urllib2
api_url = '' # Provided by b2_authorize_account
account_authorization_token = '' # Provided by b2_authorize_account
source_file_id = '' # The file you wish to copy
large_file_id = '' # Provided by b2_start_large_file
part_number = 1
request = urllib2.Request(
'%s/b2api/v2/b2_copy_part' % api_url,
json.dumps({
'sourceFileId' : source_file_id,
'largeFileId': large_file_id,
'partNumber': part_number,
}),
headers = {
'Authorization': account_authorization_token
})
response = urllib2.urlopen(request)
response_data = json.loads(response.read())
print(json.dumps(response_data, indent=2))
response.close()
Output
{
"uploadTimestamp": 1559585618236,
"contentLength": 99212871,
"fileId": "LARGE_FILE_ID",
"partNumber": 1,
"contentSha1": "c604542967a93466d4ed087956753161cfab3f31"
}
Code
under construction
Output
under construction
Code
under construction
Output
under construction
Code
under construction
Output
under construction
Code
under construction
Output
under construction