نقاط النهاية للقراءة
قراءة عمليات 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 | قراءة استجابة فحص حيوية الـ daemon | ProbeResponse |
| 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_id | path | نعم | NamespaceId | معرف مساحة الاسم |
| id | path | نعم | ExternalId | المعرف الخارجي للفئة |
| x-assetcore-min-world-seq | header | لا | 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_id | path | نعم | NamespaceId | معرف مساحة الاسم |
| id | path | نعم | ExternalId | المعرف الخارجي للفئة |
| x-assetcore-min-world-seq | header | لا | 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
المعلمات
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| namespace_id | path | نعم | NamespaceId | معرف النطاق |
| x-assetcore-min-world-seq | header | لا | 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 | مواضع حاويات مستمرة 1D | Continuous1dPlacementsResponse |
| 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
المعلمات
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| namespace_id | path | نعم | NamespaceId | معرف النطاق |
| x-assetcore-min-world-seq | header | لا | 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 | قراءة فحص بدء تشغيل daemon | ProbeResponse |
| 401 | طلب غير مصرح به | ProblemDetails |
| 403 | طلب محظور | ProblemDetails |
| 429 | تجاوز الحصة | ProblemDetails |
| 500 | الخدمة غير متاحة | ProblemDetails |