وثائق أصول Core

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

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

نقاط النهاية للقراءة

قراءة عمليات daemon (الاستعلامات والإسقاطات)

نقاط النهاية

GET /v1/read/health

ملخص: OpenAPI بيانات التعريف لنقطة نهاية فحص صحة عملية القراءة.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
x-assetcore-namespaceرأسنعمNamespaceIdنطاق الفضاء للاختبارات الصحية للقراءة (مطلوب).

الردود

الحالةالوصفالمخطط
200قراءة حالة صحة الخدمةReadHealthResponse
401طلب غير مصرح بهProblemDetails
403طلب محظورProblemDetails
429تجاوز الحصةProblemDetails
500الخدمة غير متاحةProblemDetails

GET /v1/read/livez

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
x-assetcore-namespaceرأسنعمNamespaceIdنطاق الفضاء للاختبارات الصحية للقراءة (مطلوب).

الردود

الحالةالوصفالمخطط
200قراءة استجابة فحص حيوية الـ daemonProbeResponse
401طلب غير مصرح بهProblemDetails
403طلب محظورProblemDetails
429تجاوز الحصةProblemDetails
500الخدمة غير متاحةProblemDetails

GET /v1/read/namespaces/{namespace_id}/classes

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
cursorاستعلاملاسلسلةمؤشر اختياري مرتبط بمعرف الفئة التي تم رؤيتها آخر مرة.
limitاستعلاملاعدد صحيحالحد الأقصى لعدد الإدخالات التي يجب إرجاعها (الافتراضي 20، والحد الأقصى 200).

الردود

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

GET /v1/read/namespaces/{namespace_id}/classes/{id}

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف مساحة الاسم
idpathنعمExternalIdالمعرف الخارجي للفئة
x-assetcore-min-world-seqheaderلاintegerيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.

الردود

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

GET /v1/read/namespaces/{namespace_id}/classes/{id}/shapes

ملخص: OpenAPI بيانات التعريف لنقطة نهاية أشكال الفئة.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idpathنعمNamespaceIdمعرف مساحة الاسم
idpathنعمExternalIdالمعرف الخارجي للفئة
x-assetcore-min-world-seqheaderلاintegerيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.

الردود

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

GET /v1/read/namespaces/{namespace_id}/classes/stats

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

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

المعلمات

NameInRequiredTypeDescription
namespace_idpathنعمNamespaceIdمعرف النطاق
x-assetcore-min-world-seqheaderلاintegerيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الاستجابة.

الردود

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

GET /v1/read/namespaces/{namespace_id}/commits

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
limitاستعلاملاعدد صحيحالحد الأقصى لعدد الالتزامات التي يجب إرجاعها (م capped عند 100).
from_world_seqاستعلاملاعدد صحيحتسلسل العالم الذي يبدأ منه الإرجاع (افتراضي: 0، ابدأ من البداية).

الردود

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

GET /v1/read/namespaces/{namespace_id}/containers

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
ownerاستعلاملاسلسلةفلتر مالك اختياري (معرف مالك خارجي).
kindاستعلاملاسلسلةفلتر نوع اختياري (رصيد، شبكة، فتحات، continuous_line_1d، continuous_grid_2d).
cursorاستعلاملاسلسلةمؤشر اختياري مرتبط بمعرف الحاوية التي تم رؤيتها آخر مرة.
limitاستعلاملاعدد صحيحالحد الأقصى لعدد الإدخالات التي يجب إرجاعها (مقيد بـ [MAX_LIST_LIMIT]).

الردود

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

GET /v1/read/namespaces/{namespace_id}/containers/{id}

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idالمسارنعمNamespaceIdمعرف النطاق
idالمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqالرأسلاintegerيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.

الردود

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

GET /v1/read/namespaces/{namespace_id}/containers/{id}/balances

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
idمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
classاستعلاملاسلسلةفلتر اختياري على معرف فئة الأصل الخارجي (مثل، "class-1"). عند وجوده، يتم تضمين الأرصدة التي تتطابق مع هذه الفئة فقط في الرد.
keyاستعلاملاسلسلةفلتر اختياري على مفتاح المتغير ([StackKey]) معبر عنه كسلسلة (مثل، "42"). عند وجوده، يتم تضمين الأرصدة التي تحتوي على مفتاح المتغير هذا فقط. إذا لم يستخدم النظام مفاتيح المتغيرات لفئة، يرجى حذف ذلك.

الردود

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

