Operations

Azure CycleCloud menyediakan REST API untuk mengelola kluster, simpul, dan sumber daya terkait secara terprogram. Gunakan operasi API ini untuk mengkueri status kluster, membuat dan mengelola simpul, dan melacak operasi yang berjalan lama. Referensi ini mencantumkan titik akhir, parameter, dan format respons yang tersedia untuk membantu Anda mengotomatiskan dan mengintegrasikan manajemen kluster CycleCloud ke dalam alur kerja Anda.

Mendapatkan node kluster

GET /clusters/{cluster}/nodes

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster yang akan dikueri	string
Query	operation optional	Jika diberikan, hanya mengembalikan simpul untuk ID operasi ini, dan menyertakan atribut operasi pada isi	string
Query	request_id optional	Jika diberikan, hanya mengembalikan simpul untuk operasi yang diidentifikasi oleh ID permintaan ini, dan menyertakan atribut operasi pada isi	string

Responses

Kode HTTP	Description	Schema
200	OK	NodeList
400	Spesifikasi tidak valid	Tidak Ada Isi
404	Tidak ditemukan	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes

Contoh respons HTTP

Respons 200

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

Membuat node kluster

POST /clusters/{cluster}/nodes/create

Description

Operasi ini menambahkan simpul baru dari nodearray ke kluster. Ini menerima beberapa definisi simpul dalam satu panggilan. Ini mengembalikan URL ke operasi yang dapat digunakan untuk melacak status operasi.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk menambahkan simpul ke	string
Body	nodes required	Set simpul yang akan dibuat	NodeCreationRequest

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeCreationResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/create

Badan permintaan

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

Contoh respons HTTP

Respons 202

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

Membatalkan alokasi node kluster

POST /clusters/{cluster}/nodes/deallocate

Description

Operasi ini membatalkan alokasi simpul dalam kluster. Simpul dapat diidentifikasi dengan beberapa cara, termasuk nama simpul, ID simpul, atau menurut filter.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk membatalkan alokasi simpul di	string
Body	action required	Deskripsi simpul mana yang akan dibatalkan alokasinya	NodeManagementRequest

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeManagementResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/deallocate

Badan permintaan

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

Contoh respons HTTP

Respons 202

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

Gambar ulang node kluster

POST /clusters/{cluster}/nodes/reimage

Description

Operasi ini menggambar ulang simpul dalam kluster. Simpul dapat diidentifikasi dengan beberapa cara, termasuk nama simpul, ID simpul, atau menurut filter.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk menggambar ulang node di	string
Body	action required	Deskripsi simpul mana yang akan dicitrakan ulang	NodeManagementRequest

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeManagementResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/reimage

Badan permintaan

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

Contoh respons HTTP

Respons 202

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

Menghentikan dan menghapus node kluster

POST /clusters/{cluster}/nodes/remove

Description

Operasi ini menghapus simpul dalam kluster. Anda dapat mengidentifikasi simpul berdasarkan nama node, ID simpul, atau filter. Secara default, CycleCloud menghapus simpul saat penghentian, sehingga panggilan ini berulah seperti dihentikan. Simpul dengan atribut Tetap yang diatur ke true tidak dihapus saat penghentian.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk menghapus simpul di	string
Body	action required	Deskripsi simpul mana yang akan dihapus	NodeManagementRequest

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeManagementResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/remove

Badan permintaan

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

Contoh respons HTTP

Respons 202

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

Menghidupkan ulang node kluster

POST /clusters/{cluster}/nodes/restart

Description

Operasi ini memulai ulang simpul dalam kluster. Simpul dapat diidentifikasi dengan beberapa cara, termasuk nama simpul, ID simpul, atau menurut filter.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk menghidupkan ulang simpul di	string
Body	action required	Deskripsi simpul mana yang akan dimulai ulang	NodeManagementRequest

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeManagementResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/restart

Badan permintaan

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

Contoh respons HTTP

Respons 202

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

Menghentikan atau membatalkan alokasi node kluster

POST /clusters/{cluster}/nodes/shutdown

Description

Panggilan ini mematikan simpul dalam kluster. Atribut ShutdownPolicy setiap simpul memutuskan tindakan: Hentikan (default) atau Batalkan alokasi.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk mematikan simpul di	string
Body	action required	Deskripsi simpul mana yang akan dimatikan	NodeManagementRequest

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeManagementResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/shutdown

Badan permintaan

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

Contoh respons HTTP

Respons 202

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

Mulai batalkan alokasi atau hentikan node kluster

