s3.bucket-remote-copy.set

Turn the remote copy on (every existing object is copied too) or off

PUT /s3/api/buckets/{name}/remote-copyIAM s3:PutBucketRemoteCopyChanges stateDestructive

On by default for new buckets on a storage cluster. While the cluster is unavailable, objects are read from the copy; an object not copied yet, listings and writes answer 503 until it is back (never 404). Off: the copy is deleted after 7 days, and an outage of the cluster makes the bucket answer 503.

Request syntax

PUT /s3/api/buckets/{name}/remote-copy
{
  "enabled": "boolean"
}

Path parameters

  • nameRequired

    string

    Constraints: 3-63 chars, /^[a-z0-9][a-z0-9-]*[a-z0-9]$/

Request body

  • enabledRequired

    boolean

    true: keep a copy of every object in the storage cluster’s other location; false: stop keeping one

Response

200; data is { enabled, available, zone, pendingKeys, failedKeys, note } as saved. 409 when the bucket’s storage has no remote location.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow s3:PutBucketRemoteCopy on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud s3 bucket-remote-copy set name --enabled

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_s3_bucket-remote-copy_set.