Operations

يوفر Azure CycleCloud واجهة برمجة تطبيقات REST لإدارة المجموعات والعقد والموارد ذات الصلة برمجيا. استخدم عمليات واجهة برمجة التطبيقات هذه للاستعلام عن حالة نظام المجموعة وإنشاء العقد وإدارتها وتعقب العمليات طويلة الأمد. يسرد هذا المرجع نقاط النهاية والمعلمات وتنسيقات الاستجابة المتوفرة لمساعدتك على أتمتة ودمج إدارة نظام مجموعة CycleCloud في مهام سير العمل الخاصة بك.

الحصول على عقد نظام المجموعة

GET /clusters/{cluster}/nodes

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة للاستعلام string
Query operation
optional		 إذا تم منحها، فترجع العقد لمعرف العملية هذا فقط، وتتضمن سمة العملية على النص الأساسي string
Query request_id
optional		 إذا تم منحها، فترجع العقد الخاصة بالعملية المحددة بواسطة معرف الطلب هذا فقط، وتتضمن سمة العملية على النص الأساسي string

Responses

رمز HTTP Description Schema
200 OK قائمة العقدة
400 مواصفات غير صحيحة لا يوجد محتوى
404 غير موجود لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes

مثال على استجابة HTTP

الاستجابة 200

{
  "nodes" : [ { } ],
  "operation" : {
    "action" : "string",
    "startTime" : "2020-01-01T12:34:56Z"
  }
}

إنشاء عقد نظام المجموعة

POST /clusters/{cluster}/nodes/create

Description

تضيف هذه العملية عقدا جديدة من nodearray إلى نظام مجموعة. يقبل تعريفات عقدة متعددة في مكالمة واحدة. يقوم بإرجاع عنوان URL إلى العملية التي يمكن استخدامها لتتبع حالة العملية.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة المراد إضافة العقد إليه string
Body nodes
مطلوب		 مجموعات العقد التي سيتم إنشاؤها طلب إنشاء العقدة

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeCreationResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/create

نص الطلب

