hosting

GET `/v1/storage/buckets/{bucketId}`

One bucket.

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز storage.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X GET https://api.zinndigital.com/v1/storage/buckets/{bucketId} \
  -H "Authorization: Bearer zdk_live_…"

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

One bucket belonging to this organisation. Requires `storage.view`.

پارامترها

نام	نوع	الزامی	چیست
`bucketId (path)`	`string`	بله	The bucket's id.

پاسخ

نام	نوع	الزامی	چیست
`id`	`string`	بله	—
`name`	`string`	بله	The customer's own label, not the bucket's name at the vendor.
`ownership`	`string<zinn, customer>`	بله	`zinn` is storage we operate and bill for; `customer` is the organisation's own bucket, which costs us nothing and is not metered against their allowance.
`vendor`	`string<r2, s3, b2, bunny, gcore, minio>`	بله	—
`status`	`string<pending, active, suspended, failed>`	بله	—
`bucket_name`	`string`	بله	—
`endpoint`	`string`	خیر	—
`region`	`string`	خیر	—
`public_base_url`	`string`	خیر	Where a public object is readable. Empty means the bucket is private and its objects are reachable only through a presigned URL.
`bytes_stored`	`integer`	خیر	—
`objects_stored`	`integer`	خیر	—
`usage_measured_at`	`string`	خیر	When the size above was last measured against the vendor. `null` means it has not been measured yet — which is not the same as empty.
`has_credential`	`boolean`	بله	Whether a stored key exists. The key and the Vault path it lives at are deliberately absent from this payload.
`metered`	`boolean`	بله	Whether this bucket's bytes count against `object_storage_gb`.
`created_at`	`string`	خیر	—

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 429

GET /v1/storage/buckets/{bucketId}