وثائق أصول Core

توثيق محرك حالة العالم الحتمي ومراجع API.

وثائق بوابة القرار

كتابة نقاط النهاية

اكتب عمليات الـ daemon (المعاملات والتعديلات)

نقاط النهاية

GET /v1/write/health

الملخص: OpenAPI بيانات التعريف لصحة عملية الكتابة.

معرف العملية: health_endpoint

الردود

الحالةالوصفالمخطط
200حالة صحة عملية الكتابةHealthResponse
503فشلت فحوصات الصحةProblemDetails

GET /v1/write/livez

الملخص: OpenAPI بيانات التعريف لعملية التحقق من حيوية خادم الكتابة.

معرّف العملية: livez_endpoint

الردود

الحالةالوصفالمخطط
200اختبار حيوية عملية الكتابةProbeResponse
503عملية الكتابة غير نشطةProblemDetails

GET /v1/write/namespaces

ملخص: OpenAPI بيانات التعريف لقائمة المساحات الاسمية.

معرّف العملية: list_namespaces_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
limitاستعلاملاعدد صحيحالحد الأقصى لعدد العناصر التي سيتم إرجاعها.
page_tokenاستعلاملاPageTokenرمز التصفح غير الشفاف للصفحة التالية.
tenant_idاستعلاملاTenantIdفلتر مستأجر اختياري.
owner_principal_idاستعلاملاPrincipalIdفلتر رئيسي للمالك اختياري.
policy_classاستعلاملاPolicyClassفلتر فئة السياسة اختياري.
lifecycleاستعلاملاLifecycleStateفلتر دورة الحياة اختياري.
write_modeاستعلاملاNamespaceWriteModeفلتر وضع الكتابة اختياري.
drainingاستعلاملاbooleanفلتر التفريغ اختياري.
frozenاستعلاملاbooleanفلتر المجمد اختياري.
include_deletedاستعلاملاbooleanتضمين المساحات الاسمية المحذوفة عند الصحة.

الردود

الحالةالوصفالمخطط
200قائمة المساحات الاسميةNamespaceListResponse
401طلب غير مصرح بهProblemDetails
404المساحة الاسمية غير موجودةProblemDetails
429تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces

ملخص: OpenAPI بيانات التعريف لإنشاء مساحات الأسماء.

معرّف العملية: create_namespace_endpoint

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: NamespaceCreateRequest

الردود

الحالةالوصفالمخطط
200تم إنشاء مساحة الأسماء أو أنها موجودة بالفعلNamespaceCreateResponse
400معرف مساحة الأسماء غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404مساحة الأسماء غير موجودةProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

DELETE /v1/write/namespaces/{namespace_id}

ملخص: OpenAPI بيانات التعريف لحذف المساحات الاسمية.

معرّف العملية: delete_namespace_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

الردود

الحالةالوصفالمخطط
200تم حذف مساحة الأسماءNamespaceDeleteResponse
400معرف مساحة الأسماء غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404مساحة الأسماء غير موجودةProblemDetails
412مساحة الأسماء تحتوي على موارد مرتبطةProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

GET /v1/write/namespaces/{namespace_id}

ملخص: OpenAPI بيانات التعريف لجلب بيانات تعريف مساحة الأسماء.

معرف العملية: get_namespace_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

الردود

الحالةالوصفالمخطط
200بيانات التعريف الخاصة بالنطاقNamespaceGetResponse
400معرف نطاق غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404النطاق غير موجودProblemDetails
429تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

PATCH /v1/write/namespaces/{namespace_id}

ملخص: OpenAPI بيانات التعريف لتحديث بيانات تعريف مساحة الأسماء.

معرّف العملية: update_namespace_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: NamespaceUpdateRequest

الردود

الحالةالوصفالمخطط
200تم تحديث مساحة الأسماءNamespaceUpdateResponse
400معرف مساحة الأسماء غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404مساحة الأسماء غير موجودةProblemDetails
412فشل شرط المراجعةProblemDetails
429تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespace_id}/commit

الملخص: OpenAPI بيانات التعريف لتقديم الالتزام.

معرّف العملية: commit_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • Schema: CommitRequest

الردود

