Operations

Azure CycleCloudは、クラスター、ノード、および関連リソースをプログラムで管理するための REST API を提供します。 これらの API 操作を使用して、クラスターの状態のクエリ、ノードの作成と管理、実行時間の長い操作の追跡を行います。 このリファレンスでは、CycleCloud クラスター管理を自動化してワークフローに統合するのに役立つ、使用可能なエンドポイント、パラメーター、応答の形式の一覧を示します。

クラスター ノードを取得する

GET /clusters/{cluster}/nodes

Parameters

タイプ Name Description Schema
Path cluster
required		 クエリを実行するクラスター 文字列
Query operation
optional		 指定した場合は、この操作 ID のノードのみを返し、本文に操作属性を含めます。 文字列
Query request_id
optional		 指定された場合は、この要求 ID で識別される操作のノードのみを返し、本文に operation 属性を含めます 文字列

Responses

HTTP コード Description Schema
200 OK Nodelist
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 からクラスターに新しいノードが追加されます。 1 回の呼び出しで複数のノード定義を受け入れます。 操作の状態を追跡するために使用できる操作の URL が返されます。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードを追加するクラスター 文字列
Body nodes
required		 作成するノードのセット NodeCreationRequest

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

この操作により、クラスター内のノードの割り当てが解除されます。 ノードは、ノード名、ノード ID、フィルターなど、いくつかの方法で識別できます。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードの割り当てを解除するクラスター 文字列
Body action
required		 割り当てを解除するノードの説明 NodeManagementRequest

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

この操作により、クラスター内のノードが再イメージ化されます。 ノードは、ノード名、ノード ID、フィルターなど、いくつかの方法で識別できます。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードを再イメージ化するクラスター 文字列
Body action
required		 再イメージ化するノードの説明 NodeManagementRequest

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

この操作により、クラスター内のノードが削除されます。 ノードは、ノード名、ノード ID、またはフィルターで識別できます。 既定では、CycleCloud は終了時にノードを削除するため、この呼び出しは terminate のように動作します。 Fixed 属性が true に設定されているノードは、終了時に削除されません。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードを削除するクラスター 文字列
Body action
required		 削除するノードの説明 NodeManagementRequest

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

この操作により、クラスター内のノードが再起動されます。 ノードは、ノード名、ノード ID、フィルターなど、いくつかの方法で識別できます。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードを再起動するクラスター 文字列
Body action
required		 再起動するノードの説明 NodeManagementRequest

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 属性によって、Terminate (既定値) または割り当て解除のアクションが決定されます。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードをシャットダウンするクラスター 文字列
Body action
required		 シャットダウンするノードの説明 NodeManagementRequest

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

この操作は、クラスター内のノードを開始します。 ノードは、ノード名、ノード ID、フィルターなど、いくつかの方法で識別できます。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードを開始するクラスター 文字列
Body action
required		 開始するノードの説明 NodeManagementRequest

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

この操作により、クラスター内のノードが終了します。 ノードは、ノード名、ノード ID、フィルターなど、いくつかの方法で識別できます。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードを終了するクラスター 文字列
Body action
required		 終了するノードの説明 NodeManagementRequest

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

タイプ Name Description Schema
Path cluster
required		 報告するノードを含むクラスター 文字列
Path node
required		 レポートするノード 文字列
Query category
optional		 影響のゲスト正常性レポート カテゴリ 文字列
Query 説明
optional		 エラーまたはコンテキストを説明するカスタム メッセージ 文字列

Responses

HTTP コード Description Schema
202 承諾済 コンテンツなし
400 無効な入力 コンテンツなし
404 見つかりません コンテンツなし
409 競合 - このノードに対して既に送信されているゲスト正常性レポート コンテンツなし

HTTP 要求の例

要求パス

/clusters/CLUSTER_NAME/nodes/string/ghr

クラスター ノードのゲスト正常性レポートを取得する

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

Description

正常性の問題があるノードのワークロードへの影響を返します。そのため、正常性レポート エンドポイントに送信できます。

Parameters

タイプ Name Description Schema
Path cluster
required		 報告するノードを含むクラスター 文字列
Path node
required		 レポートするノード 文字列
Query category
optional		 影響のゲスト正常性レポート カテゴリ 文字列
Query 説明
optional		 エラーまたはコンテキストを説明するカスタム メッセージ 文字列

Responses

HTTP コード Description Schema
200 わかりました コンテンツなし
400 無効な入力 コンテンツなし
404 見つかりません コンテンツなし

HTTP 要求の例

要求パス

