كتابة نقاط النهاية
اكتب عمليات الـ 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_id | path | نعم | 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_id | path | نعم | NamespaceId | معرف النطاق |
الردود
| الحالة | الوصف | المخطط |
|---|---|---|
| 200 | بيانات التعريف الخاصة بالنطاق | NamespaceGetResponse |
| 400 | معرف نطاق غير صالح | ProblemDetails |
| 401 | طلب غير مصرح به | ProblemDetails |
| 404 | النطاق غير موجود | ProblemDetails |
| 429 | تجاوز الحصة | ProblemDetails |
| 500 | خطأ داخلي في الخدمة | ProblemDetails |
PATCH /v1/write/namespaces/{namespace_id}
ملخص: OpenAPI بيانات التعريف لتحديث بيانات تعريف مساحة الأسماء.
معرّف العملية: update_namespace_endpoint
المعلمات
| الاسم | في | مطلوب | النوع | الوصف |
|---|---|---|---|---|
| namespace_id | path | نعم | 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_id | path | نعم | 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_id | path | نعم | 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_id | path | نعم | 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_id | path | نعم | 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_id | path | نعم | 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_id | path | نعم | 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_id | path | نعم | NamespaceId | معرف النطاق |
نص الطلب
- نوع المحتوى: application/json
- المخطط:
RegisterClassContinuousShape1dRequest
الردود
| الحالة | الوصف | المخطط |
|---|---|---|
| 200 | تم تسجيل شكل الفئة المستمر 1D | RegisterClassContinuousShape1dResponse |
| 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_id | path | نعم | 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_id | path | نعم | 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_id | path | نعم | 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 |