> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-detect-table-modification.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickHouse Cloud واجهة برمجة تطبيقات

> تعرّف على ClickHouse Cloud واجهة برمجة تطبيقات

<div id="overview">
  ## نظرة عامة
</div>

تُعد ClickHouse Cloud API واجهة برمجة تطبيقات REST صُممت للمطورين لتسهيل إدارة
المؤسسات والخدمات على ClickHouse Cloud. وباستخدام Cloud API الخاصة بنا، يمكنك
إنشاء الخدمات وإدارتها، وإنشاء مفاتيح API، وإضافة أعضاء إلى
مؤسستك أو إزالتهم، وغير ذلك الكثير.

[تعرّف على كيفية إنشاء أول مفتاح API والبدء في استخدام ClickHouse Cloud API.](/ar/products/cloud/features/admin-features/api/openapi)

<div id="swagger-openapi-endpoint-and-ui">
  ## نقطة نهاية Swagger (OpenAPI) وواجهة المستخدم
</div>

تم إنشاء واجهة برمجة تطبيقات ClickHouse Cloud استنادًا إلى مواصفة [OpenAPI المفتوحة المصدر](https://www.openapis.org/)
لضمان إمكانية استهلاكها من جانب العميل بشكل متوقَّع. إذا كنت بحاجة إلى
استهلاك وثائق واجهة برمجة تطبيقات ClickHouse Cloud برمجيًا، فنحن نوفر نقطة نهاية Swagger
بصيغة JSON عبر [https://api.clickhouse.cloud/v1](https://api.clickhouse.cloud/v1). ويمكنك أيضًا العثور على وثائق واجهة برمجة تطبيقات عبر
[واجهة مستخدم Swagger](/ar/products/cloud/api-reference/organization/get-list-of-available-organizations).

<Note>
  إذا كانت مؤسستك قد نُقلت إلى إحدى [خطط التسعير الجديدة](https://clickhouse.com/pricing?plan=scale\&provider=aws\&region=us-east-1\&hours=8\&storageCompressed=false)، وكنت تستخدم OpenAPI، فسيتعين عليك إزالة الحقل `tier` من طلب `POST` الخاص بإنشاء الخدمة.

  تمت إزالة الحقل `tier` من كائن الخدمة لأننا لم نعد نعتمد فئات للخدمة.
  سيؤثر ذلك في الكائنات التي تُرجعها طلبات الخدمة `POST` و`GET` و`PATCH`. لذلك، قد يلزم تعديل أي شيفرة تستهلك واجهات برمجة التطبيقات هذه للتعامل مع هذه التغييرات.
</Note>

<div id="rate-limits">
  ## حدود المعدل
</div>

يُسمح للمطورين بما يصل إلى 100 مفتاح API لكل مؤسسة. ولكل مفتاح API
حد أقصى يبلغ 10 طلبات خلال نافذة مدتها 10 ثوانٍ. إذا كنت ترغب في زيادة
عدد مفاتيح API أو عدد الطلبات لكل نافذة مدتها 10 ثوانٍ في مؤسستك،
فيرجى التواصل مع [support@clickhouse.com](mailto:support@clickhouse.com)

<div id="terraform-provider">
  ## موفّر Terraform
</div>

يتيح لك موفّر Terraform الرسمي من ClickHouse استخدام [البنية التحتية بوصفها شيفرة](https://www.redhat.com/en/topics/automation/what-is-infrastructure-as-code-iac)
لإنشاء تهيئات قابلة للتنبؤ وخاضعة للتحكم في الإصدارات، مما يجعل عمليات النشر
أقل عرضةً للأخطاء بكثير.

يمكنك الاطلاع على وثائق موفّر Terraform في [سجل Terraform](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs).

إذا كنت ترغب في المساهمة في موفّر Terraform الخاص بـ ClickHouse، فيمكنك الاطلاع
على المصدر [في مستودع GitHub](https://github.com/ClickHouse/terraform-provider-clickhouse).

<Note>
  إذا كانت مؤسستك قد رُحّلت إلى إحدى [خطط التسعير الجديدة](https://clickhouse.com/pricing?plan=scale\&provider=aws\&region=us-east-1\&hours=8\&storageCompressed=false)، فسيتعيّن عليك استخدام [موفّر Terraform من ClickHouse](https://registry.terraform.io/providers/ClickHouse/clickhouse/latest/docs) بالإصدار 2.0.0 أو أحدث. وهذه الترقية مطلوبة للتعامل مع التغييرات في السمة `tier` الخاصة بالخدمة، إذ بعد ترحيل التسعير، لم يعد الحقل `tier` مقبولًا ويجب إزالة أي إشارات إليه.

  ستتمكن الآن أيضًا من تحديد الحقل `num_replicas` كخاصية ضمن مورد الخدمة.
</Note>

<div id="terraform-provider-releases">
  ## إصدارات موفّر Terraform
</div>

توفّر ClickHouse موفّرَين رسميَّين لـ Terraform - موفّر ClickHouse Cloud للبنية التحتية السحابية وموفّر DBops للكائنات على مستوى قاعدة البيانات. وكلاهما يتّبع نموذج الإصدار نفسه.

<div id="ga-vs-beta-resources">
  ### موارد GA مقابل Beta
</div>

كل إصدار هو build واحد يضم جميع الموارد. وتُشحن موارد الميزات التي لم تصل بعد إلى مرحلة التوافر العام إلى جانب موارد GA، مع تمييزها بأنها **beta** — فلا يوجد build منفصل ولا يلزم تثبيت أي شيء لاستخدامها.

يُشار إلى مورد beta في موضعين:

* **عند plan وapply**، على شكل تحذير `Beta Resource`. لا يتعطل Terraform بسبب التحذيرات، لذا يستمر التنفيذ بشكل طبيعي.
* **في وثائقه**، عبر تنبيه ينص على "هذا المورد في beta".

تعني Beta أن المخطط والسلوك قد يتغيران في إصدار موفّر مستقبلي. أما كل ما لا يحمل هذا الوسم فهو GA ومشمول بضمانات التوافق المعتادة.

<Note>
  قبل v3.25.2، كان الموفّر يميّز هذه الموارد بأنها *alpha* بدلًا من *beta*، وكان تحذير وقت plan يعرض `Alpha Resource`. تغيّرت الصياغة فقط — ولا تتضمن العملية أي migration للمخطط أو السلوك أو الحالة — لكن الأدوات التي تبحث في مخرجات plan عن `Alpha Resource` ستتوقف عن العثور على مطابقات بصمت. كما كانت الإصدارات السابقة تنشر build منفصلًا لـ alpha.
</Note>

<div id="versioning">
  ### إدارة الإصدارات
</div>

يستخدم كلا الموفّرين نظام الإصدارات الدلالية (MAJOR.MINOR.PATCH). ويُزاد رقم الإصدار الرئيسي عند حدوث تغييرات غير متوافقة، ورقم الإصدار الثانوي عند إضافة ميزات أو موارد جديدة، ورقم إصدار التصحيحات عند إصلاح العيوب. وتُطرح الإصدارات عند الحاجة بدلًا من اتباع جدول زمني ثابت.

تسبق الإصدارات ذات اللاحقة `-alphaN` (مثل `3.15.0-alpha3`) نموذج الإصدار ذي البنية الواحدة. وتظل متاحة، لكنها لم تعد تُنتج.

<div id="promotion">
  ### الترقية من Beta إلى GA
</div>

عندما تصل ميزة إلى التوافر العام، يُزال وسم Beta من موردها في الإصدار التالي من الموفّر: يتوقف ظهور التحذير عند إنشاء plan، وتُزال الملاحظة من الوثائق. ولا يتغير أي شيء آخر — لا تعديلات على الإعدادات، ولا ترحيل للحالة، ولا تبديل بين الإصدارات المجمّعة.

<div id="terraform-and-openapi-new-pricing---replica-settings-explained">
  ## Terraform وOpenAPI للتسعير الجديد: شرح إعدادات النسخ المتماثلة
</div>

يكون العدد الافتراضي للنسخ المتماثلة التي تُنشأ لكل خدمة هو 3 في مستويَي Scale وEnterprise، بينما يكون 1 في مستوى Basic.
وفي مستويَي Scale وEnterprise، يمكن تعديل هذا العدد بتمرير الحقل `numReplicas` في طلب إنشاء الخدمة.
يجب أن تكون قيمة الحقل `numReplicas` بين 2 و20 بالنسبة إلى الخدمة الأولى في مستودع. أما الخدمات التي تُنشأ في مستودع حالي، فيمكن أن يكون عدد النسخ المتماثلة فيها منخفضًا حتى 1.

<div id="support">
  ## الدعم
</div>

نوصي بزيارة [قناة Slack الخاصة بنا](https://clickhouse.com/slack) أولًا للحصول على دعم سريع. وإذا
كنت ترغب في الحصول على مساعدة إضافية أو مزيد من المعلومات حول واجهة برمجة التطبيقات وإمكاناتها،
فيرجى التواصل مع ClickHouse Support عبر [https://console.clickhouse.cloud/support](https://console.clickhouse.cloud/support)