POST /clusters/{cluster}/nodes/start

Description

Operasi ini memulai simpul dalam kluster. Simpul dapat diidentifikasi dengan beberapa cara, termasuk nama simpul, ID simpul, atau menurut filter.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk memulai simpul di	string
Body	action required	Deskripsi simpul mana yang akan dimulai	NodeManagementRequest

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeManagementResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/start

Badan permintaan

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

Contoh respons HTTP

Respons 202

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

Menghentikan node kluster

POST /clusters/{cluster}/nodes/terminate

Description

Operasi ini mengakhiri simpul dalam kluster. Simpul dapat diidentifikasi dengan beberapa cara, termasuk nama simpul, ID simpul, atau menurut filter.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk mengakhiri simpul di	string
Body	action required	Deskripsi simpul mana yang akan dihentikan	NodeManagementRequest

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeManagementResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/terminate

Badan permintaan

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

Contoh respons HTTP

Respons 202

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

Kirim Laporan Kesehatan Tamu untuk node kluster

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

Description

Mengirimkan laporan kesehatan untuk node dengan masalah kesehatan

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster yang berisi simpul untuk dilaporkan	string
Path	node required	Simpul yang akan dilaporkan	string
Query	category optional	Kategori Laporan Kesehatan Tamu untuk dampaknya	string
Query	deskripsi optional	Pesan kustom yang menjelaskan kegagalan atau konteks	string

Responses

Kode HTTP	Description	Schema
202	Diterima	Tidak Ada Isi
400	Input tidak valid	Tidak Ada Isi
404	Tidak Ditemukan	Tidak Ada Isi
409	Konflik - Laporan Kesehatan Tamu sudah dikirimkan untuk simpul ini	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/string/ghr

Dapatkan Laporan Kesehatan Tamu untuk node kluster

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

Description

Mengembalikan dampak beban kerja simpul dengan masalah kesehatan, sehingga Anda dapat mengirimkannya ke titik akhir pelaporan kesehatan.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster yang berisi simpul untuk dilaporkan	string
Path	node required	Simpul yang akan dilaporkan	string
Query	category optional	Kategori Laporan Kesehatan Tamu untuk dampaknya	string
Query	deskripsi optional	Pesan kustom yang menjelaskan kegagalan atau konteks	string

Responses

Kode HTTP	Description	Schema
200	Oke	Tidak Ada Isi
400	Input tidak valid	Tidak Ada Isi
404	Tidak Ditemukan	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/nodes/string/ghr

Skalakan kluster ke ukuran

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

Description

Operasi ini menambahkan simpul sesuai kebutuhan ke nodearray untuk mencapai jumlah total. Permintaan diproses satu kali dan tidak menambahkan kembali simpul nanti untuk mempertahankan nomor yang diberikan. Tentukan ukuran target menggunakan ( totalCoreCount total inti CPU) atau totalNodeCount (total VM), tetapi tidak keduanya dalam permintaan yang sama. Ini mengembalikan URL ke operasi yang dapat Anda gunakan untuk melacak statusnya.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk menambahkan simpul ke	string
Path	nodearray required	Nodearray untuk menambahkan simpul ke	string
Query	totalCoreCount optional	Jumlah total inti yang harus dimiliki dalam nodearray ini, termasuk simpul yang sudah dibuat	integer
Query	totalNodeCount optional	Jumlah total komputer yang harus dimiliki dalam nodearray ini, termasuk simpul yang sudah dibuat	integer

Responses

Kode HTTP	Description	Schema
202	Diterima Header : Location (string): URL untuk operasi.	NodeCreationResult
409	Input tidak valid	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/scale/NODEARRAY_NAME

Contoh respons HTTP

Respons 202

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

Mendapatkan status kluster

GET /clusters/{cluster}/status

Description

Operasi ini berisi informasi untuk node dan nodearrays dalam kluster tertentu. Untuk setiap nodearray, ia mengembalikan status setiap "bucket" alokasi yang tersedia. Status ini mencakup jumlah simpul saat ini dalam wadah dan berapa banyak lagi simpul yang dapat Anda tambahkan. Setiap wadah adalah sekumpulan kemungkinan VM dari profil perangkat keras tertentu yang dapat dibuat di lokasi tertentu di bawah akun pelanggan tertentu, dll. Definisi kluster pengguna menentukan wadah yang valid untuk nodearray, tetapi penyedia cloud sebagian menentukan batas.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster yang akan dikueri	string
Query	nodes optional	Jika true, node dan referensi node dikembalikan dalam respons	boolean

