s3.buckets.get

One bucket with its path-style and virtual-hosted URLs

GET /s3/api/buckets/{name}IAM s3:GetBucketRead

Request syntax

GET /s3/api/buckets/{name}

Path parameters

  • nameRequired

    string

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

Response

200; data is the bucket: id, name, zone, region, storage, objectLock, encryption, replicating, public, websiteUrl, pathStyleUrl, virtualHostedUrl, managedBy and createdAt.

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:GetBucket 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 buckets get name

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_s3_buckets_get.