Operations: advanceRelocateBucket
Initiates the final synchronization of a bucket relocation operation that requires a write downtime. The server makes a best effort to
proceed with the operation, but success is not guaranteed.
Users can use
Operations: get to check the status of the operation.
Required permissions
You must have the storage.buckets.relocate IAM permission on the bucket to initiate the final synchronization step.
You might also need the following permissions on the bucket:
storage.bucketOperations.get
You need this permission to view the status of the bucket relocation operation.storage.bucketOperations.list
You need this permission to view the list of bucket relocation operations.storage.bucketOperations.cancel
You need this permission to cancel the bucket relocation operation.storage.bucket.get
You need this permission to view the metadata of a bucket during the final synchronization of the bucket relocation operation.
storage.objects.list and storage.objects.get
You need these permissions to view the list of objects in a bucket that you want to relocate to another location.
Request
HTTP request
POST https://storage.s3nsapis.fr/storage/v1/b/bucket/operations/operationId/advanceRelocateBucket
In addition to standard query parameters,
the following query parameters apply to this method.
To see an example of how to include query parameters in a request, see the
JSON API Overview page.
Parameters
| Parameter name |
Value |
Description |
| Path parameters |
bucket |
string |
Name of a bucket.
|
operationId |
string |
The ID of the Buckets: relocate long-running operation that initiated the bucket relocation.
For example, AbCJYd8jKT1n-Ciw1LCNXIcubwvij_TdqO-ZFjuF2YntK0r74
|
Request body
In the request body, supply any one of the following properties:
| Property name |
Value |
Description |
Notes |
| Optional parameters |
ttl |
string |
The Time to live (TTL) for the write downtime phase during a relocation process.
It is expressed as a string, such as 12h for 12 hours. The ttl duration determines
the maximum allowed duration for the write downtime phase. If the write downtime exceeds
this limit, the relocation process automatically reverts to the incremental copy step,
and write operations to the bucket are re-enabled. The value must be within the range of
6h (6 hours) to 48h (48 hours). If not specified, the default value is 12h (12 hours).
|
Writable |
expire_time |
string |
If the final synchronization fails, the expire_time determines how long the process tries before
switching back to the incremental copy step. The format of expire_time is a string in RFC 3339 format, such as 2024-08-15T01:30:15.01Z.
|
Writable |
Response
If successful, this method returns an empty response body.
For information about status and error codes returned by this API, see the
reference page.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Operations: advanceRelocateBucket\n\nInitiates the [final synchronization](/storage/docs/bucket-relocation/relocate-buckets#final-synchronization) of a [bucket relocation operation](/storage/docs/bucket-relocation/overview) that requires a write downtime. The server makes a best effort to\nproceed with the operation, but success is not guaranteed.\n\nUsers can use\n[Operations: get](/storage/docs/json_api/v1/operations/get) to check the status of the operation.\n\nRequired permissions\n--------------------\n\nYou must have the `storage.buckets.relocate` IAM permission on the bucket to initiate the final synchronization step.\n\nYou might also need the following permissions on the bucket:\n\n- `storage.bucketOperations.get` \n You need this permission to view the status of the bucket relocation operation.\n- `storage.bucketOperations.list` \n You need this permission to view the list of bucket relocation operations.\n- `storage.bucketOperations.cancel` \n You need this permission to cancel the bucket relocation operation.\n- `storage.bucket.get` \n You need this permission to view the metadata of a bucket during the [final synchronization](/storage/docs/bucket-relocation/relocate-buckets#final-synchronization) of the bucket relocation operation.\n- `storage.objects.list` and `storage.objects.get` \n You need these permissions to view the list of objects in a bucket that you want to relocate to another location.\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://storage.googleapis.com/storage/v1/b/bucket/operations/operationId/advanceRelocateBucket\n```\n\nIn addition to [standard query parameters](/storage/docs/json_api/v1/parameters#query),\nthe following query parameters apply to this method.\n\nTo see an example of how to include query parameters in a request, see the\n[JSON API Overview](/storage/docs/json_api#query_parameters) page.\n\n### Parameters\n\n### Request body\n\nIn the request body, supply any one of the following properties:\n\nResponse\n--------\n\nIf successful, this method returns an empty response body.\n\nFor information about status and error codes returned by this API, see the\n[reference page](/storage/docs/json_api/v1/status-codes).\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