Responses

Kode HTTP	Description	Schema
200	OK	ClusterStatus

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/status

Contoh respons HTTP

Respons 200

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

Mendapatkan informasi penggunaan dan biaya opsional untuk kluster

GET /clusters/{cluster}/usage

Description

Operasi ini mengembalikan data penggunaan keseluruhan (jam inti) dan data biaya, jika tersedia, untuk kluster, dan perincian per nodearray. Secara default mengembalikan nilai penggunaan bulan ini.

Parameters

Type	Name	Description	Schema
Path	cluster required	Kluster untuk mengembalikan data penggunaan untuk	string
Query	Jangka waktu optional	Rentang waktu yang digunakan untuk kueri. Nilai yang valid: monthToDate (bulan saat ini), lastMonth (bulan sebelumnya), weekToDate (minggu saat ini, mulai Minggu), atau custom (memerlukan from parameter kueri dan to ). Defaultnya adalah monthToDate. Semua waktu berada dalam UTC.	enum (monthToDate, lastMonth, weekToDate, custom)
Query	from optional	Untuk jangka waktu kustom, nilai ini adalah awal jangka waktu dalam format ISO-8601. Ini dibulatkan ke bawah ke jam atau hari terdekat.	string
Query	to optional	Untuk jangka waktu kustom, nilai ini adalah akhir jangka waktu dalam format ISO-8601. Ini dibulatkan ke atas ke jam atau hari terdekat.	string
Query	Granularity optional	Menentukan cara mengagregasi data: per jam, harian, atau sebagai total tunggal. Interval default adalah harian.	enum (total, harian, per jam)

Responses

Kode HTTP	Description	Schema
200	OK	ClusterUsage

Contoh permintaan HTTP

Jalur permintaan

/clusters/CLUSTER_NAME/usage

Contoh respons HTTP

Respons 200

{
  "usage" : [ "object" ]
}

Mencantumkan status operasi

GET /operations/

Parameters

Type	Name	Description	Schema
Query	request_id optional	ID permintaan untuk operasi. Jika nilai ini diberikan, daftar berisi 0 atau 1 elemen.	string

Responses

Kode HTTP	Description	Schema
200	OK	< OperationStatus> Array
400	Permintaan tidak valid	Tidak Ada Isi
404	Tidak ditemukan	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

/operations/

Contoh respons HTTP

Respons 200

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

Mendapatkan status operasi menurut ID

GET /operations/{id}

Parameters

Type	Name	Description	Schema
Path	id required	ID operasi	string

Responses

Kode HTTP	Description	Schema
200	OK	OperationStatus
404	Tidak ditemukan	Tidak Ada Isi

Contoh permintaan HTTP

Jalur permintaan

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

Contoh respons HTTP

Respons 200

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

Resources

Azure CycleCloud mendefinisikan sekumpulan model sumber daya yang menjelaskan kluster, array node, simpul, dan status alokasi. Sumber daya ini dikembalikan oleh REST API dan memberikan detail seperti batas kapasitas, penggunaan, dan status kluster. Gunakan referensi ini untuk memahami struktur dan properti respons API saat mengelola dan memantau kluster CycleCloud secara terprogram.

ClusterStatus

Status kluster

Name	Description	Schema
maxCoreCount required	Jumlah maksimum inti yang dapat ditambahkan ke kluster ini Contoh : 16	integer
maxCount required	Jumlah maksimum simpul yang dapat ditambahkan ke kluster ini Contoh : 4	integer
nodearrays required	Contoh : [ "object" ]	< nodearrays> Array
nodes optional	Daftar opsional simpul dalam kluster ini, hanya disertakan jika node=true ada dalam kueri Contoh : [ "[node](#node)" ]	< Node> Array
state optional	Status kluster saat ini, tersedia setelah setidaknya satu mulai Contoh : "Starting"	string
targetState optional	Status kluster yang diinginkan (misalnya, Dimulai atau Dihentikan) Contoh : "Started"	string

nodearrays

Name	Description	Schema
Ember required	Setiap wadah alokasi untuk nodearray ini. Pengaturan "jumlah inti" selalu merupakan kelipatan dari jumlah inti untuk wadah ini. Contoh : [ "object" ]	< Ember> Array
maxCoreCount required	Jumlah maksimum inti yang mungkin ada dalam nodearray ini Contoh : 16	integer
maxCount required	Jumlah maksimum simpul yang mungkin ada di nodearray ini Contoh : 4	integer
name required	Nama nodearray Contoh : "execute"	string
nodearray required	Atribut nodearray ini Contoh : "[node](#node)"	Node

