REST Resource: sites.versions

المصدر: الإصدار

Version عبارة عن تكوين ومجموعة من الملفات الثابتة التي تحدد كيفية عرض الموقع.

تمثيل جيسون
{
  "name": string,
  "status": enum (VersionStatus),
  "config": {
    object (ServingConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "createUser": {
    object (ActingUser)
  },
  "finalizeTime": string,
  "finalizeUser": {
    object (ActingUser)
  },
  "deleteTime": string,
  "deleteUser": {
    object (ActingUser)
  },
  "fileCount": string,
  "versionBytes": string
}
مجالات
name

string

اسم المورد المؤهل بالكامل للإصدار، بالتنسيق:

sites/ SITE_ID /versions/ VERSION_ID

يتم توفير هذا الاسم في نص الاستجابة عند استدعاء versions.create .

status

enum ( VersionStatus )

حالة نشر الإصدار.

للنشر الناجح، اتصل بـ versions.create لإنشاء إصدار جديد (حالة CREATEDوقم بتحميل جميع الملفات المطلوبة إلى الإصدار، ثم قم بتحديث الإصدار إلى الحالة FINALIZED .

لاحظ أنه إذا تركت الإصدار في حالة CREATED لأكثر من 12 ساعة، فسيقوم النظام تلقائيًا بوضع علامة على الإصدار على أنه ABANDONED .

يمكنك أيضًا تغيير حالة الإصدار إلى DELETED عن طريق استدعاء versions.delete .

config

object ( ServingConfig )

التكوين لسلوك الموقع. هذا التكوين موجود في ملف firebase.json .

labels

map (key: string, value: string)

التصنيفات المستخدمة للبيانات التعريفية الإضافية و/أو التصفية.

كائن يحتوي على قائمة "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

createTime

string ( Timestamp format)

الإخراج فقط. الوقت الذي تم فيه إنشاء الإصدار.

طابع زمني بتنسيق RFC3339 UTC "Zulu"، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

createUser

object ( ActingUser )

الإخراج فقط. يحدد المستخدم الذي قام بإنشاء الإصدار.

finalizeTime

string ( Timestamp format)

الإخراج فقط. الوقت الذي تم فيه FINALIZED الإصدار.

طابع زمني بتنسيق RFC3339 UTC "Zulu"، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

finalizeUser

object ( ActingUser )

الإخراج فقط. يحدد المستخدم الذي FINALIZED الإصدار.

deleteTime

string ( Timestamp format)

الإخراج فقط. الوقت الذي تم فيه DELETED النسخة .

طابع زمني بتنسيق RFC3339 UTC "Zulu"، بدقة نانو ثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

deleteUser

object ( ActingUser )

الإخراج فقط. يحدد المستخدم الذي DELETED الإصدار.

fileCount

string ( int64 format)

الإخراج فقط. إجمالي عدد الملفات المرتبطة بالإصدار.

يتم حساب هذه القيمة بعد FINALIZED الإصدار.

versionBytes

string ( int64 format)

الإخراج فقط. إجمالي حجم البايتات المخزنة للإصدار.

يتم حساب هذه القيمة بعد FINALIZED الإصدار.

VersionStatus

الحالة المعروفة الحالية لإصدار معين في دورة حياة النشر.

التعدادات
VERSION_STATUS_UNSPECIFIED الحالة الافتراضية؛ لا ينبغي أن تستخدم عمدا.
CREATED تم إنشاء الإصدار، ويتم حاليًا إضافة المحتوى إلى الإصدار.
FINALIZED تمت إضافة كل المحتوى إلى الإصدار، ولم يعد من الممكن تغيير الإصدار.
DELETED تم حذف النسخة.
ABANDONED لم يتم تحديث الإصدار إلى FINALIZED خلال 12 ساعة وتم حذفه تلقائيًا.
EXPIRED الإصدار خارج الحد الذي تم تكوينه بواسطة الموقع لعدد الإصدارات التي تم الاحتفاظ بها، لذا تتم جدولة محتوى الإصدار للحذف.
CLONING يتم الآن استنساخ الإصدار من إصدار آخر. لا يزال يتم نسخ كافة المحتويات.

تكوين الخدمة

التكوين الخاص بكيفية توجيه الطلبات الواردة إلى الموقع ومعالجتها قبل تقديم المحتوى. تتم مطابقة مسارات طلب URL مع أنماط URL المحددة في التكوين، ثم تقوم الاستضافة بتطبيق التكوين المطبق وفقًا لترتيب أولوية محدد.

تمثيل جيسون
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
مجالات
headers[]

object ( Header )

مصفوفة من الكائنات، حيث يحدد كل كائن نمط عنوان URL الذي، في حالة مطابقته لمسار عنوان URL للطلب، يؤدي إلى تشغيل الاستضافة لتطبيق رؤوس الاستجابة المخصصة المحددة.

redirects[]

object ( Redirect )

مصفوفة من الكائنات (تسمى قواعد إعادة التوجيه)، حيث تحدد كل قاعدة نمط عنوان URL الذي، إذا كان مطابقًا لمسار عنوان URL للطلب، يؤدي إلى تشغيل الاستضافة للاستجابة بإعادة التوجيه إلى مسار الوجهة المحدد.

rewrites[]

object ( Rewrite )

مصفوفة من الكائنات (تسمى قواعد إعادة الكتابة)، حيث تحدد كل قاعدة نمط عنوان URL الذي، في حالة مطابقته لمسار عنوان URL للطلب، يؤدي إلى تشغيل الاستضافة للاستجابة كما لو تم منح الخدمة عنوان URL المقصود المحدد.

cleanUrls

boolean

يحدد ما إذا كان سيتم إسقاط امتداد الملف من الملفات التي تم تحميلها.

trailingSlashBehavior

enum ( TrailingSlashBehavior )

يحدد كيفية التعامل مع شرطة مائلة زائدة في مسار URL.

i18n

object ( I18nConfig )

خياري. يحدد سلوك إعادة كتابة i18n.

يحدد Header نمط عنوان URL الذي، في حالة مطابقته لمسار عنوان URL للطلب، يؤدي إلى تشغيل الاستضافة لتطبيق رؤوس الاستجابة المخصصة المحددة.

تمثيل جيسون
{
  "headers": {
    string: string,
    ...
  },

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
مجالات
headers

map (key: string, value: string)

مطلوب. الرؤوس الإضافية المراد إضافتها إلى الاستجابة.

كائن يحتوي على قائمة "key": value . مثال: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

pattern حقل الاتحاد
مطلوب. نمط عنوان URL لسلسلة لمطابقته مع مسار عنوان URL للطلب لتحديد ما إذا كان سيتم تطبيق رأس الاستجابة المخصصة هذا أم لا. يمكن أن يكون إما تعبيرًا عاديًا بنمط Bash أو تعبيرًا عاديًا RE2.

يمكن أن يكون pattern واحدًا فقط مما يلي:
glob

string

الكرة الأرضية التي يوفرها المستخدم للمطابقة مع مسار عنوان URL للطلب.

regex

string

التعبير العادي RE2 المقدم من المستخدم للمطابقة مع مسار عنوان URL للطلب.

إعادة توجيه

تحدد Redirect نمط عنوان URL الذي، في حالة مطابقته لمسار عنوان URL للطلب، يؤدي إلى تشغيل الاستضافة للاستجابة بإعادة التوجيه إلى مسار الوجهة المحدد.

تمثيل جيسون
{
  "statusCode": integer,
  "location": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
مجالات
statusCode

integer

مطلوب. رمز الحالة HTTP الذي سيتم عرضه في الاستجابة. يجب أن يكون رمز الحالة 3xx صالحًا.

location

string

مطلوب. القيمة المطلوب وضعها في رأس موقع HTTP للاستجابة.

يمكن أن يحتوي الموقع على قيم مجموعة الالتقاط من النمط باستخدام بادئة : لتحديد المقطع و * اختياري لالتقاط بقية عنوان URL. على سبيل المثال:

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"

pattern حقل الاتحاد
مطلوب. نمط عنوان URL لسلسلة لمطابقته مع مسار عنوان URL للطلب لتحديد ما إذا كان سيتم تطبيق إعادة التوجيه هذه أم لا. يمكن أن يكون إما تعبيرًا عاديًا بنمط Bash أو تعبيرًا عاديًا RE2.

يمكن أن يكون pattern واحدًا فقط مما يلي:
glob

string

الكرة الأرضية التي يوفرها المستخدم للمطابقة مع مسار عنوان URL للطلب.

regex

string

التعبير العادي RE2 المقدم من المستخدم للمطابقة مع مسار عنوان URL للطلب.

اعادة كتابة

تحدد Rewrite نمط عنوان URL الذي، في حالة مطابقته لمسار عنوان URL للطلب، يؤدي إلى تشغيل الاستضافة للاستجابة كما لو تم منح الخدمة عنوان URL المقصود المحدد.

تمثيل جيسون
{
  "functionRegion": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.

  // Union field behavior can be only one of the following:
  "path": string,
  "function": string,
  "run": {
    object (CloudRunRewrite)
  }
  // End of list of possible types for union field behavior.
}
مجالات
functionRegion

string

خياري. حدد منطقة سحابية لاستدعاءات الوظائف المعاد كتابتها. إذا لم يتم توفيره، فسيتم تعيينه افتراضيًا على us-central1.

pattern حقل الاتحاد
مطلوب. نمط عنوان URL لسلسلة لمطابقته مع مسار عنوان URL للطلب لتحديد ما إذا كان سيتم تطبيق عملية إعادة الكتابة هذه أم لا. يمكن أن يكون إما تعبيرًا عاديًا بنمط Bash أو تعبيرًا عاديًا RE2.

يمكن أن يكون pattern واحدًا فقط مما يلي:
glob

string

الكرة الأرضية التي يوفرها المستخدم للمطابقة مع مسار عنوان URL للطلب.

regex

string

التعبير العادي RE2 المقدم من المستخدم للمطابقة مع مسار عنوان URL للطلب.

behavior الميداني للاتحاد .
مطلوب. سلوك إعادة الكتابة.

يمكن أن يكون behavior واحدًا مما يلي فقط:
path

string

مسار URL لإعادة كتابة الطلب إليه.

function

string

وظيفة وكيل الطلبات. يجب أن يتطابق تمامًا مع اسم الوظيفة المصدرة.

run

object ( CloudRunRewrite )

سيتم إعادة توجيه الطلب إلى Cloud Run.

CloudRunRewrite

عملية إعادة كتابة تم تكوينها لتوجيه الطلبات إلى خدمة Cloud Run. إذا لم تكن خدمة Cloud Run موجودة عند إعداد أو تحديث تكوين Firebase Hosting، فسيفشل الطلب. يتم تمرير أي أخطاء من خدمة Cloud Run إلى المستخدم النهائي (على سبيل المثال، إذا قمت بحذف خدمة، فإن أي طلبات موجهة إلى تلك الخدمة تتلقى خطأ 404 ).

تمثيل جيسون
{
  "serviceId": string,
  "region": string,
  "tag": string
}
مجالات
serviceId

string

مطلوب. المعرف المحدد من قبل المستخدم لخدمة Cloud Run.

region

string

خياري. المنطقة المقدمة من قبل المستخدم حيث تتم استضافة خدمة Cloud Run.

الإعدادات الافتراضية لـ us-central1 إذا لم يتم توفيرها.

tag

string

خياري. علامة TrafficConfig المقدمة من المستخدم لإرسال حركة المرور إليها.

عند الحذف، يتم إرسال حركة المرور إلى URI على مستوى الخدمة

TrailingSlashBehavior

يحدد ما إذا كان يجب إضافة شرطة مائلة زائدة أو إزالتها من مسار عنوان URL للطلب.

التعدادات
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

لم يتم تحديد أي سلوك.

يتم عرض الملفات في موقعها المحدد فقط، ولا تتم إضافة الشرطة المائلة اللاحقة إلا إلى فهارس الدليل.

ADD تتم إضافة الشرطة المائلة الزائدة إلى فهارس الدليل وكذلك إلى أي مسار URL لا ينتهي بامتداد الملف.
REMOVE تتم إزالة الشرطة المائلة الزائدة من فهارس الدليل وكذلك من أي مسار URL لا ينتهي بامتداد الملف.

I18nConfig

إذا تم توفيره، فسيتم تمكين إعادة كتابة i18n.

تمثيل جيسون
{
  "root": string
}
مجالات
root

string

مطلوب. المسار الذي يوفره المستخدم حيث سيتم البحث عن المحتوى الخاص بالبلد واللغة داخل الدليل العام.

طُرق

clone

إنشاء إصدار جديد على الموقع المستهدف المحدد باستخدام محتوى الإصدار المحدد.

create

إنشاء نسخة جديدة للموقع المحدد.

delete

يحذف الإصدار المحدد.

get

الحصول على الإصدار المحدد الذي تم إنشاؤه للموقع المحدد.

list

يسرد الإصدارات التي تم إنشاؤها للموقع المحدد.

patch

يقوم بتحديث بيانات التعريف المحددة للإصدار المحدد.

populateFiles

يضيف ملفات المحتوى إلى الإصدار المحدد.