مشاركة عبر

Operations

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

GET /clusters/{cluster}/nodes

Parameters

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

Responses

HTTP Code Description Schema
200 OK NodeList
400 Invalid specification No Content
404 Not found No Content

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/nodes

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

Response 200

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

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

POST /clusters/{cluster}/nodes/create

Description

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

Parameters

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

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (سلسلة) : عنوان URL للعملية.		 NodeCreationResult
409 Invalid input No Content

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/nodes/create

Request body

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

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

Response 202

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

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

POST /clusters/{cluster}/nodes/deallocate

Description

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

Parameters

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

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (سلسلة) : عنوان URL للعملية.		 NodeManagementResult
409 Invalid input No Content

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/nodes/deallocate

Request body

{
  "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

Response 202

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

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

POST /clusters/{cluster}/nodes/remove

Description

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

Parameters

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

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (سلسلة) : عنوان URL للعملية.		 NodeManagementResult
409 Invalid input No Content

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/nodes/remove

Request body

{
  "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

Response 202

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

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

POST /clusters/{cluster}/nodes/shutdown

Description

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

Parameters

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

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (سلسلة) : عنوان URL للعملية.		 NodeManagementResult
409 Invalid input No Content

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/nodes/shutdown

Request body

{
  "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

Response 202

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

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

POST /clusters/{cluster}/nodes/start

Description

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

Parameters

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

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (سلسلة) : عنوان URL للعملية.		 NodeManagementResult
409 Invalid input No Content

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/nodes/start

Request body

{
  "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

Response 202

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

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

POST /clusters/{cluster}/nodes/terminate

Description

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

Parameters

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

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (سلسلة) : عنوان URL للعملية.		 NodeManagementResult
409 Invalid input No Content

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/nodes/terminate

Request body

{
  "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

Response 202

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

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

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

Description

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

Parameters

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

Responses

HTTP Code Description Schema
202 Accepted
Headers :
Location (سلسلة) : عنوان URL للعملية.		 NodeCreationResult
409 Invalid input No Content

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

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

Response 202

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

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

GET /clusters/{cluster}/status

Description

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

Parameters

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

Responses

HTTP Code Description Schema
200 OK ClusterStatus

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/status

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

Response 200

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

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

GET /clusters/{cluster}/usage

Description

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

Parameters

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

Responses

HTTP Code Description Schema
200 OK ClusterUsage

مثال طلب HTTP

Request path

/clusters/CLUSTER_NAME/usage

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

Response 200

{
  "usage" : [ "object" ]
}

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

GET /operations/

Parameters

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

Responses

HTTP Code Description Schema
200 OK < OperationStatus> array
400 Invalid request No Content
404 Not found No Content

مثال طلب HTTP

Request path

/operations/

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

Response 200

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

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

GET /operations/{id}

Parameters

Type Name Description Schema
Path id
required		 معرف العملية string

Responses

HTTP Code Description Schema
200 OK OperationStatus
404 Not found No Content

مثال طلب HTTP

Request path

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

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

Response 200

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

Resources

ClusterStatus

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

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

nodearrays

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

buckets

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

definition

Name Description Schema
machineType
required		 حجم الجهاز الظاهري للجهاز الظاهري
Example : "A2"		 string

placementGroups

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

virtualMachine

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

ClusterUsage

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

Name Description Schema
usage
required		 قائمة بالاستخدامات حسب الفاصل الزمني
Example : [ "object" ]		 < usage> array

usage

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

ClusterUsageItem

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

details

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

Node

سجل عقدة.

Type : object

NodeCreationRequest

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

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

sets

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

definition

Name Description Schema
machineType
optional		 Example : "A2" string

NodeCreationResult

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

sets

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

NodeList

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

Name Description Schema
nodes
required		 العقد التي يرجعها النظام
Example : [ "[node](#node)" ]		 < Node> array
operation
optional		 إذا كان الاستعلام يتضمن معرف عملية، يعرض هذا الحقل حالة تلك العملية
Example : "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

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

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

NodeManagementResult

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

nodes

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

OperationStatus

حالة عملية العقدة.

Name Description Schema
action
required		 Example : "string" enum (create)
startTime
required		 عند إرسال العملية
Example : "2020-01-01T12:34:56Z"		 string (date-time)
  • Last updated on