Ember

Name	Description	Schema
activeCoreCount required	Jumlah inti yang digunakan untuk wadah ini, dalam nodearray ini Contoh : 40	integer
activeCount required	Jumlah simpul yang digunakan untuk wadah ini, dalam nodearray ini. Jumlah ini mencakup simpul yang masih memperoleh VM. Contoh : 10	integer
activeNodes optional	Nama simpul yang digunakan untuk wadah ini dalam nodearray, termasuk simpul yang masih memperoleh VM. Dikembalikan hanya ketika kueri menyertakan node=true. Contoh : [ "string" ]	<array string >
availableCoreCount required	Berapa banyak core tambahan yang dapat dibuat dalam wadah ini, dalam nodearray ini. Selalu beberapa availableCount. Contoh : 8	integer
availableCount required	Jumlah simpul tambahan yang dapat dibuat dalam wadah ini dalam nodearray. Nilai dapat lebih rendah dari maxCount minus usedCount karena maxCount dapat dibatasi oleh batas global. Contoh : 2	integer
bucketId required	Pengidentifikasi unik untuk wadah. Nilainya tetap sama untuk wadah tertentu dalam nodearray selama masa pakai kluster. Contoh : "00000000-0000-0000-0000-000000000000"	string
consumedCoreCount required	Jumlah inti untuk keluarga ini yang sudah digunakan di seluruh wilayah. Contoh : 2	integer
definition optional	Properti yang digunakan untuk membuat simpul dari wadah ini. API create-node mengambil definisi ini dalam propertinya bucket . Contoh : "object"	definition
familyConsumedCoreCount optional	Jumlah inti untuk keluarga ini yang sudah digunakan di seluruh wilayah. Contoh : 2	integer
familyQuotaCoreCount optional	Jumlah total inti yang dapat berjalan untuk keluarga VM ini di wilayah tersebut. Nilai belum tentu merupakan bilangan bulat kelipatan familyQuotaCount. Contoh : 16	integer
familyQuotaCount optional	Jumlah total instans yang dapat dimulai (diberikan familyQuotaCoreCount) Contoh : 4	integer
invalidReason required	Alasan wadah tidak valid ketika valid false. Saat ini, satu-satunya nilai yang mungkin adalah NotActivated dan DisabledMachineType. Contoh : "DisabledMachineType"	string
lastCapacityFailure required	Jumlah detik sejak wadah ini mengalami kegagalan kapasitas. Nilai negatif apa pun diperlakukan sebagai tidak pernah. Contoh : 180.0	number
maxCoreCount required	Jumlah maksimum inti yang mungkin ada di wadah ini, termasuk batas global dan nodearray. Selalu kelipatan maxCount. Contoh : 16	integer
maxCount required	Jumlah maksimum simpul yang mungkin ada di wadah ini, termasuk batas global dan nodearray Contoh : 4	integer
maxPlacementGroupCoreSize required	Jumlah total maksimum inti yang dapat berada dalam grup penempatan dalam wadah ini. Selalu kelipatan maxPlacementGroupSize. Contoh : 64	integer
maxPlacementGroupSize required	Jumlah total maksimum instans yang dapat berada dalam grup penempatan dalam wadah ini Contoh : 16	integer
placementGroups required	Grup penempatan yang digunakan untuk nodearray ini, jika ada. Contoh : [ "object" ]	< placementGroups> Array
quotaCoreCount required	Jumlah total inti yang dapat berjalan untuk keluarga VM ini di wilayah tersebut, memperhitungkan jumlah inti kuota regional. Nilai belum tentu merupakan bilangan bulat kelipatan quotaCount. Contoh : 16	integer
quotaCount required	Jumlah total instans yang dapat dimulai (diberikan quotaCoreCount) Contoh : 4	integer
regionalConsumedCoreCount optional	Jumlah inti yang sudah digunakan di seluruh wilayah. Contoh : 2	integer
regionalQuotaCoreCount optional	Jumlah total inti yang dapat berjalan di wilayah tersebut. Nilai belum tentu merupakan bilangan bulat kelipatan regionalQuotaCount. Contoh : 16	integer
regionalQuotaCount optional	Jumlah total instans yang dapat dimulai (diberikan regionalQuotaCoreCount) Contoh : 4	integer
spotPlacementScore required	Skor penempatan spot untuk wadah ini menunjukkan kemungkinan ketersediaan VM spot. Bisa Tinggi, Sedang, Rendah, atau string kosong jika tidak berlaku. Contoh : "High"	string
sah required	Jika true, wadah ini mewakili wadah yang saat ini valid untuk digunakan untuk simpul baru. Jika false, wadah ini hanya mewakili simpul yang ada. Contoh : true	boolean
virtualMachine required	Properti komputer virtual yang diluncurkan dari wadah ini Contoh : "object"	virtualMachine

