次の方法で共有

オペレーションズ

  • [アーティクル]

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

GET /clusters/{cluster}/nodes

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 クエリを実行するクラスター 糸
クエリ 操作
省略可能な 		指定した場合は、この操作 ID のノードのみを返し、本文に operation 属性を含めます 糸
クエリ request_id
省略可能な 		指定された場合は、この要求 ID で識別される操作のノードのみを返します。
本文に操作属性を含む		 糸

応答

HTTP コード 形容 スキーマ
200 わかりました 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

形容

この操作により、nodearray からクラスターに新しいノードが追加されます。 1 回の呼び出しで複数のノード定義を受け入れます。 操作の状態を追跡するために使用できる操作の URL が返されます。

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 ノードを追加するクラスター 糸
Body ノード を する
必要な		 作成するノードのセット NodeCreationRequest

応答

HTTP コード 形容 スキーマ
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

形容

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

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 ノードの割り当てを解除するクラスター 糸
Body アクション の
必要な		 割り当てを解除するノードの説明 NodeManagementRequest

応答

HTTP コード 形容 スキーマ
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/remove

形容

この操作により、クラスター内のノードが削除されます。 ノードは、ノード名、ノード ID、フィルターなど、いくつかの方法で識別できます。 既定では、ノードが終了すると削除されることに注意してください (ノードで Fixed が true に設定されている場合を除く)。この呼び出しは terminate と同じであることに注意してください。

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 ノードを削除するクラスター 糸
Body アクション の
必要な		 削除するノードの説明 NodeManagementRequest

応答

HTTP コード 形容 スキーマ
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/shutdown

形容

この操作は、各ノードの ShutdownPolicy 属性が Terminate (既定値) であるか割り当て解除であるかに応じて、クラスター内のノードを終了または割り当て解除します。

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 ノードをシャットダウンするクラスター 糸
Body アクション の
必要な		 シャットダウンするノードの説明 NodeManagementRequest

応答

HTTP コード 形容 スキーマ
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

形容

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

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 ノードを開始するクラスター 糸
Body アクション の
必要な		 開始するノードの説明 NodeManagementRequest

応答

HTTP コード 形容 スキーマ
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

形容

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

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 ノードを終了するクラスター 糸
Body アクション の
必要な		 終了するノードの説明 NodeManagementRequest

応答

HTTP コード 形容 スキーマ
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}/scale/{nodearray}

形容

この操作により、必要に応じてノードが nodearray に追加され、合計カウントに達します。 要求は 1 回だけ処理され、指定された数を維持するために後でノードを再追加することはありません。 これは、コアの合計またはノードの合計によってスケーリングされますが、両方ではスケーリングされません。 操作の状態を追跡するために使用できる操作の URL が返されます。

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 ノードを追加するクラスター 糸
パスの nodearray の
必要な		 ノードを追加する nodearray 糸
クエリ totalCoreCount を する
省略可能な 		この nodearray に含めるコアの合計数 (既に作成されているノードを含む) 整数
クエリ totalNodeCount を する
省略可能な 		この nodearray に含まれるマシンの合計数 (既に作成されているノードを含む) 整数

応答

HTTP コード 形容 スキーマ
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

形容

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

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 クエリを実行するクラスター 糸
クエリ ノード を する
省略可能な 		true の場合、ノードとノード参照が応答で返されます ブーリアン

応答

HTTP コード 形容 スキーマ
200 わかりました ClusterStatus の

HTTP 要求の例

要求パス

/clusters/CLUSTER_NAME/status

HTTP 応答の例

応答 200

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

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

GET /clusters/{cluster}/usage

形容

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

パラメーター