/clusters/CLUSTER_NAME/nodes/string/ghr

クラスターをサイズに合わせてスケーリングする

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

Description

この操作により、必要に応じてノードが nodearray に追加され、合計カウントに達します。 要求は 1 回処理され、指定された数を維持するために後でノードを再追加しません。 totalCoreCount (合計 CPU コア数) またはtotalNodeCount (VM の合計) を使用してターゲット サイズを指定しますが、両方とも同じ要求では指定しません。 状態の追跡に使用できる操作の URL が返されます。

Parameters

タイプ Name Description Schema
Path cluster
required		 ノードを追加するクラスター 文字列
Path nodearray
required		 ノードを追加する nodearray 文字列
Query totalCoreCount
optional		 この nodearray に含めるコアの合計数 (既に作成されているノードを含む) 整数
Query totalNodeCount
optional		 この nodearray に含まれるマシンの合計数 (既に作成されているノードを含む) 整数

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

この操作には、特定のクラスター内のノードと nodearray の情報が含まれます。 nodearray ごとに、使用可能な各割り当て "bucket" の状態が返されます。 状態には、バケット内の現在のノード数と、追加できるノードの数が含まれます。 各バケットは、特定の顧客アカウントなどの特定の場所に作成できる、特定のハードウェア プロファイルの使用可能な VM のセットです。ユーザーのクラスター定義によって nodearray の有効なバケットが決定されますが、クラウド プロバイダーによって制限が部分的に決定されます。

Parameters

タイプ Name Description Schema
Path cluster
required		 クエリを実行するクラスター 文字列
Query nodes
optional		 true の場合、ノードとノード参照が応答で返されます boolean

Responses

HTTP コード Description Schema
200 OK ClusterStatus

HTTP 要求の例

要求パス

/clusters/CLUSTER_NAME/status

HTTP 応答の例

応答 200

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

クラスターの使用状況とオプションのコスト情報を取得する

GET /clusters/{cluster}/usage

Description

この操作では、クラスターの全体的な使用状況データ (コア時間) とコスト データ (使用可能な場合) とノードごとの内訳が返されます。 既定では、現在の月の使用量が返されます。

Parameters

タイプ Name Description Schema
Path cluster
required		 使用状況データを返すクラスター 文字列
Query 期間
optional		 クエリに使用する時間範囲。 有効な値: monthToDate (現在の月)、 lastMonth (前月)、 weekToDate (現在の週、日曜日の開始)、または custom ( from と to のクエリ パラメーターが必要)。 既定値は monthToDate です。 時刻はすべて UTC 形式です。 enum (monthToDate、lastMonth、weekToDate、custom)
Query from
optional		 カスタム期間の場合、この値は ISO-8601 形式の時間枠の開始です。 最も近い時間または日に切り捨てられます。 文字列
Query to
optional		 カスタム期間の場合、この値は ISO-8601 形式の期間の終わりです。 最も近い時間または日に切り上げられます。 文字列
Query 粒 度
optional		 データを集計する方法を指定します。時間単位、日単位、または 1 つの合計として指定します。 既定の間隔は日単位です。 enum (合計、日単位、時間単位)

Responses

HTTP コード Description Schema
200 OK ClusterUsage

HTTP 要求の例

要求パス

/clusters/CLUSTER_NAME/usage

HTTP 応答の例

応答 200

{
  "usage" : [ "object" ]
}

操作の状態を一覧表示する

GET /operations/

Parameters

タイプ Name Description Schema
Query request_id
optional		 操作の要求 ID。 この値を指定すると、リストには 0 または 1 の要素が含まれます。 文字列

Responses

HTTP コード Description Schema
200 OK < OperationStatus> 配列
400 無効な要求 コンテンツなし
404 見つかりません コンテンツなし

HTTP 要求の例

要求パス

/operations/

HTTP 応答の例

応答 200

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

ID で操作の状態を取得します。

GET /operations/{id}

Parameters

タイプ Name Description Schema
Path id
required		 操作の ID 文字列

Responses

HTTP コード Description Schema
200 OK OperationStatus
404 見つかりません コンテンツなし

HTTP 要求の例

要求パス

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

HTTP 応答の例

応答 200

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

Resources

Azure CycleCloudは、クラスター、ノード配列、ノード、および割り当ての状態を記述するリソース モデルのセットを定義します。 これらのリソースは REST API によって返され、容量の制限、使用状況、クラスターの状態などの詳細が提供されます。 このリファレンスを使用して、CycleCloud クラスターをプログラムで管理および監視するときの API 応答の構造とプロパティを理解します。

ClusterStatus