Definisi

Name	Description	Schema
machineType required	Ukuran VM komputer virtual Contoh : "A2"	string

placementGroups

Name	Description	Schema
activeCoreCount required	Berapa banyak inti dalam set skala ini Contoh : 16	integer
activeCount required	Berapa banyak simpul dalam set skala ini Contoh : 4	integer
name required	Pengidentifikasi unik grup penempatan ini Contoh : "my-placement-group"	string

virtualMachine

Name	Description	Schema
gpuCount required	Jumlah GPU yang dimiliki komputer ini Contoh : 2	integer
infiniband required	Jika komputer virtual ini mendukung konektivitas InfiniBand Contoh : true	boolean
memory required	RAM di komputer virtual ini, dalam GB Contoh : 7.5	number
pcpuCount required	Jumlah CPU fisik yang dimiliki mesin ini Contoh : 16	integer
vcpuCount required	Jumlah CPU virtual yang dimiliki komputer ini Contoh : 32	integer
vcpuQuotaCount optional	Jumlah vCPU yang digunakan komputer ini dari kuota Contoh : 2	integer

ClusterUsage

Informasi penggunaan dan biaya opsional untuk kluster

Name	Description	Schema
usage required	Daftar penggunaan menurut interval waktu Contoh : [ "object" ]	< Penggunaan> Array

Penggunaan

Name	Description	Schema
Rincian required	Perincian penggunaan dalam interval ini, berdasarkan kategori "node" dan "nodearray" Contoh : [ "[clusterusageitem](#clusterusageitem)" ]	< ClusterUsageItem> Array
end required	Akhir interval (eksklusif) Contoh : "string"	string
start required	Awal interval (inklusif) Contoh : "string"	string
total required	Penggunaan keseluruhan untuk kluster ini dalam interval ini, dengan kategori "kluster" Contoh : "[clusterusageitem](#clusterusageitem)"	ClusterUsageItem

ClusterUsageItem

Name	Description	Schema
category required	"kluster" untuk penggunaan keseluruhan; "node" untuk satu node head non-array; "nodearray" untuk seluruh nodearray Contoh : "string"	enum (kluster, node, nodearray)
cost optional	Jumlah yang akan dikenakan untuk penggunaan ini, dalam dolar AS dan dengan tarif ritel. Catatan: semua jumlah biaya adalah perkiraan dan tidak mencerminkan tagihan aktual! Contoh : 0.0	number
details optional	Detail ukuran VM yang digunakan oleh nodearray termasuk jam, core_count, wilayah, prioritas, dan sistem operasi. Contoh : [ "object" ]	< Rincian> Array
hours required	Jumlah jam inti penggunaan untuk kategori ini Contoh : 0.0	number
node optional	Nama node atau nodearray yang digunakan adalah untuk (tidak ada untuk data tingkat kluster) Contoh : "string"	string

Rincian

Name	Description	Schema
core_count optional	Jumlah inti dalam ukuran VM ini Contoh : 0.0	number
cost optional	Biaya ukuran VM ini Contoh : 0.0	number
hours optional	Jumlah jam inti penggunaan untuk ukuran VM ini Contoh : 0.0	number
os optional	Jenis sistem operasi Contoh : "string"	enum (Windows, Linux)
priority optional	Prioritas SKU VM Contoh : "string"	enum (Reguler, Spot)
region optional	Wilayah tempat ukuran VM dibuat Contoh : "string"	string
vm_size optional	Ukuran SKU VM Contoh : "string"	string

Node

Rekaman simpul

Jenis: objek

NodeCreationRequest

Menentukan cara menambahkan simpul ke kluster

Name	Description	Schema
requestId optional	Token unik opsional yang disediakan pengguna untuk mencegah operasi duplikat jika ada kesalahan komunikasi jaringan. Jika nilai ini disertakan dan cocok dengan ID permintaan sebelumnya, server mengabaikan permintaan ini dan mengembalikan kesalahan 409. Contoh : "00000000-0000-0000-0000-000000000000"	string
Set required	Daftar definisi simpul yang akan dibuat. Permintaan harus berisi setidaknya satu set. Setiap set dapat menentukan sekumpulan properti yang berbeda. Contoh : [ "object" ]	< Set> Array