種類 名前 形容 スキーマ
パスの クラスター の
必要な		 使用状況データを返すクラスター 糸
クエリ 期間の
省略可能な 		指定した場合は、クエリに使用する時間範囲を指定します。 monthToDate は現在の月の使用状況を返し、lastMonth は前月の使用状況を返します。 weekToDate は、現在の週 (日曜日から) の使用状況を返します。 カスタムでは、クエリ パラメーター 'from' と 'to' が必要です。 既定値は MonthToDate です。 すべての時刻は UTC です。 enum (monthToDate、lastMonth、weekToDate、custom)
クエリ からの
省略可能な 		カスタム期間の場合、これは ISO-8601 形式の時間枠の開始です。 これは、最も近い時間または日に切り捨てられます。 糸
クエリ に する
省略可能な 		カスタム期間の場合、これは ISO-8601 形式の期間の終わりです。 これは、最も近い時間または日に切り上げられます。 糸
クエリ 粒度の
省略可能な 		データを集計する方法を指定します。時間単位、日単位、または 1 つの数値として指定します。 この既定値は日単位です。 enum (合計、日単位、時間単位)

応答

HTTP コード 形容 スキーマ
200 わかりました ClusterUsage の

HTTP 要求の例

要求パス

/clusters/CLUSTER_NAME/usage

HTTP 応答の例

応答 200

{
  "usage" : [ "object" ]
}

操作の状態を一覧表示します

GET /operations/

パラメーター

種類 名前 形容 スキーマ
クエリ request_id
省略可能な 		操作の要求 ID。 これが指定された場合、リストには 0 または 1 個の要素のみが含まれます。 糸

応答

HTTP コード 形容 スキーマ
200 わかりました < OperationStatus> 配列
400 要求が無効です コンテンツなし
404 見つかりません コンテンツなし

HTTP 要求の例

要求パス

/operations/

HTTP 応答の例

応答 200

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

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

GET /operations/{id}

パラメーター

種類 名前 形容 スキーマ
パスの ID
必要な		 操作 ID 糸

応答

HTTP コード 形容 スキーマ
200 わかりました OperationStatus
404 見つかりません コンテンツなし

HTTP 要求の例

要求パス

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

HTTP 応答の例

応答 200

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

リソース

ClusterStatus

クラスターの状態

名前 形容 スキーマ
maxCoreCount を する
必要な		 このクラスターに追加できるコアの最大数
例の: 16		 整数
maxCount を する
必要な		 このクラスターに追加できるノードの最大数
例の: 4		 整数
nodearrays を する
必要な		 例の: [ "object" ] < nodearrays> 配列
ノード を する
省略可能な 		nodes=true がクエリ内にある場合にのみ含まれる、このクラスター内のノードの省略可能なリスト
例の: [ "[node](#node)" ]		 < Node> 配列
状態の
省略可能な 		クラスターの現在の状態 (少なくとも 1 回開始されている場合)
例の: "Starting"		 糸
targetState を する
省略可能な 		クラスターの目的の状態 (例: 開始または終了)
例の: "Started"		 糸

nodearrays

名前 形容 スキーマ
バケット を する
必要な		 この nodearray の割り当ての各バケット。 "コア数" 設定は、常にこのバケットのコア数の倍数です。
例の: [ "object" ]		 配列 バケットを する
maxCoreCount を する
必要な		 この nodearray 内にあるコアの最大数
例の: 16		 整数
maxCount を する
必要な		 この nodearray 内にある可能性があるノードの最大数
例の: 4		 整数
名の
必要な		 これが説明している nodearray
例の: "execute"		 糸
nodearray の
必要な		 この nodearray の属性
例の: "[node](#node)"		 ノード

バケット を する