{
  "requestId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

مثال على استجابة HTTP

الاستجابة 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

إلغاء تخصيص عقد نظام المجموعة

POST /clusters/{cluster}/nodes/deallocate

Description

تعمل هذه العملية على إلغاء تخصيص العقد في نظام مجموعة. يمكن تحديد العقد بعدة طرق، بما في ذلك اسم العقدة أو معرف العقدة أو حسب عامل التصفية.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة الذي يجب إلغاء تخصيص العقد فيه string
Body action
مطلوب		 وصف العقد التي يجب إلغاء تخصيصها طلب إدارة العقدة

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeManagementResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/deallocate

نص الطلب

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

مثال على استجابة HTTP

الاستجابة 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

إعادة تعيين عقد نظام المجموعة

POST /clusters/{cluster}/nodes/reimage

Description

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

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة لإعادة تعيين العقد في string
Body action
مطلوب		 وصف العقد التي يجب إعادة تعيينها طلب إدارة العقدة

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeManagementResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/reimage

نص الطلب

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

مثال على استجابة HTTP

الاستجابة 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

إنهاء عقد نظام المجموعة وإزالتها

POST /clusters/{cluster}/nodes/remove

Description

تزيل هذه العملية العقد في نظام مجموعة. يمكنك تحديد العقد حسب اسم العقدة أو معرف العقدة أو عامل التصفية. بشكل افتراضي، يزيل CycleCloud العقد عند الإنهاء، لذلك يتصرف هذا الاستدعاء مثل الإنهاء. لا تتم إزالة العقد التي تم تعيين السمة الثابتة إلى true عند الإنهاء.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة لإزالة العقد في string
Body action
مطلوب		 وصف العقد التي يجب إزالتها طلب إدارة العقدة

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeManagementResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/remove

نص الطلب

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

مثال على استجابة HTTP

الاستجابة 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

إعادة تشغيل عقد نظام المجموعة

POST /clusters/{cluster}/nodes/restart

Description

تعيد هذه العملية تشغيل العقد في نظام مجموعة. يمكن تحديد العقد بعدة طرق، بما في ذلك اسم العقدة أو معرف العقدة أو حسب عامل التصفية.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة لإعادة تشغيل العقد في string
Body action
مطلوب		 وصف العقد التي يجب إعادة تشغيلها طلب إدارة العقدة

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeManagementResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/restart

نص الطلب

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

مثال على استجابة HTTP

الاستجابة 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

إنهاء عقد نظام المجموعة أو إلغاء تخصيصها

POST /clusters/{cluster}/nodes/shutdown

Description

يقوم هذا الاستدعاء بإيقاف تشغيل العقد في نظام مجموعة. تقرر سمة ShutdownPolicy لكل عقدة الإجراء: إنهاء (افتراضي) أو إلغاء التخصيص.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة لإيقاف تشغيل العقد في string
Body action
مطلوب		 وصف العقد التي سيتم إيقاف تشغيلها طلب إدارة العقدة

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeManagementResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/shutdown

نص الطلب

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

مثال على استجابة HTTP

الاستجابة 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

بدء عقد نظام المجموعة التي تم إلغاء تخصيصها أو إنهاؤها

POST /clusters/{cluster}/nodes/start

Description

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

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة لبدء العقد في string
Body action
مطلوب		 وصف العقد التي يجب بدء تشغيلها طلب إدارة العقدة

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeManagementResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/start

نص الطلب

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

مثال على استجابة HTTP

الاستجابة 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

إنهاء عقد نظام المجموعة

POST /clusters/{cluster}/nodes/terminate

Description

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

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة لإنهاء العقد في string
Body action
مطلوب		 وصف العقد التي يجب إنهائها طلب إدارة العقدة

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeManagementResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/terminate

نص الطلب

{
  "filter" : "State === \"Started\"",
  "hostnames" : [ "hostname1", "hostname2" ],
  "ids" : [ "id1", "id2" ],
  "ip_addresses" : [ "10.0.1.1", "10.1.1.2" ],
  "names" : [ "name1", "name2" ],
  "requestId" : "00000000-0000-0000-0000-000000000000"
}

مثال على استجابة HTTP

الاستجابة 202

{
  "nodes" : [ "object" ],
  "operationId" : "00000000-0000-0000-0000-000000000000"
}

إرسال تقرير صحة الضيف لعقدة نظام المجموعة

POST /clusters/{cluster}/nodes/{node}/ghr

Description

إرسال تقرير صحة لعقدة ذات مشكلة صحية

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة الذي يحتوي على العقدة المراد الإبلاغ بها string
Path node
مطلوب		 العقدة المراد إعداد تقرير بها string
Query category
optional		 فئة تقرير صحة الضيف للتأثير string
Query وصف
optional		 رسالة مخصصة تصف الفشل أو السياق string

Responses

رمز HTTP Description Schema
202 مقبول لا يوجد محتوى
400 إدخال غير صحيح لا يوجد محتوى
404 غير موجود لا يوجد محتوى
409 التعارض - تقرير صحة الضيف المقدم بالفعل لهذه العقدة لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/string/ghr

الحصول على تقرير صحة الضيف لعقدة نظام المجموعة

GET /clusters/{cluster}/nodes/{node}/ghr

Description

إرجاع تأثير حمل العمل لعقدة ذات مشكلة صحية، حتى تتمكن من إرسالها إلى نقطة نهاية إعداد التقارير الصحية.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة الذي يحتوي على العقدة المراد الإبلاغ بها string
Path node
مطلوب		 العقدة المراد إعداد تقرير بها string
Query category
optional		 فئة تقرير صحة الضيف للتأثير string
Query وصف
optional		 رسالة مخصصة تصف الفشل أو السياق string

Responses

رمز HTTP Description Schema
200 موافق لا يوجد محتوى
400 إدخال غير صحيح لا يوجد محتوى
404 غير موجود لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/nodes/string/ghr

تحجيم نظام المجموعة إلى الحجم

POST /clusters/{cluster}/scale/{nodearray}

Description

تضيف هذه العملية العقد حسب الحاجة إلى nodearray لتصل إلى العدد الإجمالي. تتم معالجة الطلب مرة واحدة ولا يعيد إضافة العقد لاحقا للحفاظ على الرقم المحدد. حدد الحجم الهدف باستخدام إما totalCoreCount (إجمالي مراكز وحدة المعالجة المركزية) أو totalNodeCount (إجمالي الأجهزة الظاهرية)، ولكن ليس كلاهما في نفس الطلب. يقوم بإرجاع عنوان URL إلى العملية التي يمكنك استخدامها لتعقب حالته.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة المراد إضافة العقد إليه string
Path nodearray
مطلوب		 nodearray لإضافة عقد إلى string
Query totalCoreCount
optional		 العدد الإجمالي للذاكرات الأساسية في nodearray هذا، بما في ذلك العقد التي تم إنشاؤها بالفعل integer
Query totalNodeCount
optional		 العدد الإجمالي للأجهزة التي يجب أن يكون لها في nodearray هذا، بما في ذلك العقد التي تم إنشاؤها بالفعل integer

Responses

رمز HTTP Description Schema
202 قبلت
الرؤوس :
Location (سلسلة): عنوان URL للعملية.		 NodeCreationResult
409 إدخال غير صحيح لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

مثال على استجابة HTTP

الاستجابة 202

{
  "operationId" : "00000000-0000-0000-0000-000000000000",
  "sets" : [ "object" ]
}

الحصول على حالة نظام المجموعة

GET /clusters/{cluster}/status

Description

تحتوي هذه العملية على معلومات للعقد وnodearrays في مجموعة معينة. لكل nodearray، فإنه يرجع حالة كل تخصيص متوفر "مستودع". تتضمن الحالة عدد العقد الحالية في المستودع وعدد العقد الأخرى التي يمكنك إضافتها. كل مستودع هو مجموعة من الأجهزة الظاهرية المحتملة لملف تعريف جهاز معين يمكن إنشاؤها في موقع معين ضمن حساب عميل معين، وما إلى ذلك. يحدد تعريف مجموعة المستخدم المستودعات الصالحة ل nodearray، ولكن موفر السحابة يحدد جزئيا الحدود.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة للاستعلام string
Query nodes
optional		 إذا كان صحيحا، يتم إرجاع العقد ومراجع العقدة في الاستجابة boolean

Responses

رمز HTTP Description Schema
200 OK نظام مجموعة نظام المجموعة

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/status

مثال على استجابة HTTP

الاستجابة 200

{
  "maxCoreCount" : 16,
  "maxCount" : 4,
  "nodearrays" : [ "object" ],
  "nodes" : [ { } ],
  "state" : "Starting",
  "targetState" : "Started"
}

الحصول على معلومات الاستخدام والتكلفة الاختيارية لنظام مجموعة

GET /clusters/{cluster}/usage

Description

تقوم هذه العملية بإرجاع بيانات الاستخدام الإجمالية (الساعات الأساسية) وبيانات التكلفة، إذا كانت متوفرة، للمجموعة، وتقسيم كل nodearray. بشكل افتراضي، تقوم بإرجاع قيمة استخدام الشهر الحالي.

Parameters

Type Name Description Schema
Path cluster
مطلوب		 نظام المجموعة لإرجاع بيانات الاستخدام ل string
Query زمني
optional		 النطاق الزمني الذي يجب استخدامه للاستعلام. القيم الصالحة: monthToDate (الشهر الحالي) lastMonth أو (الشهر السابق) weekToDate أو (الأسبوع الحالي، بدءا من الأحد)، أو custom (يتطلب معلمات from الاستعلام و to ). الافتراضي هو monthToDate. جميع الأوقات تتبع التوقيت العالمي المنسق (UTC). قائمة تعداد (monthToDate, lastMonth, weekToDate, custom)
Query from
optional		 بالنسبة إلى الإطارات الزمنية المخصصة، هذه القيمة هي بداية الإطار الزمني بتنسيق ISO-8601. يتم تقريبه إلى أقرب ساعة أو يوم. string
Query to
optional		 بالنسبة إلى الإطارات الزمنية المخصصة، هذه القيمة هي نهاية الإطار الزمني بتنسيق ISO-8601. يتم تقريبه إلى أقرب ساعة أو يوم. string
Query الحبوبيه
optional		 تحديد كيفية تجميع البيانات: كل ساعة أو يوميا أو كإجمالي واحد. الفاصل الزمني الافتراضي يومي. قائمة تعداد (الإجمالي، يوميا، كل ساعة)

Responses

رمز HTTP Description Schema
200 OK استخدام نظام المجموعة

مثال طلب HTTP

مسار الطلب

/clusters/CLUSTER_NAME/usage

مثال على استجابة HTTP

الاستجابة 200

{
  "usage" : [ "object" ]
}

سرد حالة العمليات

GET /operations/

Parameters

Type Name Description Schema
Query request_id
optional		 معرف الطلب للعملية. إذا تم إعطاء هذه القيمة، تحتوي القائمة على 0 أو 1 عنصر. string

Responses

رمز HTTP Description Schema
200 OK < حالة> العمليات الصفيف
400 طلب غير صالح لا يوجد محتوى
404 غير موجود لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/operations/

مثال على استجابة HTTP

الاستجابة 200

[ {
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
} ]

الحصول على حالة العملية حسب المعرف

GET /operations/{id}

Parameters

Type Name Description Schema
Path id
مطلوب		 معرف العملية string

Responses

رمز HTTP Description Schema
200 OK حالة العمليات
404 غير موجود لا يوجد محتوى

مثال طلب HTTP

مسار الطلب

/operations/00000000-0000-0000-0000-000000000000

مثال على استجابة HTTP

الاستجابة 200

{
  "action" : "string",
  "startTime" : "2020-01-01T12:34:56Z"
}

Resources

يحدد Azure CycleCloud مجموعة من نماذج الموارد التي تصف المجموعات وصفائف العقد والعقد وحالة التخصيص. يتم إرجاع هذه الموارد بواسطة واجهة برمجة تطبيقات REST وتوفر تفاصيل مثل حدود السعة والاستخدام وحالة نظام المجموعة. استخدم هذا المرجع لفهم بنية وخصائص استجابات واجهة برمجة التطبيقات عند إدارة أنظمة مجموعات CycleCloud ومراقبتها برمجيا.

نظام مجموعة نظام المجموعة

حالة نظام المجموعة

Name Description Schema
maxCoreCount
مطلوب		 الحد الأقصى لعدد الذاكرات الأساسية التي يمكن إضافتها إلى نظام المجموعة هذا
مثال : 16		 integer
الحد الأقصى لعدد الحسابات
مطلوب		 الحد الأقصى لعدد العقد التي يمكن إضافتها إلى نظام المجموعة هذا
مثال : 4		 integer
nodearrays
مطلوب		 مثال : [ "object" ] < nodearrays> الصفيف
nodes
optional		 قائمة اختيارية بالعقد في نظام المجموعة هذا، مضمنة فقط إذا كانت العقد =true في الاستعلام
مثال : [ "[node](#node)" ]		 < عقده> الصفيف
state
optional		 الحالة الحالية للمجموعة، متوفرة بعد بدء تشغيل واحد على الأقل
مثال : "Starting"		 string
حالة الهدف
optional		 الحالة المطلوبة لنظام المجموعة (على سبيل المثال، تم البدء أو الإنهاء)
مثال : "Started"		 string

nodearrays

Name Description Schema
الدلاء
مطلوب		 كل مستودع تخصيص لهذا nodearray. دائما ما تكون إعدادات "عدد الذاكرة الأساسية" متعددة من العدد الأساسي لهذا المستودع.
مثال : [ "object" ]		 < الدلاء> الصفيف
maxCoreCount
مطلوب		 الحد الأقصى لعدد الذاكرات الأساسية التي قد تكون في nodearray
مثال : 16		 integer
الحد الأقصى لعدد الحسابات
مطلوب		 الحد الأقصى لعدد العقد التي قد تكون في nodearray
مثال : 4		 integer
name
مطلوب		 اسم nodearray
مثال : "execute"		 string
nodearray
مطلوب		 سمات nodearray هذا
مثال : "[node](#node)"		 Node

الدلاء

Name Description Schema
activeCoreCount
مطلوب		 عدد الذاكرات الأساسية المستخدمة لهذا المستودع، في nodearray هذا
مثال : 40		 integer
حساب نشط
مطلوب		 عدد العقد المستخدمة لهذا المستودع، في nodearray هذا. يتضمن هذا الرقم العقد التي لا تزال تحصل على جهاز ظاهري.
مثال : 10		 integer
activeNodes
optional		 أسماء العقد المستخدمة لهذا المستودع داخل nodearray، بما في ذلك العقد التي لا تزال تحصل على جهاز ظاهري. يتم إرجاعه فقط عندما يتضمن الاستعلام العقد =true.
مثال : [ "string" ]		 <صفيف سلسلة >
عدد الحسابات المتوفرة
مطلوب		 كم عدد الذاكرات الأساسية الإضافية التي يمكن إنشاؤها في هذا المستودع، في nodearray هذا. دائما مضاعف من عدد المتوفرة.
مثال : 8		 integer
عدد متوفر
مطلوب		 عدد العقد الإضافية التي يمكن إنشاؤها في هذا المستودع داخل nodearray. يمكن أن تكون القيمة أقل من maxCount علامة الطرح usedCount لأنه maxCount قد يتم تحديدها بحد عمومي.
مثال : 2		 integer
معرف المستودع
مطلوب		 المعرف الفريد للمستودع. تظل القيمة كما هي بالنسبة إلى مستودع معين في nodearray طوال مدة بقاء نظام المجموعة.
مثال : "00000000-0000-0000-0000-000000000000"		 string
عدد الحسابات المستهلكة
مطلوب		 عدد الذاكرات الأساسية لهذه العائلة المستخدمة بالفعل في جميع أنحاء المنطقة بأكملها.
مثال : 2		 integer
definition
optional		 الخصائص المستخدمة لإنشاء العقد من هذا المستودع. تأخذ واجهة برمجة تطبيقات عقد الإنشاء هذا التعريف في الخاصية الخاصة بها bucket .
مثال : "object"		 definition
familyConsumedCoreCount
optional		 عدد الذاكرات الأساسية لهذه العائلة المستخدمة بالفعل في جميع أنحاء المنطقة بأكملها.
مثال : 2		 integer
familyQuotaCoreCount
optional		 العدد الإجمالي للنوى التي يمكن تشغيلها لعائلة الجهاز الظاهري هذه في المنطقة. القيمة ليست بالضرورة مضاعف عدد صحيح ل familyQuotaCount.
مثال : 16		 integer
حساب مجموعة العائلة
optional		 عدد المثيلات الإجمالية التي يمكن بدء تشغيلها (نظرا إلى familyQuotaCoreCount)
مثال : 4		 integer
invalidReason
مطلوب		 سبب عدم صلاحية المستودع عندما valid يكون خطأ. حاليا، القيم الوحيدة الممكنة هي NotActivated و DisabledMachineType.
مثال : "DisabledMachineType"		 string
LastCapacityFailure
مطلوب		 عدد الثوان منذ أن واجه هذا المستودع فشلا في السعة. يتم التعامل مع أي قيمة سالبة على أنها أبدا.
مثال : 180.0		 number
maxCoreCount
مطلوب		 الحد الأقصى لعدد الذاكرات الأساسية التي قد تكون في هذا المستودع، بما في ذلك الحدود العمومية وحدود nodearray. دائما مضاعف maxCount.
مثال : 16		 integer
الحد الأقصى لعدد الحسابات
مطلوب		 الحد الأقصى لعدد العقد التي قد تكون في هذا المستودع، بما في ذلك الحدود العمومية وحدود nodearray
مثال : 4		 integer
maxPlacementGroupCoreSize
مطلوب		 الحد الأقصى لإجمالي عدد الذاكرات الأساسية التي يمكن أن تكون في مجموعة موضع في هذا المستودع. دائما مضاعف maxPlacementGroupSize.
مثال : 64		 integer
maxPlacementGroupSize
مطلوب		 الحد الأقصى لإجمالي عدد المثيلات التي يمكن أن تكون في مجموعة موضع في هذا المستودع
مثال : 16		 integer
مجموعات الموضع
مطلوب		 مجموعات المواضع المستخدمة لهذا nodearray، إن وجدت.
مثال : [ "object" ]		 < مجموعات> الموضع الصفيف
عدد الحصص النسبية
مطلوب		 العدد الإجمالي للنوى التي يمكن تشغيلها لعائلة الجهاز الظاهري هذه في المنطقة، ما يمثل العدد الأساسي للحصص النسبية الإقليمية. القيمة ليست بالضرورة مضاعف عدد صحيح ل quotaCount.
مثال : 16		 integer
عدد الحصص النسبية
مطلوب		 عدد المثيلات الإجمالية التي يمكن بدء تشغيلها (معين quotaCoreCount)
مثال : 4		 integer
regionalConsumedCoreCount
optional		 عدد الذاكرات الأساسية المستخدمة بالفعل عبر المنطقة بأكملها.
مثال : 2		 integer
المنطقةQuotaCoreCount
optional		 العدد الإجمالي للذاكرات الأساسية التي يمكن تشغيلها في المنطقة. القيمة ليست بالضرورة مضاعف عدد صحيح ل regionalQuotaCount.
مثال : 16		 integer
عدد المناطق الإقليمية
optional		 عدد المثيلات الإجمالية التي يمكن بدء تشغيلها (بالنظر إلى regionalQuotaCoreCount)
مثال : 4		 integer
موضع موضع موضعي
مطلوب		 درجة الموضع الموضعي لهذا المستودع تشير إلى احتمال توفر الجهاز الظاهري الموضعي. يمكن أن تكون سلسلة عالية أو متوسطة أو منخفضة أو فارغة إذا لم تكن قابلة للتطبيق.
مثال : "High"		 string
ساري
مطلوب		 إذا كان صحيحا، يمثل هذا المستودع مستودعا صالحا حاليا لاستخدامه للعقد الجديدة. إذا كانت خاطئة، فإن هذا المستودع يمثل العقد الموجودة فقط.
مثال : true		 boolean
الجهاز الظاهري
مطلوب		 خصائص الأجهزة الظاهرية التي تم تشغيلها من هذا المستودع
مثال : "object"		 الجهاز الظاهري

تعريف

Name Description Schema
نوع الجهاز
مطلوب		 حجم الجهاز الظاهري للجهاز الظاهري
مثال : "A2"		 string

مجموعات الموضع

Name Description Schema
activeCoreCount
مطلوب		 كم عدد الذاكرات الأساسية في مجموعة التحجيم هذه
مثال : 16		 integer
حساب نشط
مطلوب		 عدد العقد الموجودة في مجموعة المقياس هذه
مثال : 4		 integer
name
مطلوب		 المعرف الفريد لمجموعة المواضع هذه
مثال : "my-placement-group"		 string

الجهاز الظاهري

Name Description Schema
gpuCount
مطلوب		 عدد وحدات معالجة الرسومات (GPUs) التي يحتويها هذا النوع من الأجهزة
مثال : 2		 integer
infiniband
مطلوب		 إذا كان هذا الجهاز الظاهري يدعم اتصال InfiniBand
مثال : true		 boolean
الذاكره
مطلوب		 ذاكرة الوصول العشوائي في هذا الجهاز الظاهري، بالجيجابايت
مثال : 7.5		 number
عدد وحدات المعالجة المركزية
مطلوب		 عدد وحدات المعالجة المركزية الفعلية لهذا النوع من الأجهزة
مثال : 16		 integer
vcpuCount
مطلوب		 عدد وحدات المعالجة المركزية الظاهرية التي يحتويها هذا النوع من الأجهزة
مثال : 32		 integer
vcpuQuotaCount
optional		 عدد وحدات المعالجة المركزية الظاهرية التي يستخدمها هذا الجهاز من الحصة النسبية
مثال : 2		 integer

استخدام نظام المجموعة

معلومات الاستخدام والتكلفة الاختيارية للمجموعة

Name Description Schema
استخدام
مطلوب		 قائمة بالاستخدامات حسب الفاصل الزمني
مثال : [ "object" ]		 < استخدام> الصفيف

استخدام

Name Description Schema
انهيار
مطلوب		 تصنيف الاستخدام في هذا الفاصل الزمني، حسب فئة "العقدة" و"nodearray"
مثال : [ "[clusterusageitem](#clusterusageitem)" ]		 < ClusterUsageItem> الصفيف
end
مطلوب		 نهاية الفاصل الزمني (خاص)
مثال : "string"		 string
start
مطلوب		 بداية الفاصل الزمني (شامل)
مثال : "string"		 string
total
مطلوب		 الاستخدام الإجمالي لهذه المجموعة في هذا الفاصل الزمني، مع فئة "نظام المجموعة"
مثال : "[clusterusageitem](#clusterusageitem)"		 ClusterUsageItem

ClusterUsageItem

Name Description Schema
category
مطلوب		 "نظام المجموعة" للاستخدام الكلي؛ "عقدة" لعقدة رأس واحدة غير صفيف؛ "nodearray" ل nodearray بأكمله
مثال : "string"		 تعداد (نظام المجموعة، العقدة، nodearray)
تكلفه
optional		 المبلغ الذي سيتم تحصيله مقابل هذا الاستخدام بالدولار الأمريكي وأسعار التجزئة. ملاحظة: جميع مبالغ التكلفة هي تقديرات ولا تعكس الفاتورة الفعلية!
مثال : 0.0		 number
details
optional		 تفاصيل حجم الجهاز الظاهري الذي يستخدمه nodearray بما في ذلك الساعات core_count والمنطقة والأولوية ونظام التشغيل.
مثال : [ "object" ]		 < التفاصيل> الصفيف
hours
مطلوب		 عدد ساعات الاستخدام الأساسية لهذه الفئة
مثال : 0.0		 number
node
optional		 اسم العقدة أو nodearray الذي يستخدمه (غير موجود للبيانات على مستوى نظام المجموعة)
مثال : "string"		 string

التفاصيل

Name Description Schema
core_count
optional		 عدد الذاكرات الأساسية في حجم الجهاز الظاهري هذا
مثال : 0.0		 number
تكلفه
optional		 تكلفة حجم الجهاز الظاهري هذا
مثال : 0.0		 number
hours
optional		 عدد ساعات الاستخدام الأساسية لحجم الجهاز الظاهري هذا
مثال : 0.0		 number
Os
optional		 نوع نظام التشغيل
مثال : "string"		 قائمة تعداد (Windows، Linux)
أولوية
optional		 أولوية VM SKU
مثال : "string"		 قائمة تعداد (عادية، موضعية)
region
optional		 المنطقة التي يتم إنشاء مثيل لحجم الجهاز الظاهري فيها
مثال : "string"		 string
vm_size
optional		 حجم VM SKU
مثال : "string"		 string

Node

سجل عقدة

النوع: كائن

طلب إنشاء العقدة

تحديد كيفية إضافة عقد إلى نظام مجموعة

Name Description Schema
معرف الطلب
optional		 رمز مميز فريد اختياري يوفره المستخدم لمنع العمليات المكررة إذا كانت هناك أخطاء في اتصال الشبكة. إذا تم تضمين هذه القيمة وتطابق معرف طلب سابق، يتجاهل الخادم هذا الطلب ويرجع خطأ 409.
مثال : "00000000-0000-0000-0000-000000000000"		 string
مجموعات
مطلوب		 قائمة تعريفات العقدة المراد إنشاؤها. يجب أن يحتوي الطلب على مجموعة واحدة على الأقل. يمكن لكل مجموعة تحديد مجموعة مختلفة من الخصائص.
مثال : [ "object" ]		 < مجموعات> الصفيف

مجموعات

Name Description Schema
count
مطلوب		 عدد العقد المراد إنشاؤها
مثال : 1		 integer
definition
optional		 تعريف المستودع المراد استخدامه، الذي يوفره استدعاء واجهة برمجة تطبيقات حالة نظام المجموعة. إذا كانت بعض العناصر المحددة في استدعاء الحالة مفقودة، أو كانت خاصية المستودع بأكملها مفقودة، يتم استخدام المستودع الأول الذي يطابق العناصر المحددة.
مثال : "object"		 definition
تنسيق الاسم
optional		 إذا تم منحها، تستخدم العقد اصطلاح التسمية هذا بدلا من تنسيق "nodearray-%d" القياسي
مثال : "custom-name-%d"		 string
nameOffset
optional		 إذا تم منحه، جنبا إلى جنب مع nameFormat، يعوض فهرس العقدة للعقد الجديدة.
مثال : 1		 integer
nodeAttributes
optional		 السمات الإضافية التي سيتم تعيينها على كل عقدة من هذه المجموعة
مثال : "[node](#node)"		 Node
nodearray
مطلوب		 اسم nodearray لبدء العقد من
مثال : "execute"		 string
معرف مجموعة الموضع
optional		 إذا تم منحها، فإن العقد التي لها نفس القيمة groupId تبدأ جميعها في نفس مجموعة الموضع.
مثال : "string"		 string

تعريف

Name Description Schema
نوع الجهاز
optional		 مثال : "A2" string

NodeCreationResult

Name Description Schema
operationId
مطلوب		 معرف هذه العملية
مثال : "00000000-0000-0000-0000-000000000000"		 string
مجموعات
مطلوب		 صفيف من المجموعات، بالترتيب نفسه كما في الطلب
مثال : [ "object" ]		 < مجموعات> الصفيف

مجموعات

Name Description Schema
اضيف
مطلوب		 عدد العقد التي تم بدء تشغيلها في هذه المجموعة
مثال : 1		 integer
message
optional		 يشير إلى سبب عدم إمكانية إضافة جميع العقد المطلوبة، إذا كانت موجودة
مثال : "string"		 string

NodeList

نتائج بحث العقدة

Name Description Schema
nodes
مطلوب		 العقد التي تم إرجاعها
مثال : [ "[node](#node)" ]		 < عقده> الصفيف
operation
optional		 حالة العملية إذا كان الاستعلام يتضمن معرف عملية
مثال : "[operationstatus](#operationstatus)"		 حالة العمليات

طلب إدارة العقدة

تحديد كيفية تنفيذ الإجراءات على العقد في نظام مجموعة. هناك طرق متعددة لتحديد العقد، وإذا تم تضمين أكثر من طريقة واحدة، يتم التعامل معها على أنها اتحاد.

Name Description Schema
filter
optional		 تعبير عامل تصفية يطابق العقد. يجب اقتباس السلاسل في التعبير بشكل صحيح.
مثال : "State === \"Started\""		 string
أسماء المضيفين
optional		 قائمة بأسماء المضيفين القصيرة (بدون مجال) لإدارتها
مثال : [ "hostname1", "hostname2" ]		 <صفيف سلسلة >
معرفات
optional		 قائمة معرفات العقدة المراد إدارتها
مثال : [ "id1", "id2" ]		 <صفيف سلسلة >
ip_addresses
optional		 قائمة بعناوين IP لإدارتها
مثال : [ "10.0.1.1", "10.1.1.2" ]		 <صفيف سلسلة >
اسماء
optional		 قائمة بأسماء العقد المراد إدارتها
مثال : [ "name1", "name2" ]		 <صفيف سلسلة >
معرف الطلب
optional		 رمز مميز فريد اختياري يوفره المستخدم لمنع العمليات المكررة إذا كانت هناك أخطاء في اتصال الشبكة. إذا تم تضمين هذه القيمة وتطابق معرف طلب سابق، يتجاهل الخادم هذا الطلب ويرجع خطأ 409.
مثال : "00000000-0000-0000-0000-000000000000"		 string

NodeManagementResult

Name Description Schema
nodes
مطلوب		 صفيف من المعلومات حول كل عقدة تطابق عامل التصفية في طلب الإدارة. تشير حالة كل عقدة إلى ما إذا كان الطلب قد أثر عليها.
مثال : [ "object" ]		 < العقد> الصفيف
operationId
مطلوب		 معرف هذه العملية
مثال : "00000000-0000-0000-0000-000000000000"		 string

العقد

Name Description Schema
error
optional		 رسالة الخطأ عندما status تكون Error.
مثال : "This node must be terminated before it can be removed"		 string
id
مطلوب		 معرف العقدة
مثال : "id1"		 string
name
مطلوب		 اسم العقدة
مثال : "name1"		 string
status
optional		 واحد من موافق أو خطأ
مثال : "Error"		 قائمة تعداد (موافق، خطأ)

OperationStatus

حالة عملية العقدة هذه

Name Description Schema
action
مطلوب		 مثال : "string" قائمة تعداد (إنشاء)
startTime
مطلوب		 عند إرسال هذه العملية
مثال : "2020-01-01T12:34:56Z"		 السلسلة (التاريخ-الوقت)
  • Last updated on