الحالةالوصفالمخطط
200تم قبول الالتزامCommitResponse
400حمولة الالتزام غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الأسماءProblemDetails
409تم إعادة استخدام مفتاح الاستقرارية مع حمولة مختلفةProblemDetails
422فشل التحقق من الالتزامProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespace_id}/commit/preflight

الملخص: OpenAPI بيانات التعريف لعملية التحقق المسبق للالتزام.

معرّف العملية: commit_preflight_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • Schema: CommitRequest

الردود

الحالةالوصفالمخطط
200نتيجة التحقق من الالتزامPreflightCommitResponse
400حمولة الالتزام غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الأسماءProblemDetails
422فشل التحقق من الالتزامProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespaceid}/commits/{commitid}/reverse

الملخص: OpenAPI بيانات التعريف لعمليات الالتزام العكسي.

معرف العملية: reverse_commit_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف مساحة الاسم
commit_idمسارنعمسلسلةمعرف الالتزام

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: ReverseCommitRequest

الردود

الحالةالوصفالمخطط
200تم تطبيق الالتزام العكسيReverseCommitResponse
400حمولة الالتزام العكسي غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404الالتزام غير موجودProblemDetails
409فشل شرط الالتزام العكسيProblemDetails
410الالتزام العكسي لم يعد متاحًاProblemDetails
422فشل التحقق من الالتزام العكسيProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespace_id}/lifecycle

ملخص: OpenAPI بيانات التعريف لتحديث دورة حياة مساحة الأسماء.

معرّف العملية: namespace_lifecycle_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: NamespaceLifecycleRequest

الردود

الحالةالوصفالمخطط
200تم تحديث دورة حياة مساحة الأسماءNamespaceLifecycleResponse
400معرف مساحة الأسماء غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404مساحة الأسماء غير موجودةProblemDetails
412فشل شرط المراجعةProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespaceid}/operationalstate

ملخص: OpenAPI بيانات التعريف لتحديث حالة تشغيل مساحة الأسماء.

معرّف العملية: namespace_operational_state_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: NamespaceOperationalStateRequest

الردود

الحالةالوصفالمخطط
200تم تحديث حالة التشغيل للمساحة الاسميةNamespaceOperationalStateResponse
400معرف مساحة اسم غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الاسمProblemDetails
412فشل شرط المراجعةProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespace_id}/placement

الملخص: OpenAPI بيانات التعريف لتحديث موضع مساحة الأسماء.

معرّف العملية: namespace_placement_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: NamespacePlacementRequest

الردود

الحالةالوصفالمخطط
200تم تحديث موضع مساحة الأسماءNamespacePlacementResponse
400معرف مساحة الأسماء غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404مساحة الأسماء غير موجودةProblemDetails
412فشل شرط المراجعةProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespaceid}/registerclass

الملخص: OpenAPI بيانات التعريف لتسجيل الفصول.

معرف العملية: register_class_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: RegisterClassRequest

الردود

الحالةالوصفالمخطط
200تم تسجيل الفصلRegisterClassResponse
400حمولة الطلب غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الأسماءProblemDetails
409الفصل موجود بالفعلProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespaceid}/registerclasscontinuousshape_1d

الملخص: OpenAPI بيانات التعريف لتسجيل شكل الفئة المستمر 1D.

معرّف العملية: register_class_continuous_shape_1d_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: RegisterClassContinuousShape1dRequest

الردود

الحالةالوصفالمخطط
200تم تسجيل شكل الفئة المستمر 1DRegisterClassContinuousShape1dResponse
400حمولة الطلب غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الأسماءProblemDetails
409شكل الفئة موجود بالفعلProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespaceid}/registerclasscontinuousshape_2d

الملخص: OpenAPI بيانات التعريف لتسجيل شكل الفئة المستمر ثنائي الأبعاد.

معرّف العملية: register_class_continuous_shape_2d_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: RegisterClassContinuousShape2dRequest

الردود

الحالةالوصفالمخطط
200تم تسجيل شكل الفئة المستمر ثنائي الأبعادRegisterClassContinuousShape2dResponse
400حمولة الطلب غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الأسماءProblemDetails
409شكل الفئة موجود بالفعلProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/{namespaceid}/registerclass_shape

