راهنماها
در این صفحه

راهنمای محصول

مرجع API

کلودی را با OpenAPI و راهنمای Terraform خودکار کنید؛ API key محدود در تنظیمات بسازید، API کلاستر و شبکه را امن فراخوانی کنید و سکرت را بیرون از سورس کنترل نگه دارید.

برای اسکیمای HTTP قابل خواندن توسط ماشین و ابزار try-it، از مستندات زنده OpenAPI روی API کلودی (رابط Scalar) استفاده کنید. این راهنمای پرتال محصول‌محور است و نشان می‌دهد اتوماسیون چگونه کنار وب‌سایتی که روزانه استفاده می‌کنید قرار می‌گیرد.

API key شخصی را در تنظیمات → API key‌ها بسازید. کلید به سازمانی که هنگام ساخت در پنل انتخاب شده وصل می‌شود و در فراخوانی‌های بعدی هدر X-Organization-ID نادیده گرفته می‌شود. دسترسی در هر درخواست اعمال می‌شود (مثلاً clusters:read در برابر clusters:write). برای کار تعاملی با کلاستر، kubeconfig و برای Terraform یا CI کلید API را ترجیح دهید.

آموزش: آماده‌سازی اتوماسیون

ساخت API key محدود

در پرتال به تنظیمات → API key‌ها → ساخت کلید بروید. حداقل دسترسی لازم را بدهید. رمز را در vault نگه دارید؛ آن را در git، تیکت یا اسکرین‌شات نگذارید.

باز کردن مستندات OpenAPI

از کنترل باز کردن مرجع API در هدر مستندات استفاده کنید، یا مسیر /docs روی میزبان API محیط خود را باز کنید.

فراخوانی API محصولات

منابع رایج شامل کلاستر، منطقه، سایز، VPC، کلید SSH، IP و ولوم است؛ همان محصولاتی که در پنل مدیریت می‌کنید.

راهنمای Terraform

نمونه‌های Terraform در مسیر /docs/terraform روی همان میزبان API قرار دارد.

مرتبط