名前 形容 スキーマ
activeCoreCount を する
必要な		 このバケットで使用されているコアの数 (この nodearray)
例の: 40		 整数
activeCount を する
必要な		 この nodearray 内の、このバケットで使用されているノードの数。 これには、まだ VM を取得しているノードが含まれます。
例の: 10		 整数
activeNodes の
省略可能な 		このバケットで使用されているノード名 (この nodearray)。 これには、まだ VM を取得しているノードが含まれます。 これは、nodes=true がクエリ内にある場合にのみ含まれます。
例の: [ "string" ]		 配列 < 文字列 >
availableCoreCount を する
必要な		 このバケットで作成できる追加のコアの数 (この nodearray)。 常に availableCount の倍数。
例の: 8		 整数
availableCount を する
必要な		 このバケットに作成できる追加ノードの数 (この nodearray)。 maxCount はグローバルに制限される可能性があるため、これは maxCount と usedCount によって暗黙的に指定されるよりも小さい場合があることに注意してください。
例の: 2		 整数
bucketId を する
必要な		 このバケットの識別子。 クラスターが削除されない限り、nodearray 内の特定のバケットに対して常に同じ値が設定されます。
例の: "00000000-0000-0000-0000-000000000000"		 糸
consumedCoreCount を する
必要な		 リージョン全体で既に使用されているこのファミリのコア数。
例の: 2		 整数
定義
省略可能な 		このバケットのプロパティ。このバケットからノードを作成するために使用されます。 create-nodes API は、bucket プロパティでこの定義を受け取ります。
例の: "object"		 定義
familyConsumedCoreCount を する
省略可能な 		リージョン全体で既に使用されているこのファミリのコア数。
例の: 2		 整数
familyQuotaCoreCount
省略可能な 		このリージョンでこのファミリに対して開始できるコアの合計数。 これは、quotaCount の整数倍数ではない可能性があります。
例の: 16		 整数
familyQuotaCount
省略可能な 		開始できるインスタンスの合計数 (familyQuotaCoreCount を指定)
例の: 4		 整数
invalidReason を する
必要な		 有効な値が false の場合、これにはバケットが無効な理由が含まれます。 現在、NotActivated と DisabledMachineType だけが理由です。
例の: "DisabledMachineType"		 糸
lastCapacityFailure を する
必要な		 このバケットで前回容量エラーが発生してからの時間 (秒単位)。 負の値は never として扱われます。
例の: 180.0		 数
maxCoreCount を する
必要な		 グローバルおよび nodearray の制限を含む、このバケットに含まれるコアの最大数。 常に maxCount の倍数。
例の: 16		 整数
maxCount を する
必要な		 グローバルおよび nodearray の制限を含む、このバケットに含まれる可能性のあるノードの最大数
例の: 4		 整数
maxPlacementGroupCoreSize を する
必要な		 このバケット内の配置グループに含めることができるコアの最大数。 常に maxPlacementGroupSize の倍数。
例の: 64		 整数
maxPlacementGroupSize を する
必要な		 このバケット内の配置グループに含めることができるインスタンスの最大数
例の: 16		 整数
placementGroups
必要な		 この nodearray に使用されている配置グループ (存在する場合)。
例の: [ "object" ]		 < placementGroups> array
quotaCoreCount を する
必要な		 リージョンのクォータ コア数も考慮して、このリージョンのこのファミリに対して開始できるコアの合計数。 これは、quotaCount の整数倍数ではない可能性があります。
例の: 16		 整数
quotaCount を する
必要な		 開始できるインスタンスの合計数 (指定された quotaCoreCount)
例の: 4		 整数
regionalConsumedCoreCount
省略可能な 		リージョン全体で既に使用されているコアの数。
例の: 2		 整数
regionalQuotaCoreCount
省略可能な 		このリージョンで開始できるコアの合計数。 これは、regionalQuotaCount の整数倍数ではない可能性があります。
例の: 16		 整数
regionalQuotaCount
省略可能な 		開始できるインスタンスの合計数 (指定された regionalQuotaCoreCount)
例の: 4		 整数
有効な
必要な		 true の場合、このバケットは、新しいノードに使用する現在有効なバケットを表します。 false の場合、このバケットは既存のノードのみを表します。
例の: true		 ブーリアン
virtualMachine を する
必要な		 このバケットから起動された仮想マシンのプロパティ
例の: "object"		 virtualMachine を する

定義

名前 形容 スキーマ
machineType を する
必要な		 仮想マシンの VM サイズ
例の: "A2"		 糸

placementGroups

名前 形容 スキーマ
activeCoreCount を する
必要な		 このスケール セット内のコアの数
例の: 16		 整数
activeCount を する
必要な		 このスケール セット内のノードの数
例の: 4		 整数
名の
必要な		 この配置グループの一意識別子
例の: "my-placement-group"		 糸

virtualMachine を する