الملخص: OpenAPI بيانات التعريف لتسجيل شكل الفئة.

معرّف العملية: register_class_shape_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: RegisterClassShapeRequest

الردود

الحالةالوصفالمخطط
200تم تسجيل شكل الفئةRegisterClassShapeResponse
400حمولة الطلب غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الأسماءProblemDetails
409شكل الفئة موجود بالفعلProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

GET /v1/write/namespaces/{namespace_id}/status

الملخص: OpenAPI بيانات التعريف لحالة مساحة الأسماء.

معرّف العملية: namespace_status_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف النطاق

الردود

الحالةالوصفالمخطط
200بيانات حالة مساحة الأسماءNamespaceStatusResponse
400معرف مساحة الأسماء غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404مساحة الأسماء غير موجودةProblemDetails
429تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

GET /v1/write/namespaces/changes

ملخص: OpenAPI بيانات التعريف لقائمة تغييرات مساحة الأسماء.

معرّف العملية: list_namespace_changes_endpoint

المعلمات

الاسمفيمطلوبالنوعالوصف
limitاستعلاملاعدد صحيحالحد الأقصى لعدد العناصر التي يجب إرجاعها.
page_tokenاستعلاملاChangeTokenرمز التصفح غير الشفاف للصفحة التالية.
since_updated_at_msاستعلامنعمعدد صحيحالحد الأدنى لطوابع التحديث الزمنية (ميلي ثانية منذ البداية).
tenant_idاستعلاملاTenantIdفلتر مستأجر اختياري.
owner_principal_idاستعلاملاPrincipalIdفلتر رئيسي للمالك اختياري.
policy_classاستعلاملاPolicyClassفلتر فئة السياسة اختياري.
lifecycleاستعلاملاLifecycleStateفلتر دورة الحياة اختياري.
write_modeاستعلاملاNamespaceWriteModeفلتر وضع الكتابة اختياري.
drainingاستعلاملاbooleanفلتر التفريغ اختياري.
frozenاستعلاملاbooleanفلتر المجمد اختياري.

الردود

الحالةالوصفالمخطط
200قائمة تغييرات مساحة الأسماءNamespaceChangeListResponse
400معلمات الطلب غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404مساحة الأسماء غير موجودةProblemDetails
429تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

POST /v1/write/namespaces/forkfromsnapshot

الملخص: OpenAPI بيانات التعريف لنسخ المساحات.

معرّف العملية: fork_namespace_from_snapshot_endpoint

نص الطلب

  • نوع المحتوى: application/json
  • المخطط: NamespaceForkFromSnapshotRequest

الردود

الحالةالوصفالمخطط
200تم إنشاء مساحة الأسماء من اللقطةNamespaceForkFromSnapshotResponse
400معلمات طلب غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الأسماءProblemDetails
409مساحة الأسماء موجودة بالفعلProblemDetails
422فشل التحقق من صحة اللقطةProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

GET /v1/write/namespaces/status

الملخص: OpenAPI بيانات التعريف لعرض سجلات حالة مساحة الأسماء.

معرّف العملية: namespace_status_list_endpoint

الردود

الحالةالوصفالمخطط
200قائمة حالة مساحة الأسماءNamespaceStatusListResponse
401طلب غير مصرح بهProblemDetails
404مساحة الأسماء غير موجودةProblemDetails
429تجاوز الحصةProblemDetails
500خطأ داخلي في الخدمةProblemDetails

GET /v1/write/readyz

ملخص: OpenAPI بيانات التعريف لعملية الاستعداد لدايمون الكتابة.

معرّف العملية: readyz_endpoint

الردود

الحالةالوصفالمخطط
200جاهزية عملية الكتابةReadyzResponse
503عملية الكتابة غير جاهزةReadyzResponse

GET /v1/write/startupz

الملخص: OpenAPI بيانات التعريف لبدء تشغيل خدمة الكتابة.

معرّف العملية: startupz_endpoint

الردود

الحالةالوصفالمخطط
200بدء تشغيل عملية الكتابةProbeResponse
503لم تبدأ عملية الكتابةProblemDetails