GET /v1/read/namespaces/{namespace_id}/containers/{id}/commits

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
idمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
limitاستعلاملاعدد صحيحالحد الأقصى لعدد الالتزامات التي يجب إرجاعها (م capped عند 100).
from_world_seqاستعلاملاعدد صحيحتسلسل العالم الذي يبدأ منه للإرجاع (افتراضي: 0، ابدأ من البداية).

الردود

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

GET /v1/read/namespaces/{namespace_id}/containers/{id}/contents

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idالمسارنعمNamespaceIdمعرف النطاق
idالمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqالرأسلاintegerيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.

الردود

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

GET /v1/read/namespaces/{namespaceid}/containers/{id}/continuous1d/placements

ملخص: OpenAPI بيانات التعريف لنقطة نهاية التوزيع المستمر 1D.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
idمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
min_xاستعلاملاعدد صحيحالحد الأدنى الشامل الاختياري لـ X (وحدات النقاط الثابتة).
max_xاستعلاملاعدد صحيحالحد الأقصى الشامل الاختياري لـ X (وحدات النقاط الثابتة).

الردود

الحالةالوصفالمخطط
200مواضع حاويات مستمرة 1DContinuous1dPlacementsResponse
400معلمات منطقة 1D مستمرة غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404الحاوية غير موجودةProblemDetails
425لم تصل الإسقاطات إلى تسلسل العالم المطلوبProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخادمProblemDetails

GET /v1/read/namespaces/{namespaceid}/containers/{id}/continuous2d/placements

ملخص: OpenAPI بيانات التعريف لنقطة نهاية التوزيع المستمر ثنائي الأبعاد.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف الفضاء
idمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
min_xاستعلاملاعدد صحيحالحد الأدنى الشامل الاختياري لـ X (وحدات النقاط الثابتة).
min_yاستعلاملاعدد صحيحالحد الأدنى الشامل الاختياري لـ Y (وحدات النقاط الثابتة).
max_xاستعلاملاعدد صحيحالحد الأقصى الشامل الاختياري لـ X (وحدات النقاط الثابتة).
max_yاستعلاملاعدد صحيحالحد الأقصى الشامل الاختياري لـ Y (وحدات النقاط الثابتة).

الردود

الحالةالوصفالمخطط
200مواضع حاويات ثنائية الأبعاد مستمرةContinuous2dPlacementsResponse
400معلمات منطقة ثنائية الأبعاد المستمرة غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404الحاوية غير موجودةProblemDetails
425لم تصل الإسقاطات إلى تسلسل العالم المطلوبProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ داخلي في الخادمProblemDetails

GET /v1/read/namespaces/{namespace_id}/containers/{id}/grid/cells

ملخص: OpenAPI بيانات التعريف لنقطة نهاية وضع الشبكة.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
idمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
xاستعلاملاعدد صحيحإحداثي X المعتمد على 0 (عمود).
yاستعلاملاعدد صحيحإحداثي Y المعتمد على 0 (صف).
widthاستعلاملاعدد صحيحعرض المنطقة (الخلايا).
heightاستعلاملاعدد صحيحارتفاع المنطقة (الخلايا).

الردود

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

GET /v1/read/namespaces/{namespace_id}/containers/{id}/grid/free

ملخص: OpenAPI بيانات التعريف لنقطة نهاية البحث في المنطقة الحرة للشبكة.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
idمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
widthاستعلاملاعدد صحيحعرض الشكل المطلوب (الخلايا).
heightاستعلاملاعدد صحيحارتفاع الشكل المطلوب (الخلايا).

الردود

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

GET /v1/read/namespaces/{namespace_id}/containers/{id}/slots

ملخص: OpenAPI بيانات التعريف لنقطة نهاية شغل الفتحات.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idالمسارنعمNamespaceIdمعرف النطاق
idالمسارنعمExternalIdمعرف الحاوية الخارجي
x-assetcore-min-world-seqالرأسلاintegerيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.

الردود

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

GET /v1/read/namespaces/{namespace_id}/freshness

ملخص: OpenAPI بيانات التعريف لنقطة نهاية تحديث العرض.

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

المعلمات

NameInRequiredTypeDescription
namespace_idpathنعمNamespaceIdمعرف النطاق
x-assetcore-min-world-seqheaderلاintegerيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الاستجابة.

الردود

الحالةالوصفالمخطط
200بيانات تحديث العرضFreshnessResponse
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الأسماءProblemDetails
425لم يصل العرض إلى تسلسل العالم المطلوبProblemDetails
429تم تجاوز الحصةProblemDetails
500العرض غير متاحProblemDetails