名前 形容 スキーマ
gpuCount を する
必要な		 このコンピューターの種類に含まれる GPU の数
例の: 2		 整数
infiniband
必要な		 この仮想マシンが InfiniBand 接続をサポートしている場合
例の: true		 ブーリアン
メモリ の
必要な		 この仮想マシンの RAM (GB 単位)
例の: 7.5		 数
pcpuCount を する
必要な		 このマシンの種類に含まれる物理 CPU の数
例の: 16		 整数
vcpuCount
必要な		 このマシンの種類に含まれる仮想 CPU の数
例の: 32		 整数
vcpuQuotaCount を する
省略可能な 		このマシンがクォータから使用する vCPU の数
例の: 2		 整数

ClusterUsage

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

名前 形容 スキーマ
使用状況の
必要な		 時間間隔別の使用状況の一覧
例の: [ "object" ]		 配列の使用方法 する

使用状況の

名前 形容 スキーマ
内訳
必要な		 "node" と "nodearray" のカテゴリ別に、この間隔での使用状況の内訳
例の: [ "[clusterusageitem](#clusterusageitem)" ]		 ClusterUsageItem 配列の
エンド
必要な		 間隔の末尾 (排他)
例の: "string"		 糸
を開始
必要な		 間隔の開始 (両端を含む)
例の: "string"		 糸
合計
必要な		 この間隔でのこのクラスターの全体的な使用状況 。カテゴリは "cluster"
例の: "[clusterusageitem](#clusterusageitem)"		 ClusterUsageItem の

ClusterUsageItem

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

の詳細

名前 形容 スキーマ
core_count
省略可能な 		この VM サイズのコア数
例の: 0.0		 数
コストの
省略可能な 		この VM サイズのコスト
例の: 0.0		 数
時間
省略可能な 		この VM サイズのコア時間の使用量
例の: 0.0		 数
os の
省略可能な 		オペレーティング システムの種類
例の: "string"		 enum (Windows、Linux)
優先順位
省略可能な 		VM SKU の優先度
例の: "string"		 enum (Regular, Spot)
リージョンの
省略可能な 		VM サイズがインスタンス化されるリージョン
例の: "string"		 糸
vm_size
省略可能な 		VM SKU のサイズ
例の: "string"		 糸

ノード

ノード レコード

型 : object

NodeCreationRequest

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

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

セット

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

定義

名前 形容 スキーマ
machineType を する
省略可能な 		例の: "A2" 糸

NodeCreationResult

名前 形容 スキーマ
operationId を する
必要な		 この操作の ID
例の: "00000000-0000-0000-0000-000000000000"		 糸
セット
必要な		 要求と同じ順序のセットの配列
例の: [ "object" ]		 配列 設定

セット

名前 形容 スキーマ
追加された
必要な		 このセットで開始されたノードの数
例の: 1		 整数
メッセージ
省略可能な 		要求されたすべてのノードを追加できない理由を示します (存在する場合)
例の: "string"		 糸

NodeList

ノード検索の結果

名前 形容 スキーマ
ノード を する
必要な		 返されるノード
例の: [ "[node](#node)" ]		 < Node> 配列
操作
省略可能な 		クエリに操作 ID が含まれている場合、これはその操作の状態です
例の: "[operationstatus](#operationstatus)"		 OperationStatus

NodeManagementRequest

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

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

NodeManagementResult

名前 形容 スキーマ
ノード を する
必要な		 管理要求のフィルターに一致した各ノードに関する情報の配列。 各ノードの状態は、要求の影響を受けたかどうかを示します。
例の: [ "object" ]		 配列 ノードを する
operationId を する
必要な		 この操作の ID
例の: "00000000-0000-0000-0000-000000000000"		 糸

ノード を する

名前 形容 スキーマ
エラー
省略可能な 		状態が Error の場合、これにはエラー メッセージが含まれます
例の: "This node must be terminated before it can be removed"		 糸
ID
必要な		 ノードの ID
例の: "id1"		 糸
名の
必要な		 ノードの名前
例の: "name1"		 糸
状態の
省略可能な 		[OK] または [エラー] のいずれか
例の: "Error"		 enum (OK, Error)

OperationStatus

このノード操作の状態

名前 形容 スキーマ
アクション の
必要な		 例の: "string" enum (作成)
startTime を する
必要な		 この操作が送信されたとき
例の: "2020-01-01T12:34:56Z"		 string (date-time)