クラスターの状態

Name Description Schema
maxCoreCount
required		 このクラスターに追加できるコアの最大数
例 : 16		 整数
maxCount
required		 このクラスターに追加できるノードの最大数
例 : 4		 整数
nodearrays
required		 例 : [ "object" ] < nodearrays> 配列
nodes
optional		 nodes=true がクエリ内にある場合にのみ含まれる、このクラスター内のノードの省略可能なリスト
例 : [ "[node](#node)" ]		 < Node> 配列
state
optional		 クラスターの現在の状態。少なくとも 1 つの開始後に使用可能
例 : "Starting"		 文字列
targetState
optional		 クラスターの目的の状態 (たとえば、開始済みまたは終了済み)
例 : "Started"		 文字列

nodearrays

Name Description Schema
buckets
required		 この nodearray の割り当ての各バケット。 "コア数" 設定は、常にこのバケットのコア数の倍数です。
例 : [ "object" ]		 < バケット>配列
maxCoreCount
required		 この nodearray 内にあるコアの最大数
例 : 16		 整数
maxCount
required		 この nodearray 内にある可能性があるノードの最大数
例 : 4		 整数
name
required		 nodearray の名前
例 : "execute"		 文字列
nodearray
required		 この nodearray の属性
例 : "[node](#node)"		 Node

バケット

Name Description Schema
activeCoreCount
required		 このバケットで使用されているコアの数 (この nodearray)
例 : 40		 整数
activeCount
required		 この nodearray 内の、このバケットで使用されているノードの数。 この数には、まだ VM を取得しているノードが含まれます。
例 : 10		 整数
activeNodes
optional		 vm をまだ取得しているノードを含む、nodearray 内のこのバケットに使用されているノードの名前。 クエリに nodes=true が含まれている場合にのみ返されます。
例 : [ "string" ]		 < 配列 > 文字列
availableCoreCount
required		 このバケットで作成できる追加のコアの数 (この nodearray)。 常に availableCount の倍数。
例 : 8		 整数
availableCount
required		 nodearray 内のこのバケットに作成できる追加ノードの数。 maxCountはグローバル制限によって制限される可能性があるため、maxCountマイナスusedCountより小さい値にすることができます。
例 : 2		 整数
bucketId
required		 バケットの一意識別子。 クラスターの有効期間中、nodearray 内の特定のバケットの値は変わりません。
例 : "00000000-0000-0000-0000-000000000000"		 文字列
consumedCoreCount
required		 リージョン全体で既に使用されているこのファミリのコア数。
例 : 2		 整数
definition
optional		 このバケットからノードを作成するために使用されるプロパティ。 create-nodes API は、 bucket プロパティでこの定義を受け取ります。
例 : "object"		 definition
familyConsumedCoreCount
optional		 リージョン全体で既に使用されているこのファミリのコア数。
例 : 2		 整数
familyQuotaCoreCount
optional		 リージョン内のこの VM ファミリに対して実行できるコアの合計数。 この値は、必ずしも familyQuotaCountの整数倍数であるとは限りません。
例 : 16		 整数
familyQuotaCount
optional		 開始できるインスタンスの合計数 (familyQuotaCoreCount を指定)
例 : 4		 整数
invalidReason
required		 validが false の場合にバケットが無効である理由。 現時点では、使用可能な値は NotActivated と DisabledMachineTypeのみです。
例 : "DisabledMachineType"		 文字列
lastCapacityFailure
required		 このバケットで容量エラーが発生してからの秒数。 負の値は never として扱われます。
例 : 180.0		 number
maxCoreCount
required		 グローバルおよび nodearray の制限を含む、このバケットに含まれるコアの最大数。 常に maxCount の倍数。
例 : 16		 整数
maxCount
required		 グローバルおよび nodearray の制限を含む、このバケットに含まれる可能性のあるノードの最大数
例 : 4		 整数
maxPlacementGroupCoreSize
required		 このバケット内の配置グループに含めることができるコアの最大数。 常に maxPlacementGroupSize の倍数。
例 : 64		 整数
maxPlacementGroupSize
required		 このバケット内の配置グループに含めることができるインスタンスの最大数
例 : 16		 整数
placementGroups
required		 この nodearray に使用されている配置グループ (存在する場合)。
例 : [ "object" ]		 < placementGroups> 配列
quotaCoreCount
required		 リージョンのクォータ コア数を占める、リージョン内のこの VM ファミリに対して実行できるコアの合計数。 この値は、必ずしも quotaCountの整数倍数であるとは限りません。
例 : 16		 整数
quotaCount
required		 開始できるインスタンスの合計数 (指定された quotaCoreCount)
例 : 4		 整数
regionalConsumedCoreCount
optional		 リージョン全体で既に使用されているコアの数。
例 : 2		 整数
regionalQuotaCoreCount
optional		 リージョンで実行できるコアの合計数。 この値は、必ずしも regionalQuotaCountの整数倍数であるとは限りません。
例 : 16		 整数
regionalQuotaCount
optional		 開始できるインスタンスの合計数 (指定された regionalQuotaCoreCount)
例 : 4		 整数
spotPlacementScore
required		 スポット VM の可用性の可能性を示す、このバケットのスポット配置スコア。 該当しない場合は、High、Medium、Low、または空の文字列を指定できます。
例 : "High"		 文字列
valid
required		 true の場合、このバケットは、新しいノードに使用する現在有効なバケットを表します。 false の場合、このバケットは既存のノードのみを表します。
例 : true		 boolean
virtualMachine
required		 このバケットから起動された仮想マシンのプロパティ
例 : "object"		 virtualMachine