Set

Name	Description	Schema
count required	Jumlah simpul yang akan dibuat Contoh : 1	integer
definition optional	Definisi wadah yang akan digunakan, disediakan oleh panggilan API status kluster. Jika beberapa item yang diberikan dalam panggilan status hilang, atau seluruh properti wadah hilang, wadah pertama yang cocok dengan item yang diberikan digunakan. Contoh : "object"	definition
nameFormat optional	Jika diberikan, simpul menggunakan konvensi penamaan ini alih-alih format "nodearray-%d" standar Contoh : "custom-name-%d"	string
nameOffset optional	Jika diberikan, bersama dengan nameFormat, mengimbangi indeks simpul untuk simpul baru. Contoh : 1	integer
nodeAttributes optional	Atribut tambahan yang akan diatur pada setiap simpul dari set ini Contoh : "[node](#node)"	Node
nodearray required	Nama nodearray untuk memulai simpul dari Contoh : "execute"	string
placementGroupId optional	Jika diberikan, simpul dengan nilai yang sama untuk groupId semuanya dimulai dalam grup penempatan yang sama. Contoh : "string"	string

Definisi

Name	Description	Schema
machineType optional	Contoh : "A2"	string

NodeCreationResult

Name	Description	Schema
operationId required	ID operasi ini Contoh : "00000000-0000-0000-0000-000000000000"	string
Set required	Array set, dalam urutan yang sama seperti dalam permintaan Contoh : [ "object" ]	< Set> Array

Set

Name	Description	Schema
Ditambahkan required	Berapa banyak simpul yang dimulai dalam set ini Contoh : 1	integer
message optional	Menunjukkan mengapa tidak semua simpul yang diminta dapat ditambahkan, jika ada Contoh : "string"	string

NodeList

Hasil pencarian simpul

Name	Description	Schema
nodes required	Simpul dikembalikan Contoh : [ "[node](#node)" ]	< Node> Array
operation optional	Status operasi jika kueri menyertakan ID operasi Contoh : "[operationstatus](#operationstatus)"	OperationStatus

NodeManagementRequest

Menentukan cara melakukan tindakan pada simpul dalam kluster. Ada beberapa cara untuk menentukan simpul, dan jika lebih dari satu cara disertakan, itu diperlakukan sebagai gabungan.

Name	Description	Schema
filter optional	Ekspresi filter yang cocok dengan simpul. String dalam ekspresi harus dikutip dengan benar. Contoh : "State === \"Started\""	string
Hostname optional	Daftar nama host pendek (tanpa domain) untuk dikelola Contoh : [ "hostname1", "hostname2" ]	<array string >
Id optional	Daftar ID simpul yang akan dikelola Contoh : [ "id1", "id2" ]	<array string >
ip_addresses optional	Daftar alamat IP yang akan dikelola Contoh : [ "10.0.1.1", "10.1.1.2" ]	<array string >
names optional	Daftar nama simpul yang akan dikelola Contoh : [ "name1", "name2" ]	<array string >
requestId optional	Token unik opsional yang disediakan pengguna untuk mencegah operasi duplikat jika ada kesalahan komunikasi jaringan. Jika nilai ini disertakan dan cocok dengan ID permintaan sebelumnya, server mengabaikan permintaan ini dan mengembalikan kesalahan 409. Contoh : "00000000-0000-0000-0000-000000000000"	string

NodeManagementResult

Name	Description	Schema
nodes required	Array informasi tentang setiap simpul yang cocok dengan filter dalam permintaan manajemen. Status setiap simpul menunjukkan apakah permintaan memengaruhinya. Contoh : [ "object" ]	< Node> Array
operationId required	ID operasi ini Contoh : "00000000-0000-0000-0000-000000000000"	string

Node

Name	Description	Schema
error optional	Pesan kesalahan saat status adalah Error. Contoh : "This node must be terminated before it can be removed"	string
id required	ID simpul Contoh : "id1"	string
name required	Nama simpul Contoh : "name1"	string
status optional	Salah satu OK atau Kesalahan Contoh : "Error"	enum (OK, Kesalahan)

OperationStatus

Status operasi simpul ini

Name	Description	Schema
action required	Contoh : "string"	enum (buat)
startTime required	Ketika operasi ini dikirimkan Contoh : "2020-01-01T12:34:56Z"	string (tanggal-waktu)