API | Operation | Description |
Restoring an archived object | Restores an archived object for access. |
POST Object restore
API is used to restore an archived COS object. The restored readable object is a temporary copy, for which you can set the readable status and the time to delete it through the Days
parameter. If the time has elapsed and you haven't initiated a copy or extension operation, the temporary object will be automatically deleted. Temporary objects are only copies of the archived objects which always exist.cos.restoreObject({Bucket: 'examplebucket-1250000000', /* Your bucket (required) */Region: 'COS_REGION', /* Bucket region (required), such as ap-beijing */Key: '1.jpg', /* Object key stored in the bucket (required), such as `1.jpg` and `a/b/test.txt`. */RestoreRequest: {Days: 1,CASJobParameters: {Tier: 'Expedited'}},}, function(err, data) {console.log(err || data);});
Parameter | Description | Type | Required |
Bucket | Bucket name in the format of BucketName-APPID . | String | Yes |
Region | String | Yes | |
Key | Object key (object name), which is the unique identifier of an object in a bucket. For more information, see Object Overview. | String | Yes |
RestoreRequest | Container for data restoration | Object | Yes |
- Days | Expiration time of the temporary copy | Number | Yes |
- CASJobParameters | Container for archive job parameters | Object | Yes |
- - Tier | Restoration mode. The following three restoration modes are supported for the ARCHIVE storage class: Standard: Restores an object within 3–5 hours. Expedited: Restores an object within 15 minutes. Bulk: Restores an object within 5–12 hours. The following two restoration modes are supported for the DEEP ARCHIVE storage class: Standard: Restores an object within 12–24 hours. Bulk: Restores an object within 24–48 hours. | String | Yes |
function(err, data) { ... }
Parameter | Description | Type |
err | The object returned when an error (network error or service error) occurs. If the request is successful, this parameter is empty. For more information, see Error Codes. | Object |
- statusCode | Returned HTTP status code, such as 200 , 403 , and 404 . | Number |
- headers | Returned headers | Object |
data | The object returned when the request is successful. If an error occurs with the request, this parameter is empty. | Object |
- statusCode | Returned HTTP status code, such as 200 , 403 , and 404 . | Number |
- headers | Returned headers | Object |
Was this page helpful?