edit-icon download-icon

API for nodes

最終更新日: Dec 13, 2018

ノードをバッチで追加する

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:AddNodes
RegionId String はい - リージョンID
ClusterId String はい - クラスタID
Count Integer はい - 追加する計算ノードの数

リターンパラメータ

パブリックリターンパラメータと次のパラメータ

フィールド タイプ 説明
InstanceIds Array ノードIDの配列

エラーコード

コード 説明
InvalidParams 無効なパラメータ
InvalidStatus 現在のクラスタ状態では操作が許可されていません。
TooManyNodes クラスタノード数のクォータを超えました
EcsError ECS API呼び出しが失敗しました。
UnknownError 不明なエラー

ノードを削除

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:DeleteNodes
RegionId String はい - リージョンID
ClusterId String はい - クラスタID
Instance.n.Id String はい - 削除するn番目のノードインスタンスのIDです(nは1から始まります)。複数のエントリがサポートされています。
ReleaseInstance Boolean いいえ true E-HPCによって作成されたインスタンスをリリースするかどうか

リターンパラメータ

パブリックリターンパラメータ。

エラーコード

コード 説明
InvalidParams 無効なパラメータ
InvalidStatus 現在のクラスタまたはノードの状態で操作が許可されていません。
EcsError ECS API呼び出しが失敗しました。
UnknownError 不明なエラー

ResetNodes

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:ResetNodes
RegionId String はい - リージョンID
ClusterId String はい - クラスタID
Instance.n.Id String はい - リセットするn番目のノードインスタンスのID(nは1から始まります)複数のエントリがサポートされています。

リターンパラメータ

パブリックリターンパラメータ。

エラーコード

コード 説明
InvalidParams 無効なパラメータ
InvalidStatus 現在のクラスタまたはノードの状態で操作が許可されていません。
EcsError ECS API呼び出しが失敗しました。
UnknownError 不明なエラー

ListNodes

このAPIは、指定されたクラスターのノード情報を照会します。

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:ListNodes
RegionId String はい - リージョンID
ClusterId String はい - クラスタID
Role String いいえ 計算 Manager(制御ノード)、Logon(ステップインストーンインスタンス)、またはCompute(コンピューティングノード)のノードロールです。
PageNumber Integer いいえ 1 表示されたページ番号。初期値:1
PageSize Integer いいえ 10 ページあたりのエントリ数。値の範囲:1〜50

リターンパラメータ

パブリックリターンパラメータと次のパラメータ

フィールド タイプ 説明
Node Array ノード情報の配列
TotalCount Integer リスト内のエントリの合計数
PageNumber Integer 現在のページ番号
PageSize Integer 現在のページのエントリ数

NodeInfo構造体には、次のフィールドがあります。

フィールド 説明
ID String ノードインスタンスID。
RegionId String リージョンID。
Status String ノードの状態。
CreateByEhpc Boolean ノードがE-HPCによって作成されるかどうか。現在、すべてのノードはE-HPCによって作成されています。
Role String 「スケジューラー」(マスタースケジューラー)、「SchedulerBackup」(バックアップスケジューラー)、「アカウント」(マスタードメインサーバー)、「AccountBackup」(バックアップドメインサーバー)、「ログオン」(ステッピングストーンインスタンス)、または「計算」(計算ノード)。スケジューラとドメインサーバは制御ノード(マネージャ)です。
TotalResources ResourceType リソースの合計量。
UsedResources ResourceType コンピューティングノードのリソース使用。他のノード型の場合、戻り値はnullです。
AddTime Date ノードがクラスタに追加された時刻。

コンピューティング・ノードの場合、ResourceType構造には以下のフィールドが含まれます。

フィールド 説明
Cpu Integer 合計CPUリソース。ユニット:コア
Memory Integer 総メモリリソース。単位:GB
Gpu Integer 総GPUリソース。ユニット:カード

ステータス(ノードステータス)のオプション値:

説明
uninit ノードは初期化されていません。
init ノードが初期化されています。
ready ノードはアイドル状態です。
running ノードが実行中です。
exception ノードが異常です。

エラーコード

コード 説明
InvalidParams 無効なパラメータ
EcsError ECS API呼び出しが失敗しました。
UnknownError 不明なエラー