API مدیریت زیرساخت فضای ابری

مستندات زیر شامل API اختصاصی پارس‌پک برای مدیریت سرویس‌های فضای ابری، اتوماسیون فرایند سفارش باکت و مشاهده وضعیت سرویس‌ها است. اگر قصد آپلود، دانلود یا مدیریت داده‌ها درون باکت را دارید، نیازی به این API نیست و باید از طریق استاندارد S3 و کلاینت‌ها اقدام کنید. برای این منظور مقاله «نحوه اتصال به فضای ابری» را مطالعه کنید.

احراز هویت (Authentication)

برای ارسال درخواست‌ها به API مدیریت زیرساخت، به کلید احراز هویت (Bearer Token) نیاز دارید.

برای دریافت این کلید، یک تیکت به دپارتمان پشتیبانی پارس‌پک ارسال کنید. پس از دریافت کلید، آن را در هدر تمام درخواست‌های خود با فرمت زیر قرار دهید:

Authorization: Bearer {YOUR_AUTH_KEY}

Content-Type: application/json

Accept: application/json

مستندات فنی

برای مشاهده ساختار دقیق بدنه درخواست‌ها و مستندات تکمیلی APIها، به لینک زیر مراجعه کنید:

مشاهده API کلاد استوریج

لیست مسیرها (Endpoints)

۱. سفارش باکت جدید (New Bucket)

ثبت سفارش جدید برای ایجاد باکت فضای ابری.

• متد: POST

• مسیر: external/api/v2/buckets

پارامترهای بدنه (Body Parameters):

نام پارامتر	نوع داده	وضعیت	توضیحات و مقادیر مجاز
title	string	الزامی	نام باکت
type	string	الزامی	سطح دسترسی باکت. مقادیر مجاز: public, private
service_id	integer	الزامی	شناسه سایز پلن انتخابی (قابل دریافت از مسیر Order Options)
location	string	الزامی	موقعیت سرور. مقدار مجاز: iran
service_cycle	string	الزامی	دوره مالی سفارش. مقادیر مجاز: monthly, quarterly, semiannually, annually
promotion_code	string	اختیاری	کد تخفیف برای اعمال روی سفارش

۲. دریافت گزینه‌های سفارش (Order Options)

دریافت لیست پلن‌ها و شناسه‌های (service_id) مجاز برای سفارش باکت جدید.

• متد: GET

• مسیر: external/api/v2/buckets/order-options

۳. بررسی وضعیت سفارش (Order Status)

پیگیری وضعیت سفارشی که ثبت شده است.

• متد: GET

• مسیر: external/api/v2/buckets/order-status/{id}

پارامترهای مسیر (URL Parameters):

• id (string): شناسه سفارش (Order ID)

۴. دریافت لیست باکت‌های کاربر (Names)

دریافت نام و لیست تمام باکت‌هایی که متعلق به حساب کاربری است.

• متد: GET

• مسیر: external/api/v2/buckets/names

۵. دریافت جزئیات یک باکت (Bucket Details)

مشاهده جزئیات و مشخصات یک باکت خاص.

• متد: GET

• مسیر: external/api/v2/buckets/{name}

پارامترهای مسیر (URL Parameters):

• name (string): نام باکت (مثال: c123456)

۶. دریافت لیست باکت‌های قابل سفارش (List)

• متد: GET

• مسیر: external/api/v2/buckets

پارامترهای جستجو (Query Parameters):

نام پارامتر	نوع داده	وضعیت	توضیحات
per_page	integer	اختیاری	تعداد آیتم‌ها در هر صفحه (مقدار پیش‌فرض: ۱۰)
page	integer	اختیاری	شماره صفحه مورد نظر برای صفحه‌بندی