Resuming a Failed Copy Task
Function
You can use this command to resume a failed copy task based on the task ID.
Command Line Structure
- In Windows
obsutil cp -recover=xxx [-dryRun] [-f] [-u] [-crr] [-vlength] [-vmd5] [-j=1] [-p=1] [-threshold=52428800] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx] [-timeRange=time1-time2] [-mf] [-o=xxx] [-cpd=xxx] [-clear] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]
- In Linux or macOS
./obsutil cp -recover=xxx [-dryRun] [-f] [-u] [-crr] [-vlength] [-vmd5] [-j=1] [-p=1] [-threshold=52428800] [-acl=xxx] [-sc=xxx] [-meta=aaa:bbb#ccc:ddd] [-ps=auto] [-include=*.xxx] [-exclude=*.xxx] [-timeRange=time1-time2] [-mf] [-o=xxx] [-cpd=xxx] [-clear] [-config=xxx] [-e=xxx] [-i=xxx] [-k=xxx] [-t=xxx]
Examples
- Take the Windows OS as an example. Run the obsutil cp -recover=0476929d-9d23-4dc5-b2f8-0a0493f027c5 -f command to copy objects in batches.
obsutil cp -recover=0476929d-9d23-4dc5-b2f8-0a0493f027c5 -f Parallel: 3 Jobs: 3 Threshold: 524288000 PartSize: 5242880 Exclude: Include: VerifyLength: false VerifyMd5: false CheckpointDir: xxxx OutputDir: xxxx [=============================================================] 100.00% 10/s 0s Succeed count is: 1 Failed count is: 0 Metrics [max cost:298 ms, min cost:192 ms, average cost:238.00 ms, average tps:9.71] Task id is: f4c4f2b6-6e54-4dff-96b8-52e8c8c9a4b0
Parameter Description
Parameter |
Optional or Mandatory |
Description |
---|---|---|
recover |
Mandatory (additional parameter) |
ID of the copy task to be resumed.
NOTE:
|
dryRun |
Optional (additional parameter) |
Conducts a dry run. |
crr |
Optional (additional parameter) |
Enables the client-side cross-region replication function. In this mode, data is directly copied to the destination bucket from the source bucket through data stream. The buckets can by any two OBS buckets.
NOTE:
NOTICE:
When cross-region replication is enabled, the upload/download bandwidth, CPU, and memory resources of the host where commands are executed will be occupied, which may deteriorate the host performance. |
vlength |
Optional (additional parameter) |
Verifies whether the object size in the destination bucket is the same as that in the source bucket after the copy task completes.
NOTE:
This parameter must be used together with crr. |
vmd5 |
Optional (additional parameter) |
Verifies whether the MD5 value of the destination bucket is the same as that of the source bucket after the copy task completes.
NOTE:
|
u |
Optional (additional parameter) |
Indicates incremental copy. If this parameter is set, each object can be copied only when it does not exist in the destination bucket, its size is different from the namesake one in the destination bucket, or it has the latest modification time.
CAUTION:
When you compare each local file with data in the bucket, a billable HEAD request is generated. For details, see Requests. |
p |
Optional (additional parameter) |
Indicates the maximum number of concurrent multipart copy tasks when copying an object. The default value is the value of defaultParallels in the configuration file. |
threshold |
Optional (additional parameter) |
Indicates the threshold for enabling multipart copy, in bytes. The default value is the value of defaultBigfileThreshold in the configuration file.
NOTE:
|
acl |
Optional (additional parameter) |
Access control policies for destination objects that can be specified when copying objects. Possible values are:
NOTE:
The preceding three values indicate private read and write, public read, and public read and write. |
sc |
Optional (additional parameter) |
Storage classes of the destination objects that can be specified when copying objects. Possible values are:
|
meta |
Optional (additional parameter) |
Metadata of destination objects that can be specified when copying objects. This parameter should be configured in the following format: key1:value1#key2:value2#key3:value3.
NOTE:
The format example above indicates that the destination objects contain three groups of custom metadata: key1:value1, key2:value2, and key3:value3. |
ps |
Optional (additional parameter) |
Indicates the size of each part in a multipart copy task, in bytes. The value ranges from 100KB to 5GB. The default value is the value of defaultPartSize in the configuration file.
NOTE:
|
cpd |
Optional (additional parameter) |
Indicates the folder where the part records reside. The default value is .obsutil_checkpoint, the subfolder in the home directory of the user who executes obsutil commands.
NOTE:
A part record is generated during a multipart copy and saved to the copy subfolder. After the copy succeeds, its part record is deleted automatically. If the copy fails or is suspended, the system attempts to resume the task according to its part record when you perform the copy the next time. |
f |
Optional (additional parameter) |
Runs in force mode. |
j |
Optional (additional parameter) |
Indicates the maximum number of concurrent tasks for copying objects in batches. The default value is the value of defaultJobs in the configuration file.
NOTE:
The value is ensured to be greater than or equal to 1. |
exclude |
Optional (additional parameter) |
Indicates the matching patterns of source objects that are excluded, for example: *.txt.
NOTE:
NOTICE:
|
include |
Optional (additional parameter) |
Indicates the matching patterns of source objects that are included, for example: *.jpg.
NOTE:
NOTICE:
|
timeRange |
Optional (additional parameter) |
Indicates the time range matching pattern when copying objects. Only objects whose latest modification time is within the configured time range are copied. This pattern has a lower priority than the object matching patterns (exclude/include). That is, the time range matching pattern is executed after the configured object matching patterns.
NOTE:
NOTICE:
|
mf |
Optional (additional parameter) |
Indicates that the name matching pattern (include or exclude) and the time matching pattern (timeRange) also take effect on objects whose names end with a slash (/). |
o |
Optional (additional parameter) |
Indicates the folder where operation result lists reside. After the command is executed, result lists (possibly including success, failure, and warning files) are generated in the folder. The default value is .obsutil_output, the subfolder in the home directory of the user who executes obsutil commands.
NOTE:
|
clear |
Optional (additional parameter) |
Deletes the failure result files after the copy task is resumed. |
config |
Optional (additional parameter) |
User-defined configuration file for executing a command. For details about parameters that can be configured, see Parameter Description. |
e |
Optional (additional parameter) |
Specifies the endpoint. |
i |
Optional (additional parameter) |
Specifies the user's AK. |
k |
Optional (additional parameter) |
Specifies the user's SK. |
t |
Optional (additional parameter) |
Specifies the user's security token. |
Response
Refer to Response for uploading an object.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.