定義

Name Description Schema
machineType
required		 仮想マシンの VM サイズ
例 : "A2"		 文字列

placementGroups

Name Description Schema
activeCoreCount
required		 このスケール セット内のコアの数
例 : 16		 整数
activeCount
required		 このスケール セット内のノードの数
例 : 4		 整数
name
required		 この配置グループの一意識別子
例 : "my-placement-group"		 文字列

virtualMachine

Name Description Schema
gpuCount
required		 このコンピューターの種類に含まれる GPU の数
例 : 2		 整数
Infiniband
required		 この仮想マシンが InfiniBand 接続をサポートしている場合
例 : true		 boolean
memory
required		 この仮想マシンの RAM (GB 単位)
例 : 7.5		 number
pcpuCount
required		 このマシンの種類に含まれる物理 CPU の数
例 : 16		 整数
vcpuCount
required		 このマシンの種類に含まれる仮想 CPU の数
例 : 32		 整数
vcpuQuotaCount
optional		 このマシンがクォータから使用する vCPU の数
例 : 2		 整数

ClusterUsage

クラスターの使用状況とオプションのコスト情報

Name Description Schema
usage
required		 時間間隔別の使用状況の一覧
例 : [ "object" ]		 < usage> 配列

使用

Name Description Schema
内訳
required		 "node" と "nodearray" のカテゴリ別に、この間隔での使用状況の内訳
例 : [ "[clusterusageitem](#clusterusageitem)" ]		 < ClusterUsageItem> 配列
end
required		 間隔の末尾 (排他)
例 : "string"		 文字列
start
required		 間隔の開始 (両端を含む)
例 : "string"		 文字列
total
required		 この間隔でのこのクラスターの全体的な使用状況 。カテゴリは "cluster"
例 : "[clusterusageitem](#clusterusageitem)"		 ClusterUsageItem

ClusterUsageItem

Name Description Schema
category
required		 全体的な使用のための"クラスター"。単一の非配列ヘッド ノードの "node" です。nodearray 全体の "nodearray"
例 : "string"		 enum (クラスター、ノード、nodearray)
cost
optional		 この使用量に対して請求される金額 (米ドル、小売価格)。 注: すべてのコスト金額は見積もりであり、実際の請求書を反映していません。
例 : 0.0		 number
details
optional		 時間、core_count、リージョン、優先度、オペレーティング システムなど、nodearray によって使用される VM サイズの詳細。
例 : [ "object" ]		 < 詳細>配列
hours
required		 このカテゴリのコア時間の使用量
例 : 0.0		 number
node
optional		 使用するノードまたは nodearray の名前 (クラスター レベルのデータには使用されません)
例 : "string"		 文字列

詳細

Name Description Schema
core_count
optional		 この VM サイズのコア数
例 : 0.0		 number
cost
optional		 この VM サイズのコスト
例 : 0.0		 number
hours
optional		 この VM サイズのコア時間の使用量
例 : 0.0		 number
os
optional		 オペレーティング システムの種類
例 : "string"		 enum (Windows、Linux)
priority
optional		 VM SKU の優先度
例 : "string"		 enum (Regular, Spot)
region
optional		 VM サイズがインスタンス化されるリージョン
例 : "string"		 文字列
vm_size
optional		 VM SKU のサイズ
例 : "string"		 文字列

Node

ノード レコード

型: オブジェクト

NodeCreationRequest

クラスターにノードを追加する方法を指定します

