الفهرس
BadRequest(رسالة)BadRequest.FieldViolation(رسالة)Code(تعداد)ErrorInfo(رسالة)Help(رسالة)Help.Link(رسالة)LocalizedMessage(رسالة)PreconditionFailure(رسالة)PreconditionFailure.Violation(رسالة)QuotaFailure(رسالة)QuotaFailure.Violation(رسالة)RequestInfo(رسالة)ResourceInfo(رسالة)RetryInfo(رسالة)Status(رسالة)
BadRequest
تصف هذه السمة الانتهاكات في طلب العميل. يركّز هذا النوع من الأخطاء على الجوانب النحوية للطلب.
| الحقول | |
|---|---|
field_violations[] |
تصف هذه السمة جميع المخالفات في طلب العميل. |
FieldViolation
نوع رسالة يُستخدَم لوصف حقل طلب غير صالح واحد.
| الحقول | |
|---|---|
field |
مسار يؤدي إلى حقل في نص الطلب ستكون القيمة عبارة عن سلسلة من المعرّفات المفصولة بنقاط والتي تحدّد حقلًا في بروتوكول المخزن المؤقت. ننصحك باتّباع الخطوات التالية: في هذا المثال، يمكن أن يأخذ
في JSON، يتم تمثيل القيم نفسها على النحو التالي:
|
description |
وصف لسبب عدم صلاحية عنصر الطلب. |
reason |
سبب الخطأ على مستوى الحقل. هذه قيمة ثابتة تحدّد السبب المباشر للخطأ على مستوى الحقل. يجب أن يحدّد بشكل فريد نوع FieldViolation ضمن نطاق google.rpc.ErrorInfo.domain. يجب ألا يزيد عدد الأحرف عن 63 حرفًا وأن يتطابق مع التعبير العادي |
localized_message |
توفّر هذه السمة رسالة خطأ مترجَمة للأخطاء على مستوى الحقل، ويمكن إرجاعها بأمان إلى مستهلك واجهة برمجة التطبيقات. |
الرمز
رموز الخطأ الأساسية لواجهات برمجة التطبيقات gRPC
في بعض الأحيان، قد تنطبق رموز خطأ متعددة. يجب أن تعرض الخدمات رمز الخطأ الأكثر تحديدًا الذي ينطبق. على سبيل المثال، استخدِم OUT_OF_RANGE بدلاً من FAILED_PRECONDITION إذا كان الرمزان ينطبقان. وبالمثل، يجب تفضيل NOT_FOUND أو ALREADY_EXISTS على FAILED_PRECONDITION.
| عمليات التعداد | |
|---|---|
OK |
ليس خطأ، بل يتم عرضه عند النجاح. ربط HTTP: 200 OK |
CANCELLED |
تم إلغاء العملية، وعادةً ما يكون ذلك من قِبل المتصل. ربط HTTP: 499 Client Closed Request |
UNKNOWN |
حدث خطأ غير معروف. على سبيل المثال، قد يتم عرض هذا الخطأ عندما تنتمي قيمة ربط HTTP: 500 Internal Server Error |
INVALID_ARGUMENT |
حدّد العميل وسيطة غير صالحة. يُرجى العلم أنّ هذا يختلف عن ربط HTTP: طلب غير صالح (400) |
DEADLINE_EXCEEDED |
انتهت المهلة قبل أن تتمكّن العملية من الاكتمال. بالنسبة إلى العمليات التي تغيّر حالة النظام، قد يتم عرض هذا الخطأ حتى إذا اكتملت العملية بنجاح. على سبيل المثال، قد يتأخر الردّ الناجح من الخادم لفترة طويلة بما يكفي لانتهاء الموعد النهائي. ربط HTTP: انتهت مهلة البوابة 504 |
NOT_FOUND |
لم يتم العثور على بعض الكيانات المطلوبة (مثل ملف أو دليل). ملاحظة لمطوّري الخادم: إذا تم رفض طلب لفئة كاملة من المستخدمين، مثل طرح الميزات تدريجيًا أو قائمة السماح غير الموثّقة، يمكن استخدام تعيين HTTP: لم يتم العثور على الصفحة (404) |
ALREADY_EXISTS |
الكيان الذي حاول العميل إنشاءه (مثل ملف أو دليل) متوفّر مسبقًا. ربط HTTP: 409 Conflict |
PERMISSION_DENIED |
ليس لدى المتصل إذن لتنفيذ العملية المحدّدة. يجب عدم استخدام تعيين HTTP: 403 Forbidden |
UNAUTHENTICATED |
لا يتضمّن الطلب بيانات اعتماد مصادقة صالحة للعملية. ربط HTTP: 401 غير مصرّح به |
RESOURCE_EXHAUSTED |
تم استنفاد بعض الموارد، ربما حصة لكل مستخدم، أو ربما نفدت مساحة نظام الملفات بالكامل. تعيين HTTP: 429 Too Many Requests |
FAILED_PRECONDITION |
تم رفض العملية لأنّ النظام ليس في الحالة المطلوبة لتنفيذها. على سبيل المثال، الدليل المطلوب حذفه غير فارغ، أو يتم تطبيق عملية rmdir على عنصر ليس دليلاً، وما إلى ذلك. يمكن لمطوّري الخدمات استخدام الإرشادات التالية لتحديد ما إذا كان يجب استخدام ربط HTTP: طلب غير صالح (400) |
ABORTED |
تم إلغاء العملية، وعادةً ما يكون ذلك بسبب مشكلة في التزامن، مثل فشل عملية التحقّق من التسلسل أو إلغاء المعاملة. اطّلِع على الإرشادات أعلاه لتحديد ما إذا كان يجب استخدام ربط HTTP: 409 Conflict |
OUT_OF_RANGE |
تمت محاولة تنفيذ العملية بعد انتهاء النطاق الصالح. على سبيل المثال، البحث عن بيانات أو قراءتها بعد نهاية الملف على عكس الخطأ هناك تداخل كبير بين ربط HTTP: طلب غير صالح (400) |
UNIMPLEMENTED |
لم يتم تنفيذ العملية أو أنّها غير متاحة/مفعّلة في هذه الخدمة. ربط HTTP: 501 Not Implemented |
INTERNAL |
أخطاء داخلية وهذا يعني أنّه تم انتهاك بعض الثوابت التي يتوقّعها النظام الأساسي. رمز الخطأ هذا مخصّص للأخطاء الجسيمة. ربط HTTP: 500 Internal Server Error |
UNAVAILABLE |
هذه الخدمة غير متاحة حاليًا. من المرجّح أنّ هذه حالة عابرة يمكن تصحيحها من خلال إعادة المحاولة مع التراجع. يُرجى العِلم أنّه ليس من الآمن دائمًا إعادة محاولة تنفيذ العمليات غير المتكرّرة. اطّلِع على الإرشادات أعلاه لتحديد ما إذا كان يجب استخدام ربط HTTP: خطأ 503: الخدمة غير متاحة |
DATA_LOSS |
ثمة بيانات تالفة أو بيانات مفقودة ويتعذّر استرجاعها. ربط HTTP: 500 Internal Server Error |
ErrorInfo
تصف هذه السمة سبب الخطأ بتفاصيل منظَّمة.
مثال على حدوث خطأ عند التواصل مع واجهة برمجة التطبيقات "pubsub.googleapis.com" عندما تكون غير مفعّلة:
{ "reason": "API_DISABLED"
"domain": "googleapis.com"
"metadata": {
"resource": "projects/123",
"service": "pubsub.googleapis.com"
}
}
تشير هذه الاستجابة إلى أنّ واجهة برمجة التطبيقات pubsub.googleapis.com غير مفعّلة.
في ما يلي مثال على خطأ يتم عرضه عند محاولة إنشاء مثيل Spanner في منطقة غير متوفّرة:
{ "reason": "STOCKOUT"
"domain": "spanner.googleapis.com",
"metadata": {
"availableRegions": "us-central1,us-east2"
}
}
| الحقول | |
|---|---|
reason |
سبب الخطأ هذه قيمة ثابتة تحدّد السبب المباشر للخطأ. تكون أسباب الخطأ فريدة ضمن نطاق معيّن من الأخطاء. يجب ألا يزيد عدد الأحرف عن 63 حرفًا وأن يتطابق مع التعبير العادي |
domain |
تمثّل هذه السمة المجموعة المنطقية التي ينتمي إليها "السبب". عادةً ما يكون نطاق الخطأ هو اسم الخدمة المسجَّل للأداة أو المنتج الذي يعرض الخطأ. مثال: "pubsub.googleapis.com". إذا تم إنشاء الخطأ بواسطة بعض البنية الأساسية الشائعة، يجب أن يكون نطاق الخطأ قيمة فريدة على مستوى العالم تحدّد البنية الأساسية. بالنسبة إلى بنية Google API الأساسية، يكون نطاق الخطأ هو "googleapis.com". |
metadata |
تفاصيل إضافية منظَّمة حول هذا الخطأ يجب أن تتطابق المفاتيح مع تعبير عادي من |
مساعدة
توفّر روابط إلى المستندات أو لتنفيذ إجراء خارج النطاق.
على سبيل المثال، إذا تعذّر إجراء عملية التحقّق من الحصة بسبب ظهور خطأ يشير إلى أنّ المشروع الذي يتم استدعاؤه لم يفعّل الخدمة التي يتم الوصول إليها، يمكن أن يحتوي هذا الخطأ على عنوان URL يؤدي مباشرةً إلى المكان المناسب في "وحدة تحكّم المطوّرين" لتفعيل الخدمة.
| الحقول | |
|---|---|
links[] |
عناوين URL تشير إلى معلومات إضافية حول التعامل مع الخطأ الحالي |
رابط
تصف هذه السمة رابط عنوان URL.
| الحقول | |
|---|---|
description |
تصف هذه السمة ما يقدّمه الرابط. |
url |
تمثّل هذه السمة عنوان URL للرابط. |
LocalizedMessage
توفّر هذه السمة رسالة خطأ مترجَمة يمكن إرجاعها بأمان إلى المستخدم ويمكن إرفاقها بخطأ في استدعاء الإجراء عن بُعد (RPC).
| الحقول | |
|---|---|
locale |
اللغة المستخدَمة وفقًا للمواصفات المحدّدة في https://www.rfc-editor.org/rfc/bcp/bcp47.txt أمثلة: "en-US" أو "fr-CH" أو "es-MX" |
message |
رسالة الخطأ المترجَمة باللغة المحدّدة أعلاه |
PreconditionFailure
توضّح هذه السمة الشروط المسبقة التي لم يتم استيفاؤها.
على سبيل المثال، إذا تعذّر تنفيذ طلب إجراء مكالمة عن بُعد (RPC) لأنّه يتطلّب الموافقة على بنود الخدمة، يمكن أن يدرج رسالة PreconditionFailure انتهاك بنود الخدمة.
| الحقول | |
|---|---|
violations[] |
تصف هذه السمة جميع انتهاكات الشروط المسبقة. |
الانتهاك
نوع رسالة يُستخدَم لوصف تعذُّر استيفاء شرط مسبق واحد.
| الحقول | |
|---|---|
type |
نوع PreconditionFailure. ننصحك باستخدام نوع تعداد خاص بالخدمة لتحديد مواضيع انتهاك الشروط المسبقة المتوافقة. على سبيل المثال، "مخالفة بنود الخدمة" |
subject |
الموضوع، بالنسبة إلى النوع، الذي تعذّر تنفيذه. على سبيل المثال، يشير الرابط "google.com/cloud" بالنسبة إلى النوع "بنود الخدمة" إلى بنود الخدمة التي تتم الإشارة إليها. |
description |
وصف لسبب تعذُّر تطبيق الشرط المسبق ويمكن للمطوّرين استخدام هذا الوصف لمعرفة كيفية إصلاح الخطأ. على سبيل المثال: "لم يتم قبول بنود الخدمة". |
QuotaFailure
يصف هذا الحقل سبب تعذُّر التحقّق من الحصة.
على سبيل المثال، إذا تم تجاوز الحدّ اليومي لمشروع الاتصال، يمكن أن تردّ الخدمة بتفاصيل QuotaFailure تتضمّن معرّف المشروع ووصف حدّ الحصة الذي تم تجاوزه. إذا لم يفعّل مشروع الاتصال الخدمة في "وحدة تحكّم المطوّرين"، يمكن أن تستجيب الخدمة بمعرّف المشروع وتضبط قيمة service_disabled على "صحيح".
راجِع أيضًا نوعَي RetryInfo وHelp للحصول على تفاصيل أخرى حول معالجة خطأ في الحصة.
| الحقول | |
|---|---|
violations[] |
تعرض هذه السمة جميع انتهاكات الحصة. |
الانتهاك
نوع رسالة يُستخدَم لوصف انتهاك واحد للحصة. على سبيل المثال، حصة يومية أو حصة مخصّصة تم تجاوزها.
| الحقول | |
|---|---|
subject |
الموضوع الذي تعذّر التحقّق من الحصة فيه. على سبيل المثال، "clientip: |
description |
وصف لسبب تعذّر التحقّق من الحصة يمكن للعملاء استخدام هذا الوصف لمعرفة المزيد عن إعدادات الحصة في المستندات العلنية للخدمة، أو العثور على حد الحصة ذي الصلة لتعديله من خلال "وحدة تحكّم المطوّرين". على سبيل المثال: "الخدمة غير مفعّلة" أو "تم تجاوز الحدّ اليومي لعمليات القراءة". |
api_service |
خدمة واجهة برمجة التطبيقات التي ينشأ منها على سبيل المثال، إذا كانت واجهة برمجة التطبيقات التي تم استدعاؤها هي Kubernetes Engine API (container.googleapis.com)، وحدث انتهاك للحصة في Kubernetes Engine API نفسها، سيكون هذا الحقل هو "container.googleapis.com". من ناحية أخرى، إذا حدث انتهاك الحصة عند إنشاء واجهة برمجة التطبيقات Kubernetes Engine API لأجهزة VM في واجهة برمجة التطبيقات Compute Engine API (compute.googleapis.com)، سيكون هذا الحقل هو "compute.googleapis.com". |
quota_metric |
مقياس الحصة التي تم انتهاكها. مقياس الحصة هو عدّاد مسمّى لقياس الاستخدام، مثل طلبات واجهة برمجة التطبيقات أو وحدات المعالجة المركزية. عند حدوث نشاط في إحدى الخدمات، مثل تخصيص جهاز افتراضي، قد يتأثر مقياس واحد أو أكثر من مقاييس الحصة. على سبيل المثال، "compute.googleapis.com/cpus_per_vm_family" و"storage.googleapis.com/internet_egress_bandwidth". |
quota_id |
معرّف الحصة المخالِفة. يُعرف هذا الحقل أيضًا باسم "اسم الحدّ"، وهو المعرّف الفريد لحصة ضمن سياق خدمة واجهة برمجة التطبيقات. على سبيل المثال، "CPUS-PER-VM-FAMILY-per-project-region". |
quota_dimensions |
سمات الحصة التي تمّ انتهاكها. يتم فرض كل حصة غير عالمية على مجموعة من السمات. في حين يحدّد مقياس الحصة ما يجب احتسابه، تحدّد السمات الجوانب التي يجب زيادة العداد من أجلها. على سبيل المثال، تفرض الحصة "وحدات المعالجة المركزية لكل منطقة لكل فئة من الأجهزة الافتراضية" حدًا على المقياس "compute.googleapis.com/cpus_per_vm_family" في السمتَين "المنطقة" و "vm_family". إذا حدثت المخالفة في المنطقة "us-central1" ولعائلة الجهاز الظاهري "n1"، ستكون quota_dimensions كما يلي: { "region": "us-central1", "vm_family": "n1", } عند فرض حصة على مستوى العالم، ستكون quota_dimensions فارغة دائمًا. |
quota_value |
قيمة الحصة المفروضة في وقت على سبيل المثال، إذا كانت قيمة الحصة المفروضة في وقت |
future_quota_value |
قيمة الحصة الجديدة التي يتم طرحها في وقت حدوث المخالفة عند اكتمال عملية الطرح، سيتم فرض هذه القيمة بدلاً من quota_value. إذا لم يكن هناك طرح قيد التقدّم في وقت حدوث المخالفة، لن يتم ضبط هذا الحقل. على سبيل المثال، إذا كان هناك طرح قيد التقدّم في وقت حدوث الانتهاك لتغيير حصة عدد وحدات المعالجة المركزية من 10 إلى 20، ستكون القيمة 20. |
RequestInfo
يحتوي على بيانات وصفية حول الطلب يمكن للعملاء إرفاقها عند الإبلاغ عن خطأ أو تقديم أشكال أخرى من الملاحظات.
| الحقول | |
|---|---|
request_id |
سلسلة غير شفافة يجب أن تفسّرها الخدمة التي تنشئها فقط. على سبيل المثال، يمكن استخدامها لتحديد الطلبات في سجلّات الخدمة. |
serving_data |
أي بيانات تم استخدامها لتنفيذ هذا الطلب على سبيل المثال، تتبُّع تسلسل استدعاء الدوال البرمجية مشفّر يمكن إرساله إلى مقدّم الخدمة لتصحيح الأخطاء. |
ResourceInfo
تصف هذه السمة المورد الذي يتم الوصول إليه.
| الحقول | |
|---|---|
resource_type |
اسم لنوع المورد الذي يتم الوصول إليه، مثل "جدول SQL" أو "حزمة تخزين على السحابة الإلكترونية" أو "ملف" أو "تقويم Google"، أو عنوان URL لنوع المورد، مثل "type.googleapis.com/google.pubsub.v1.Topic". |
resource_name |
اسم المورد الذي يتم الوصول إليه على سبيل المثال، اسم تقويم مشترك: "example.com_4fghdhgsrgh@group.calendar.google.com"، إذا كان الخطأ الحالي هو |
owner |
مالك المرجع (اختياري) على سبيل المثال، "user: |
description |
توضّح هذه السمة الخطأ الذي يحدث عند الوصول إلى هذا المرجع. على سبيل المثال، قد يتطلّب تعديل مشروع على السحابة الإلكترونية الحصول على إذن |
RetryInfo
توضّح هذه السمة الحالات التي يمكن فيها للعملاء إعادة محاولة تنفيذ طلب فاشل. يمكن للعملاء تجاهل الاقتراح هنا أو إعادة المحاولة عندما تكون هذه المعلومات غير متوفّرة في ردود الأخطاء.
يُنصح دائمًا بأن تستخدم البرامج العميلة التراجع الأسي عند إعادة المحاولة.
على العملاء الانتظار إلى أن يمرّ retry_delay من الوقت منذ تلقّي ردّ الخطأ قبل إعادة المحاولة. إذا تعذّر أيضًا إعادة محاولة الطلبات، على العملاء استخدام نظام التراجع الأسي لزيادة التأخير بين عمليات إعادة المحاولة تدريجيًا استنادًا إلى retry_delay، إلى أن يتم الوصول إلى الحدّ الأقصى لعدد عمليات إعادة المحاولة أو الحدّ الأقصى للتأخير في إعادة المحاولة.
| الحقول | |
|---|---|
retry_delay |
يجب أن ينتظر العملاء هذه المدة على الأقل بين محاولات إعادة إرسال الطلب نفسه. |
الحالة
يحدّد نوع Status نموذجًا منطقيًا للتعامل مع الأخطاء، يناسب بيئات البرمجة المختلفة مثل REST API وRPC API. يتم استخدامه من خلال gRPC. تتكون رسالة Status من ثلاثة أجزاء من البيانات، هي رمز الخطأ ورسالته وتفاصيله.
يمكنك التعرّف على المزيد حول نموذج الخطأ هذا وكيفية التعامل معه في دليل تصميم واجهة برمجة التطبيقات.
| الحقول | |
|---|---|
code |
هو رمز الحالة، ويجب أن يكون قيمة محدّدة مسبقًا من |
message |
يشير إلى رسالة خطأ موجّهة للمطوّرين، ويجب أن تكون الرسالة بالإنجليزية. أما رسائل الخطأ الموجّهة للمستخدمين، فيجب ترجمتها وإرسالها في حقل |
details[] |
يشير إلى قائمة بالرسائل التي تتضمّن تفاصيل الخطأ. تتوفّر مجموعة شائعة من أنواع الرسائل التي يمكن لواجهات برمجة التطبيقات استخدامها. |