Operations
クラスター ノードを取得する
GET /clusters/{cluster}/nodes
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
クエリを実行するクラスター | string |
クエリ | operation 省略可能 |
指定された場合、 は、この操作 ID のノードのみを返し、本文に operation 属性を含めます | string |
クエリ | request_id 省略可能 |
指定された場合、 は、この要求 ID で識別される操作のノードのみを返します。 と には、本文の operation 属性が含まれています |
string |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
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
説明
この操作により、nodearray からクラスターに新しいノードが追加されます。 1 回の呼び出しで複数のノード定義を受け入れます。 操作の状態を追跡するために使用できる操作の URL が返されます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを追加するクラスター | string |
本文 | ノード 必須 |
作成するノードのセット | NodeCreationRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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、フィルターなど、いくつかの方法で識別できます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードの割り当てを解除するクラスター | string |
本文 | action 必須 |
割り当てを解除するノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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 に設定されている場合を除く)。この呼び出しは終了と同じです。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを削除するクラスター | string |
本文 | action 必須 |
削除するノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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 (既定値) であるか、割り当て解除であるかに応じて、クラスター内のノードを終了または割り当て解除します。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードをシャットダウンするクラスター | string |
本文 | action 必須 |
シャットダウンするノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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、フィルターなど、いくつかの方法で識別できます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを開始するクラスター | string |
本文 | action 必須 |
開始するノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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、フィルターなど、いくつかの方法で識別できます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを終了するクラスター | string |
本文 | action 必須 |
終了するノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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 を返します。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを追加するクラスター | string |
パス | nodearray 必須 |
ノードを追加する nodearray | string |
クエリ | totalCoreCount 省略可能 |
この nodearray に含めるコアの合計数 (既に作成されているノードを含む) | 整数 (integer) |
クエリ | totalNodeCount 省略可能 |
既に作成されているノードを含め、この nodearray に含めるマシンの合計数 | 整数 (integer) |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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 の有効なバケットはユーザーのクラスター定義によって決まりますが、制限はクラウド プロバイダーによって部分的に決定されます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
クエリを実行するクラスター | string |
クエリ | ノード 省略可能 |
true の場合、ノードとノード参照が応答で返されます | ブール値 |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | OK | ClusterStatus |
HTTP 要求の例
要求パス
/clusters/CLUSTER_NAME/status
HTTP 応答の例
応答 200
{
"maxCoreCount" : 16,
"maxCount" : 4,
"nodearrays" : [ "object" ],
"nodes" : [ { } ],
"state" : "Starting",
"targetState" : "Started"
}
操作の状態をListsする
GET /operations/
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
クエリ | request_id 省略可能 |
操作の要求 ID。 これが指定された場合、リストには 0 または 1 の要素のみが含まれます。 | string |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | OK | <OperationStatus> 配列 |
400 | 要求が無効です | コンテンツなし |
404 | 見つかりません | コンテンツなし |
HTTP 要求の例
要求パス
/operations/
HTTP 応答の例
応答 200
[ {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
} ]
ID による操作の状態を取得します
GET /operations/{id}
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | id 必須 |
操作 ID | string |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | OK | OperationStatus |
404 | 見つかりません | コンテンツなし |
HTTP 要求の例
要求パス
/operations/00000000-0000-0000-0000-000000000000
HTTP 応答の例
応答 200
{
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
クラスター ノードを取得する
GET /clusters/{cluster}/nodes
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
クエリを実行するクラスター | string |
クエリ | operation 省略可能 |
指定された場合、 は、この操作 ID のノードのみを返し、本文に operation 属性を含めます | string |
クエリ | request_id 省略可能 |
指定された場合、 は、この要求 ID で識別される操作のノードのみを返します。 と には、本文の operation 属性が含まれています |
string |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
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
説明
この操作により、nodearray からクラスターに新しいノードが追加されます。 1 回の呼び出しで複数のノード定義を受け入れます。 操作の状態を追跡するために使用できる操作の URL が返されます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを追加するクラスター | string |
本文 | ノード 必須 |
作成するノードのセット | NodeCreationRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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、フィルターなど、いくつかの方法で識別できます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードの割り当てを解除するクラスター | string |
本文 | action 必須 |
割り当てを解除するノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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 に設定されている場合を除く)。この呼び出しは終了と同じです。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを削除するクラスター | string |
本文 | action 必須 |
削除するノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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 (既定値) であるか、割り当て解除であるかに応じて、クラスター内のノードを終了または割り当て解除します。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードをシャットダウンするクラスター | string |
本文 | action 必須 |
シャットダウンするノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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、フィルターなど、いくつかの方法で識別できます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを開始するクラスター | string |
本文 | action 必須 |
開始するノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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、フィルターなど、いくつかの方法で識別できます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを終了するクラスター | string |
本文 | action 必須 |
終了するノードの説明 | NodeManagementRequest |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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 を返します。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
ノードを追加するクラスター | string |
パス | nodearray 必須 |
ノードを追加する nodearray | string |
クエリ | totalCoreCount 省略可能 |
この nodearray に含めるコアの合計数 (既に作成されているノードを含む) | 整数 (integer) |
クエリ | totalNodeCount 省略可能 |
既に作成されているノードを含め、この nodearray に含めるマシンの合計数 | 整数 (integer) |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
202 | 同意 ヘッダー : Location (string) : 操作の 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 の有効なバケットはユーザーのクラスター定義によって決まりますが、制限はクラウド プロバイダーによって部分的に決定されます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
クエリを実行するクラスター | string |
クエリ | ノード 省略可能 |
true の場合、ノードとノード参照が応答で返されます | ブール値 |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
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
説明
この操作は、クラスターの全体的な使用状況データ (コア時間) とコスト データ (使用可能な場合) とノードごとの配列の内訳を返します。 既定では、現在の月の使用量が返されます。
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | cluster 必須 |
使用状況データを返すクラスター | string |
クエリ | timeframe 省略可能 |
指定した場合、これはクエリに使用する時間範囲を指定します。 monthToDate は現在の月の使用状況を返し、lastMonth は前月の使用状況を返します。 weekToDate は、現在の週 (日曜日から) の使用状況を返します。 custom には、クエリ パラメーター 'from' と 'to' が必要です。 既定値は MonthToDate です。 時刻はすべて UTC 形式です。 | enum (monthToDate、lastMonth、weekToDate、custom) |
クエリ | from 省略可能 |
カスタムタイムフレームの場合、これはISO-8601形式の時間枠の開始です。 これは、最も近い時間または日に切り捨てられます。 | string |
クエリ | to 省略可能 |
カスタムタイムフレームの場合、これはISO-8601形式の時間枠の終わりです。 これは、最も近い 1 時間または 1 日に切り上げられます。 | string |
クエリ | 粒 度 省略可能 |
データを集計する方法を指定します。時間単位、日単位、または 1 つの数値として指定します。 この既定値は毎日です。 | enum (合計、日単位、時間単位) |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | OK | ClusterUsage |
HTTP 要求の例
要求パス
/clusters/CLUSTER_NAME/usage
HTTP 応答の例
応答 200
{
"usage" : [ "object" ]
}
操作の状態をListsする
GET /operations/
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
クエリ | request_id 省略可能 |
操作の要求 ID。 この値を指定すると、リストには 0 または 1 個の要素のみが含まれます。 | string |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | OK | <OperationStatus> 配列 |
400 | 要求が無効です | コンテンツなし |
404 | 見つかりません | コンテンツなし |
HTTP 要求の例
要求パス
/operations/
HTTP 応答の例
応答 200
[ {
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
} ]
ID で操作の状態を取得します
GET /operations/{id}
パラメーター
Type | 名前 | 説明 | スキーマ |
---|---|---|---|
パス | id 必須 |
操作 ID | string |
応答
HTTP コード | 説明 | スキーマ |
---|---|---|
200 | OK | OperationStatus |
404 | 見つかりません | コンテンツなし |
HTTP 要求の例
要求パス
/operations/00000000-0000-0000-0000-000000000000
HTTP 応答の例
応答 200
{
"action" : "string",
"startTime" : "2020-01-01T12:34:56Z"
}
リソース
ClusterStatus
クラスターの状態
名前 | 説明 | スキーマ |
---|---|---|
maxCoreCount 必須 |
このクラスターに追加できるコアの最大数 例 : 16 |
整数 (integer) |
maxCount 必須 |
このクラスターに追加できるノードの最大数 例 : 4 |
整数 (integer) |
nodearrays 必須 |
例 : [ "object" ] |
<nodearrays> 配列 |
ノード 省略可能 |
このクラスター内のノードの省略可能なリスト。nodes=true がクエリに含まれている場合にのみ含まれます 例 : [ "[node](#node)" ] |
<ノード> 配列 |
状態 省略可能 |
クラスターの現在の状態 (少なくとも 1 回開始されている場合) 例 : "Starting" |
string |
targetState 省略可能 |
クラスターの目的の状態 (例: 開始済みまたは終了済み) 例 : "Started" |
string |
名前 | 説明 | スキーマ |
---|---|---|
バケット 必須 |
この nodearray の割り当ての各バケット。 "コアカウント" 設定は、常にこのバケットのコアカウントの倍数です。 例 : [ "object" ] |
<バケット> 配列 |
maxCoreCount 必須 |
この nodearray に含まれるコアの最大数 例 : 16 |
整数 (integer) |
maxCount 必須 |
この nodearray 内にある可能性があるノードの最大数 例 : 4 |
整数 (integer) |
name 必須 |
これが記述している nodearray 例 : "execute" |
string |
nodearray 必須 |
この nodearray の属性 例 : "[node](#node)" |
Node |
名前 | 説明 | スキーマ |
---|---|---|
activeCoreCount 必須 |
このバケットで使用されているコアの数 (この nodearray 内) 例 : 40 |
整数 (integer) |
activeCount 必須 |
この nodearray 内の、このバケットに使用されているノードの数。 これには、まだ VM を取得しているノードが含まれます。 例 : 10 |
整数 (integer) |
activeNodes 省略可能 |
このバケットで使用されているノード名 (この nodearray 内)。 これには、まだ VM を取得しているノードが含まれます。 これは、nodes=true がクエリ内にある場合にのみ含まれます。 例 : [ "string" ] |
< 文字列 > 配列 |
availableCoreCount 必須 |
このバケットに作成できる追加のコアの数 (この nodearray)。 常に availableCount の倍数。 例 : 8 |
整数 (integer) |
availableCount 必須 |
このバケットに作成できる追加ノードの数 (この nodearray)。 maxCount はグローバルに制限される可能性があるため、これは maxCount と usedCount によって暗黙的に指定されるよりも小さい場合があることに注意してください。 例 : 2 |
整数 (integer) |
bucketId 必須 |
このバケットの識別子。 クラスターが削除されない限り、これは nodearray 内の特定のバケットに対して常に同じ値を持ちます。 例 : "00000000-0000-0000-0000-000000000000" |
string |
consumedCoreCount 必須 |
リージョン全体で既に使用されているこのファミリのコア数。 例 : 2 |
整数 (integer) |
definition 省略可能 |
このバケットのプロパティ。このバケットからノードを作成するために使用されます。 create-nodes API は、そのプロパティでこの定義を bucket 受け取ります。 例 : "object" |
definition |
familyConsumedCoreCount 省略可能 |
リージョン全体で既に使用されているこのファミリのコア数。 例 : 2 |
整数 (integer) |
familyQuotaCoreCount 省略可能 |
このリージョンのこのファミリに対して開始できるコアの合計数。 これは、quotaCount の整数倍数ではない可能性があります。 例 : 16 |
整数 (integer) |
familyQuotaCount 省略可能 |
開始できるインスタンスの合計数 (familyQuotaCoreCount を指定) 例 : 4 |
整数 (integer) |
invalidReason 必須 |
valid が false の場合、これにはバケットが無効な理由が含まれます。 現在、NotActivated と DisabledMachineType だけが理由です。 例 : "DisabledMachineType" |
string |
maxCoreCount 必須 |
グローバルと nodearray の制限を含め、このバケットに含まれるコアの最大数。 常に maxCount の倍数。 例 : 16 |
整数 (integer) |
maxCount 必須 |
グローバルおよび nodearray の制限を含む、このバケットに含まれる可能性があるノードの最大数 例 : 4 |
整数 (integer) |
maxPlacementGroupCoreSize 必須 |
このバケット内の配置グループに含めることができるコアの最大数。 常に maxPlacementGroupSize の倍数。 例 : 64 |
整数 (integer) |
maxPlacementGroupSize 必須 |
このバケットの配置グループに含めることができるインスタンスの最大数 例 : 16 |
整数 (integer) |
placementGroups 必須 |
この nodearray に使用されている配置グループ (存在する場合)。 例 : [ "object" ] |
<placementGroups> 配列 |
quotaCoreCount 必須 |
リージョンのクォータ コア数も考慮して、このリージョンのこのファミリに対して開始できるコアの合計数。 これは、quotaCount の整数倍数ではない可能性があります。 例 : 16 |
整数 (integer) |
quotaCount 必須 |
開始できるインスタンスの合計数 (quotaCoreCount を指定) 例 : 4 |
整数 (integer) |
regionalConsumedCoreCount 省略可能 |
リージョン全体で既に使用されているコアの数。 例 : 2 |
整数 (integer) |
regionalQuotaCoreCount 省略可能 |
このリージョンで開始できるコアの合計数。 これは、regionalQuotaCount の整数倍数ではない可能性があります。 例 : 16 |
整数 (integer) |
regionalQuotaCount 省略可能 |
開始できるインスタンスの合計数 (指定された regionalQuotaCoreCount) 例 : 4 |
整数 (integer) |
valid 必須 |
true の場合、このバケットは、新しいノードに使用する現在有効なバケットを表します。 false の場合、このバケットは既存のノードのみを表します。 例 : true |
ブール値 |
virtualMachine 必須 |
このバケットから起動された仮想マシンのプロパティ 例 : "object" |
virtualMachine |
名前 | 説明 | スキーマ |
---|---|---|
machineType 必須 |
仮想マシンの VM サイズ 例 : "A2" |
string |
名前 | 説明 | スキーマ |
---|---|---|
activeCoreCount 必須 |
このスケールセット内のコアの数 例 : 16 |
整数 (integer) |
activeCount 必須 |
このスケールセット内のノードの数 例 : 4 |
整数 (integer) |
name 必須 |
この配置グループの一意識別子 例 : "my-placement-group" |
string |
名前 | 説明 | スキーマ |
---|---|---|
gpuCount 必須 |
このコンピューターの種類に含まれる GPU の数 例 : 2 |
整数 (integer) |
Infiniband 必須 |
この仮想マシンが InfiniBand 接続をサポートしている場合 例 : true |
ブール値 |
memory 必須 |
この仮想マシンの RAM (GB 単位) 例 : 7.5 |
実数 |
pcpuCount 必須 |
このマシンの種類に含まれる物理 CPU の数 例 : 16 |
整数 (integer) |
vcpuCount 必須 |
このマシンの種類に含まれる仮想 CPU の数 例 : 32 |
整数 (integer) |
Node
ノード レコード
型 : object
NodeCreationRequest
クラスターにノードを追加する方法を指定します
名前 | 説明 | スキーマ |
---|---|---|
requestId 省略可能 |
ネットワーク通信エラーが発生した場合に重複する操作を防ぐための、オプションのユーザー指定の一意トークン。 これが含まれていて、以前の要求 ID と一致する場合、サーバーはこの要求を無視し、409 エラーを返します。 例 : "00000000-0000-0000-0000-000000000000" |
string |
セット 必須 |
作成するノード定義の一覧。 要求には、少なくとも 1 つのセットが含まれている必要があります。 各セットでは、異なるプロパティ セットを指定できます。 例 : [ "object" ] |
<設定> 配列 |
名前 | 説明 | スキーマ |
---|---|---|
count 必須 |
作成するノードの数 例 : 1 |
整数 (integer) |
definition 省略可能 |
使用するバケットの定義。 これは、クラスター状態 API 呼び出しによって提供されます。 状態呼び出しで指定された項目の一部が見つからない場合、またはバケット プロパティ全体が見つからない場合は、指定された項目に一致する最初のバケットが使用されます。 例 : "object" |
definition |
nameFormat 省略可能 |
指定した場合、ノードは標準の "nodearray-%d" 形式ではなく、この名前付け規則を使用します 例 : "custom-name-%d" |
string |
nameOffset 省略可能 |
nameFormat と共に指定すると、新しいノードの nodeindex がオフセットされます。 例 : 1 |
整数 (integer) |
nodeAttributes 省略可能 |
このセットの各ノードに設定する追加の属性 例 : "[node](#node)" |
Node |
nodearray 必須 |
ノードを開始する nodearray の名前 例 : "execute" |
string |
placementGroupId 省略可能 |
指定した場合、groupId に同じ値を持つノードはすべて、同じ配置グループで開始されます。 例 : "string" |
string |
名前 | 説明 | スキーマ |
---|---|---|
machineType 省略可能 |
例 : "A2" |
string |
NodeCreationResult
名前 | 説明 | スキーマ |
---|---|---|
operationId 必須 |
この操作の ID 例 : "00000000-0000-0000-0000-000000000000" |
string |
セット 必須 |
要求と同じ順序のセットの配列 例 : [ "object" ] |
<設定> 配列 |
名前 | 説明 | スキーマ |
---|---|---|
追加 必須 |
このセットで開始されたノードの数 例 : 1 |
整数 (integer) |
message 省略可能 |
要求されたすべてのノードを追加できない理由を示します (存在する場合) 例 : "string" |
string |
NodeList
ノード検索の結果
名前 | 説明 | スキーマ |
---|---|---|
ノード 必須 |
返されるノード 例 : [ "[node](#node)" ] |
<ノード> 配列 |
operation 省略可能 |
クエリに操作 ID が含まれている場合、これはその操作の状態です 例 : "[operationstatus](#operationstatus)" |
OperationStatus |
NodeManagementRequest
クラスター内のノードに対してアクションを実行する方法を指定します。 ノードを指定する方法は複数あり、複数の方法が含まれている場合は共用体として扱われます。
名前 | 説明 | スキーマ |
---|---|---|
filter 省略可能 |
ノードに一致するフィルター式。 式の文字列は正しく引用符で囲む必要があることに注意してください。 例 : "State === \"Started\"" |
string |
ホスト 省略可能 |
管理する短いホスト名 (ドメインなし) の一覧 例 : [ "hostname1", "hostname2" ] |
< string > 配列 |
ids 省略可能 |
管理するノード ID の一覧 例 : [ "id1", "id2" ] |
< string > 配列 |
ip_addresses 省略可能 |
管理する IP アドレスの一覧 例 : [ "10.0.1.1", "10.1.1.2" ] |
< string > 配列 |
名前 省略可能 |
管理するノード名の一覧 例 : [ "name1", "name2" ] |
< string > 配列 |
requestId 省略可能 |
ネットワーク通信エラーが発生した場合に重複する操作を防ぐための、オプションのユーザー指定の一意トークン。 これが含まれていて、以前の要求 ID と一致する場合、サーバーはこの要求を無視し、409 エラーを返します。 例 : "00000000-0000-0000-0000-000000000000" |
string |
NodeManagementResult
名前 | 説明 | スキーマ |
---|---|---|
ノード 必須 |
管理要求のフィルターに一致した各ノードに関する情報の配列。 各ノードの状態は、要求の影響を受けたかどうかを示します。 例 : [ "object" ] |
<ノード> 配列 |
operationId 必須 |
この操作の ID 例 : "00000000-0000-0000-0000-000000000000" |
string |
名前 | 説明 | スキーマ |
---|---|---|
error 省略可能 |
状態が Error の場合は、エラー メッセージが含まれます 例 : "This node must be terminated before it can be removed" |
string |
id 必須 |
ノードの ID 例 : "id1" |
string |
name 必須 |
ノードの名前 例 : "name1" |
string |
status 省略可能 |
[OK] または [エラー] のいずれか 例 : "Error" |
列挙型 (OK、エラー) |
OperationStatus
このノード操作の状態
名前 | 説明 | スキーマ |
---|---|---|
action 必須 |
例 : "string" |
enum (create) |
startTime 必須 |
この操作が送信されたとき 例 : "2020-01-01T12:34:56Z" |
String (日時) |
ClusterStatus
クラスターの状態
名前 | 説明 | スキーマ |
---|---|---|
maxCoreCount 必須 |
このクラスターに追加できるコアの最大数 例 : 16 |
整数 (integer) |
maxCount 必須 |
このクラスターに追加できるノードの最大数 例 : 4 |
整数 (integer) |
nodearrays 必須 |
例 : [ "object" ] |
<nodearrays> 配列 |
ノード 省略可能 |
このクラスター内のノードの省略可能なリスト。nodes=true がクエリに含まれている場合にのみ含まれます 例 : [ "[node](#node)" ] |
<ノード> 配列 |
状態 省略可能 |
クラスターの現在の状態 (少なくとも 1 回開始されている場合) 例 : "Starting" |
string |
targetState 省略可能 |
クラスターの目的の状態 (例: 開始済みまたは終了済み) 例 : "Started" |
string |
名前 | 説明 | スキーマ |
---|---|---|
バケット 必須 |
この nodearray の割り当ての各バケット。 "コアカウント" 設定は、常にこのバケットのコアカウントの倍数です。 例 : [ "object" ] |
<バケット> 配列 |
maxCoreCount 必須 |
この nodearray に含まれるコアの最大数 例 : 16 |
整数 (integer) |
maxCount 必須 |
この nodearray 内にある可能性があるノードの最大数 例 : 4 |
整数 (integer) |
name 必須 |
これが記述している nodearray 例 : "execute" |
string |
nodearray 必須 |
この nodearray の属性 例 : "[node](#node)" |
Node |
名前 | 説明 | スキーマ |
---|---|---|
activeCoreCount 必須 |
このバケットで使用されているコアの数 (この nodearray 内) 例 : 40 |
整数 (integer) |
activeCount 必須 |
この nodearray 内の、このバケットに使用されているノードの数。 これには、まだ VM を取得しているノードが含まれます。 例 : 10 |
整数 (integer) |
activeNodes 省略可能 |
このバケットで使用されているノード名 (この nodearray 内)。 これには、まだ VM を取得しているノードが含まれます。 これは、nodes=true がクエリ内にある場合にのみ含まれます。 例 : [ "string" ] |
< 文字列 > 配列 |
availableCoreCount 必須 |
このバケットに作成できる追加のコアの数 (この nodearray)。 常に availableCount の倍数。 例 : 8 |
整数 (integer) |
availableCount 必須 |
このバケットに作成できる追加ノードの数 (この nodearray)。 maxCount はグローバルに制限される可能性があるため、これは maxCount と usedCount によって暗黙的に指定されるよりも小さい場合があることに注意してください。 例 : 2 |
整数 (integer) |
bucketId 必須 |
このバケットの識別子。 クラスターが削除されない限り、これは nodearray 内の特定のバケットに対して常に同じ値を持ちます。 例 : "00000000-0000-0000-0000-000000000000" |
string |
consumedCoreCount 必須 |
リージョン全体で既に使用されているこのファミリのコア数。 例 : 2 |
整数 (integer) |
definition 省略可能 |
このバケットのプロパティ。このバケットからノードを作成するために使用されます。 create-nodes API は、そのプロパティでこの定義を bucket 受け取ります。 例 : "object" |
definition |
familyConsumedCoreCount 省略可能 |
リージョン全体で既に使用されているこのファミリのコア数。 例 : 2 |
整数 (integer) |
familyQuotaCoreCount 省略可能 |
このリージョンのこのファミリに対して開始できるコアの合計数。 これは、quotaCount の整数倍数ではない可能性があります。 例 : 16 |
整数 (integer) |
familyQuotaCount 省略可能 |
開始できるインスタンスの合計数 (familyQuotaCoreCount を指定) 例 : 4 |
整数 (integer) |
invalidReason 必須 |
valid が false の場合、これにはバケットが無効な理由が含まれます。 現在、NotActivated と DisabledMachineType だけが理由です。 例 : "DisabledMachineType" |
string |
lastCapacityFailure 必須 |
このバケットが最後に容量エラーが発生してからの時間 (秒単位)。 負の値は never として扱われます。 例 : 180.0 |
実数 |
maxCoreCount 必須 |
グローバルと nodearray の制限を含め、このバケットに含まれるコアの最大数。 常に maxCount の倍数。 例 : 16 |
整数 (integer) |
maxCount 必須 |
グローバルおよび nodearray の制限を含む、このバケットに含まれる可能性があるノードの最大数 例 : 4 |
整数 (integer) |
maxPlacementGroupCoreSize 必須 |
このバケット内の配置グループに含めることができるコアの最大数。 常に maxPlacementGroupSize の倍数。 例 : 64 |
整数 (integer) |
maxPlacementGroupSize 必須 |
このバケットの配置グループに含めることができるインスタンスの最大数 例 : 16 |
整数 (integer) |
placementGroups 必須 |
この nodearray に使用されている配置グループ (存在する場合)。 例 : [ "object" ] |
<placementGroups> 配列 |
quotaCoreCount 必須 |
リージョンのクォータ コア数も考慮して、このリージョンのこのファミリに対して開始できるコアの合計数。 これは、quotaCount の整数倍数ではない可能性があります。 例 : 16 |
整数 (integer) |
quotaCount 必須 |
開始できるインスタンスの合計数 (quotaCoreCount を指定) 例 : 4 |
整数 (integer) |
regionalConsumedCoreCount 省略可能 |
リージョン全体で既に使用されているコアの数。 例 : 2 |
整数 (integer) |
regionalQuotaCoreCount 省略可能 |
このリージョンで開始できるコアの合計数。 これは、regionalQuotaCount の整数倍数ではない可能性があります。 例 : 16 |
整数 (integer) |
regionalQuotaCount 省略可能 |
開始できるインスタンスの合計数 (指定された regionalQuotaCoreCount) 例 : 4 |
整数 (integer) |
valid 必須 |
true の場合、このバケットは、新しいノードに使用する現在有効なバケットを表します。 false の場合、このバケットは既存のノードのみを表します。 例 : true |
ブール値 |
virtualMachine 必須 |
このバケットから起動された仮想マシンのプロパティ 例 : "object" |
virtualMachine |
名前 | 説明 | スキーマ |
---|---|---|
machineType 必須 |
仮想マシンの VM サイズ 例 : "A2" |
string |
名前 | 説明 | スキーマ |
---|---|---|
activeCoreCount 必須 |
このスケールセット内のコアの数 例 : 16 |
整数 (integer) |
activeCount 必須 |
このスケールセット内のノードの数 例 : 4 |
整数 (integer) |
name 必須 |
この配置グループの一意識別子 例 : "my-placement-group" |
string |
名前 | 説明 | スキーマ |
---|---|---|
gpuCount 必須 |
このコンピューターの種類に含まれる GPU の数 例 : 2 |
整数 (integer) |
Infiniband 必須 |
この仮想マシンが InfiniBand 接続をサポートしている場合 例 : true |
ブール値 |
memory 必須 |
この仮想マシンの RAM (GB 単位) 例 : 7.5 |
実数 |
pcpuCount 必須 |
このマシンの種類に含まれる物理 CPU の数 例 : 16 |
整数 (integer) |
vcpuCount 必須 |
このマシンの種類に含まれる仮想 CPU の数 例 : 32 |
整数 (integer) |
vcpuQuotaCount 省略可能 |
このマシンがクォータから使用する vCPU の数 例 : 2 |
整数 (integer) |
ClusterUsage
クラスターの使用状況とオプションのコスト情報
名前 | 説明 | スキーマ |
---|---|---|
usage 必須 |
時間間隔別の使用状況の一覧 例 : [ "object" ] |
<使用> 配列 |
名前 | 説明 | スキーマ |
---|---|---|
breakdown 必須 |
"node" と "nodearray" のカテゴリ別に、この間隔での使用量の内訳 例 : [ "[clusterusageitem](#clusterusageitem)" ] |
<ClusterUsageItem> 配列 |
end 必須 |
間隔の末尾 (排他) 例 : "string" |
string |
start 必須 |
間隔の先頭 (両端を含む) 例 : "string" |
string |
total 必須 |
この間隔でのこのクラスターの全体的な使用状況。カテゴリは "cluster" です 例 : "[clusterusageitem](#clusterusageitem)" |
ClusterUsageItem |
ClusterUsageItem
名前 | 説明 | スキーマ |
---|---|---|
category 必須 |
全体的な使用のための「クラスター」。単一の非配列ヘッド ノードの "node" 。nodearray 全体の "nodearray" 例 : "string" |
enum (クラスター、ノード、nodearray) |
cost 省略可能 |
この使用量に対して課金される金額 (米ドル、小売料金)。 注: すべてのコスト金額は見積もりであり、実際の請求書を反映していません。 例 : 0.0 |
実数 |
詳細 省略可能 |
時間、core_count、リージョンの優先度、オペレーティング システムなど、nodearray によって使用される VM サイズの詳細。 例 : [ "object" ] |
<詳細> 配列 |
hours 必須 |
このカテゴリのコア時間の使用量 例 : 0.0 |
実数 |
node 省略可能 |
使用するノードまたは nodearray の名前 (クラスター レベルのデータでは使用されません) 例 : "string" |
string |
名前 | 説明 | スキーマ |
---|---|---|
core_count 省略可能 |
この VM サイズのコア数 例 : 0.0 |
実数 |
cost 省略可能 |
この VM サイズのコスト 例 : 0.0 |
実数 |
hours 省略可能 |
この VM サイズのコア時間の使用量 例 : 0.0 |
実数 |
os 省略可能 |
オペレーティング システムの種類 例 : "string" |
enum (Windows、Linux) |
priority 省略可能 |
VM Sku の優先度 例 : "string" |
enum (Regular, Spot) |
リージョン 省略可能 |
VM サイズがインスタンス化されるリージョン 例 : "string" |
string |
vm_size 省略可能 |
VM Sku のサイズ 例 : "string" |
string |
Node
ノード レコード
型 : object
NodeCreationRequest
クラスターにノードを追加する方法を指定します
名前 | 説明 | スキーマ |
---|---|---|
requestId 省略可能 |
ネットワーク通信エラーが発生した場合に重複する操作を防ぐためのオプションのユーザー指定の一意トークン。 これが含まれていて、以前の要求 ID と一致する場合、サーバーはこの要求を無視し、409 エラーを返します。 例 : "00000000-0000-0000-0000-000000000000" |
string |
セット 必須 |
作成するノード定義の一覧。 要求には、少なくとも 1 つのセットが含まれている必要があります。 各セットでは、異なるプロパティ セットを指定できます。 例 : [ "object" ] |
<設定> 配列 |
名前 | 説明 | スキーマ |
---|---|---|
count 必須 |
作成するノードの数 例 : 1 |
整数 (integer) |
definition 省略可能 |
使用するバケットの定義。 これは、クラスター状態 API 呼び出しによって提供されます。 状態呼び出しで指定された項目の一部が見つからない場合、またはバケット プロパティ全体が見つからない場合は、指定された項目に一致する最初のバケットが使用されます。 例 : "object" |
definition |
nameFormat 省略可能 |
指定した場合、ノードは標準の "nodearray-%d" 形式ではなく、この名前付け規則を使用します 例 : "custom-name-%d" |
string |
nameOffset 省略可能 |
nameFormat と共に指定すると、新しいノードの nodeindex がオフセットされます。 例 : 1 |
整数 (integer) |
nodeAttributes 省略可能 |
このセットの各ノードに設定する追加の属性 例 : "[node](#node)" |
Node |
nodearray 必須 |
ノードの開始元となる nodearray の名前 例 : "execute" |
string |
placementGroupId 省略可能 |
指定した場合、groupId に同じ値を持つノードはすべて、同じ配置グループで開始されます。 例 : "string" |
string |
名前 | 説明 | スキーマ |
---|---|---|
machineType 省略可能 |
例 : "A2" |
string |
NodeCreationResult
名前 | 説明 | スキーマ |
---|---|---|
operationId 必須 |
この操作の ID 例 : "00000000-0000-0000-0000-000000000000" |
string |
セット 必須 |
要求と同じ順序のセットの配列 例 : [ "object" ] |
<設定> 配列 |
名前 | 説明 | スキーマ |
---|---|---|
追加 必須 |
このセットで開始されたノードの数 例 : 1 |
整数 (integer) |
message 省略可能 |
要求されたすべてのノードを追加できない理由 (存在する場合) を示します 例 : "string" |
string |
NodeList
ノード検索の結果
名前 | 説明 | スキーマ |
---|---|---|
ノード 必須 |
返されるノード 例 : [ "[node](#node)" ] |
<ノード> 配列 |
operation 省略可能 |
クエリに操作 ID が含まれている場合、これはその操作の状態です 例 : "[operationstatus](#operationstatus)" |
OperationStatus |
NodeManagementRequest
クラスター内のノードに対してアクションを実行する方法を指定します。 ノードを指定する方法は複数あり、複数の方法が含まれている場合は、共用体として扱われます。
名前 | 説明 | スキーマ |
---|---|---|
filter 省略可能 |
ノードに一致するフィルター式。 式内の文字列は正しく引用符で囲む必要があることに注意してください。 例 : "State === \"Started\"" |
string |
ホスト 省略可能 |
管理する短いホスト名 (ドメインなし) の一覧 例 : [ "hostname1", "hostname2" ] |
< 文字列 > 配列 |
ids 省略可能 |
管理するノード ID の一覧 例 : [ "id1", "id2" ] |
< 文字列 > 配列 |
ip_addresses 省略可能 |
管理する IP アドレスの一覧 例 : [ "10.0.1.1", "10.1.1.2" ] |
< 文字列 > 配列 |
名前 省略可能 |
管理するノード名の一覧 例 : [ "name1", "name2" ] |
< 文字列 > 配列 |
requestId 省略可能 |
ネットワーク通信エラーが発生した場合に重複する操作を防ぐためのオプションのユーザー指定の一意トークン。 これが含まれていて、以前の要求 ID と一致する場合、サーバーはこの要求を無視し、409 エラーを返します。 例 : "00000000-0000-0000-0000-000000000000" |
string |
NodeManagementResult
名前 | 説明 | スキーマ |
---|---|---|
ノード 必須 |
管理要求のフィルターに一致した各ノードに関する情報の配列。 各ノードの状態は、要求の影響を受けたかどうかを示します。 例 : [ "object" ] |
<ノード> 配列 |
operationId 必須 |
この操作の ID 例 : "00000000-0000-0000-0000-000000000000" |
string |
名前 | 説明 | スキーマ |
---|---|---|
error 省略可能 |
状態が Error の場合、これにはエラー メッセージが含まれます 例 : "This node must be terminated before it can be removed" |
string |
id 必須 |
ノードの ID 例 : "id1" |
string |
name 必須 |
ノードの名前 例 : "name1" |
string |
status 省略可能 |
[OK] または [エラー] のいずれか 例 : "Error" |
enum (OK,Error) |
OperationStatus
このノード操作の状態
名前 | 説明 | スキーマ |
---|---|---|
action 必須 |
例 : "string" |
enum (create) |
startTime 必須 |
この操作が送信されたとき 例 : "2020-01-01T12:34:56Z" |
String (日時) |