Name Description Schema
requestId
optional		 ネットワーク通信エラーが発生した場合に操作の重複を防ぐための、ユーザーが指定した一意のトークン (省略可能)。 この値が含まれていて、以前の要求 ID と一致する場合、サーバーはこの要求を無視し、409 エラーを返します。
例 : "00000000-0000-0000-0000-000000000000"		 文字列
設定
required		 作成するノード定義の一覧。 要求には、少なくとも 1 つのセットが含まれている必要があります。 各セットでは、異なるプロパティ セットを指定できます。
例 : [ "object" ]		 < sets> 配列

設定

Name Description Schema
count
required		 作成するノードの数
例 : 1		 整数
definition
optional		 クラスター状態 API 呼び出しによって提供される、使用するバケットの定義。 状態呼び出しで指定された項目の一部が見つからない場合、またはバケット プロパティ全体が見つからない場合は、指定された項目に一致する最初のバケットが使用されます。
例 : "object"		 definition
nameFormat
optional		 指定した場合、ノードは標準の "nodearray-%d" 形式ではなく、この名前付け規則を使用します
例 : "custom-name-%d"		 文字列
nameOffset
optional		 nameFormat と共に指定した場合は、新しいノードのノード インデックスをオフセットします。
例 : 1		 整数
nodeAttributes
optional		 このセットの各ノードに設定する追加の属性
例 : "[node](#node)"		 Node
nodearray
required		 ノードを開始する nodearray の名前
例 : "execute"		 文字列
placementGroupId
optional		 指定した場合、groupId に同じ値を持つノードはすべて同じ配置グループで開始されます。
例 : "string"		 文字列

定義

Name Description Schema
machineType
optional		 例 : "A2" 文字列

NodeCreationResult

Name Description Schema
operationId
required		 この操作の ID
例 : "00000000-0000-0000-0000-000000000000"		 文字列
設定
required		 要求と同じ順序のセットの配列
例 : [ "object" ]		 < sets> 配列

設定

Name Description Schema
追加
required		 このセットで開始されたノードの数
例 : 1		 整数
message
optional		 要求されたすべてのノードを追加できない理由を示します (存在する場合)
例 : "string"		 文字列

NodeList

ノード検索の結果

Name Description Schema
nodes
required		 返されるノード
例 : [ "[node](#node)" ]		 < Node> 配列
operation
optional		 クエリに操作 ID が含まれている場合の操作の状態
例 : "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

クラスター内のノードに対してアクションを実行する方法を指定します。 ノードを指定する方法は複数あり、複数の方法が含まれている場合は、共用体として扱われます。

Name Description Schema
filter
optional		 ノードに一致するフィルター式。 式内の文字列は正しく引用符で囲む必要があります。
例 : "State === \"Started\""		 文字列
ホスト
optional		 管理する短いホスト名 (ドメインなし) の一覧
例 : [ "hostname1", "hostname2" ]		 < 配列 > 文字列
ids
optional		 管理するノード ID の一覧
例 : [ "id1", "id2" ]		 < 配列 > 文字列
ip_addresses
optional		 管理する IP アドレスの一覧
例 : [ "10.0.1.1", "10.1.1.2" ]		 < 配列 > 文字列
names
optional		 管理するノード名の一覧
例 : [ "name1", "name2" ]		 < 配列 > 文字列
requestId
optional		 ネットワーク通信エラーが発生した場合に操作の重複を防ぐための、ユーザーが指定した一意のトークン (省略可能)。 この値が含まれていて、以前の要求 ID と一致する場合、サーバーはこの要求を無視し、409 エラーを返します。
例 : "00000000-0000-0000-0000-000000000000"		 文字列

NodeManagementResult

Name Description Schema
nodes
required		 管理要求のフィルターに一致した各ノードに関する情報の配列。 各ノードの状態は、要求が影響を受けたかどうかを示します。
例 : [ "object" ]		 < nodes> 配列
operationId
required		 この操作の ID
例 : "00000000-0000-0000-0000-000000000000"		 文字列

ノード

Name Description Schema
error
optional		 statusがErrorされている場合のエラー メッセージ。
例 : "This node must be terminated before it can be removed"		 文字列
id
required		 ノードの ID
例 : "id1"		 文字列
name
required		 ノードの名前
例 : "name1"		 文字列
status
optional		 [OK] または [エラー] のいずれか
例 : "Error"		 enum (OK, Error)

OperationStatus

このノード操作の状態

Name Description Schema
action
required		 例 : "string" enum (作成)
startTime
required		 この操作が送信されたとき
例 : "2020-01-01T12:34:56Z"		 文字列(日時)
  • Last updated on