GET /v1/read/namespaces/{namespace_id}/instances

ملخص: OpenAPI بيانات التعريف لنقطة نهاية قائمة المثيلات.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
classاستعلاملاسلسلةفلتر فئة اختياري (معرف خارجي).
variant_keyاستعلاملاسلسلةفلتر مفتاح متغير اختياري.
ownerاستعلاملاسلسلةفلتر مالك اختياري (معرف مالك خارجي).
cursorاستعلاملاسلسلةمؤشر اختياري مرتبط بمعرف الحالة الأخيرة المرئية.
limitاستعلاملاعدد صحيحالحد الأقصى لعدد الإدخالات التي يجب إرجاعها (مقيد بـ [MAX_LIST_LIMIT]).

الردود

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

GET /v1/read/namespaces/{namespace_id}/instances/{id}

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف الفضاء الاسمي
idمسارنعمExternalIdمعرف خارجي للمثيل
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.

الردود

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

GET /v1/read/namespaces/{namespace_id}/owners/{id}/summary

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
idمسارنعمExternalIdمعرف المالك الخارجي
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.

الردود

الحالةالوصفالمخطط
200ملخص المالكOwnerSummaryResponse
400معرف المالك غير صالحProblemDetails
401طلب غير مصرح بهProblemDetails
404المالك غير موجودProblemDetails
425لم تصل الإسقاطات إلى تسلسل العالم المطلوبProblemDetails
429تجاوز الحصةProblemDetails
500خطأ في الخادم الداخليProblemDetails

GET /v1/read/namespaces/{namespace_id}/replay

ملخص: OpenAPI بيانات التعريف لنقطة إعادة التشغيل.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب الإسقاط للوصول إلى تسلسل العالم المحدد قبل الرد.
from_world_seqاستعلاملاعدد صحيحتسلسل العالم لإعادة التشغيل منه (شامل).
limitاستعلاملاعدد صحيحالحد الأقصى لعدد الدفعات التي يجب إرجاعها (م capped عند 100).

الردود

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

GET /v1/read/namespaces/{namespace_id}/stream

ملخص: OpenAPI بيانات التعريف لنقطة نهاية تدفق القراءة.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
namespace_idمسارنعمNamespaceIdمعرف النطاق
x-assetcore-min-world-seqرأسلاعدد صحيحيتطلب إسقاط الوصول إلى تسلسل العالم المحدد قبل الرد.
Last-Event-Idرأسلاعدد صحيحمؤشر استئناف SSE؛ يتم استئناف التدفق عند last_event_id + 1.
from_world_seqاستعلاملاعدد صحيحتسلسل العالم الاختياري لبدء البث منه (شامل).
limitاستعلاملاعدد صحيحالحد الأقصى الاختياري لعدد الدفعات التي يجب إصدارها قبل إغلاق التدفق.

الردود

الحالةالوصفالمخطط
200تدفق دفعات الالتزام (SSE)StreamEntry
400معلمات استعلام غير صالحةProblemDetails
401طلب غير مصرح بهProblemDetails
404لم يتم العثور على مساحة الاسمProblemDetails
425لم تصل الإسقاط إلى تسلسل العالم المطلوبProblemDetails
429تم تجاوز الحصةProblemDetails
500خطأ في الخادم الداخليProblemDetails
503التدفق غير متاحProblemDetails

GET /v1/read/readyz

ملخص: OpenAPI بيانات التعريف لعملية الاستعداد لقراءة الـ daemon.

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

المعلمات

الاسمفيمطلوبالنوعالوصف
x-assetcore-namespaceرأسنعمNamespaceIdنطاق الفضاء للاختبارات الصحية للقراءة (مطلوب).

الردود

الحالةالوصفالمخطط
200قراءة جاهزية عملية القراءةReadReadyzResponse
401طلب غير مصرح بهProblemDetails
403طلب محظورProblemDetails
429تجاوز الحصةProblemDetails
500الخدمة غير متاحةProblemDetails
503القارئ غير جاهزReadReadyzResponse

GET /v1/read/startupz

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

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

المعلمات

الاسمفيمطلوبالنوعالوصف
x-assetcore-namespaceرأسنعمNamespaceIdنطاق الفضاء للاختبارات الصحية للقراءة (مطلوب).

الردود

الحالةالوصفالمخطط
200قراءة فحص بدء تشغيل daemonProbeResponse
401طلب غير مصرح بهProblemDetails
403طلب محظورProblemDetails
429تجاوز الحصةProblemDetails
500الخدمة غير متاحةProblemDetails