edit-icon download-icon

API for clusters

最終更新日: Dec 13, 2018

クラスターを作成する

このAPIは、クラスターを作成するために使用されます。

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:CreateCluster。
RegionId String はい - リージョンID。
ZoneId String いいえ - ゾーンID。
Name String はい - クラスター名。2〜64文字の文字列です。漢字、平仮名、片仮名またはアルファベットを先頭にし、漢字、平仮名、片仮名、アルファベット、数字、「 - 」および「_」のみを含めることができます。
Description String いいえ Null クラスター説明。2〜128文字の文字列。
EhpcVersion String はい - E-HPCバージョン。
OsTag String はい - オペレーティングシステムイメージタグ。ListImages APIを使用して照会することができます。
SchedulerType String いいえ pbs スケジューラタイプ。現在、PBSがサポートされています。
AccountType String いいえ nis ドメインアカウントのサービスタイプ。現在、NISがサポートされています。
Application.n.Tag String はい - SoftwareTagとして識別され、ListSoftwares API(OpenMPI_11.1など)を使用して照会できるn番目のアプリケーションソフトウェアのタグ。
SecurityGroupId String いいえ None 既存のセキュリティグループのID。
SecurityGroupName String いいえ None 既存のセキュリティグループが使用されていない場合(SecurityGroupIdがnullの場合)、この名前を使用して新しいセキュリティグループが作成され、このセキュリティグループに既定のポリシーが適用されます。SecurityGroupNameの値は、ECSセキュリティグループ名の形式に準拠している必要があります。
VSwitchId String はい - VPC内のスイッチのID。現在、VPCネットワークタイプのみがサポートされています。
VolumeType String いいえ nas 共有ネットワークストレージタイプ。現在、Alibaba Cloud NASのみがサポートされています。
VolumeId String はい - Alibaba Cloud NASインスタンスID。現在、Alibaba Cloud NASインスタンスの自動作成はサポートされていません。
VolumeProtocal String いいえ nfs 共有ネットワークストレージプロトコル。現在、NFSのみがサポートされています。
VolumeMountpoint String はい - NAS VPCマウントポイント。現在、Alibaba Cloud NASマウントポイントの自動作成はサポートされていません。
RemoteDirectory String いいえ - 共有ストレージがマウントされたリモートディレクトリ。最終的なマウントパスは、マウントポイントとリモートディレクトリの組み合わせで、NasMountpoint:/ RemoteDirectoryの形式です。
HaEnable Boolean いいえ false 高可用性を有効にするかどうか。有効になっている場合、クラスター内の各制御ロールは、マスタ/バックアップモードで動作する2つのインスタンスを使用します。
EcsChargeType String いいえ postpay クラスターで使用されるECSインスタンスの請求方法。オプションの値:従量課金(Pay-As-You-Go)およびサブスクリプション(Subscription)。サブスクリプションを選択すると、デフォルトで自動更新が有効になります。ノードが解放されると、自動更新は無効になります。現在、Pay-As-You-Goオプションのみがサポートされています。
EcsOrder.Manager.InstanceType String はい - クラスター内の制御ノードのインスタンスタイプ。
EcsOrder.Compute.Count Integer はい - クラスター内の計算ノードの数。値は1から99までの整数です。
EcsOrder.Compute.InstanceType String はい - クラスター内のコンピューティングノードのインスタンスタイプ。
EcsOrder.Login.Count Integer はい None クラスター内のログインノードの数値は1から99までの整数です。
EcsOrder.Login.InstanceType String はい - クラスター内のログインノードのインスタンスの種類。
パスワード String いいえ(パスワードとKeyPairNameは相互に排他的です)。 None ステッピングストーンインスタンス(ログインノード)のルートパスワード。 パスワードは8〜30文字の文字列で、大文字/小文字のアルファベット、数字、特殊文字を含む必要があります。パスワード漏洩を防ぐためにHTTPSでAPIを呼び出します。
KeyPairName String いいえ(パスワードとKeyPairNameは相互に排他的です)。 None AccessKeyの名前。ECS AccessKey機能を使用するには、ECSコンソールにAccessKeyを作成します。

リターンパラメータ

パブリックリターンパラメータに加え、次のパラメータが返されます。

フィールド タイプ 説明
ClusterId String クラスターID

エラーコード

コード 説明 HTTPコード
InvalidParams 無効なパラメータ 400
InvalidVpc 無効なVPC情報 400
InvalidVolumn ストレージボリュームが無効です。 400
TooManyClusters E-HPCクラスタ数の制限値を超えました。 403
TooManyNodes ノード数のクォータ制限を超えました。 403
EcsError ECS API呼び出しが失敗しました。 406
NotAuthorized 承認されていないRAM 407
UnknownError 不明なエラー 500

DeleteCluster

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:DeleteCluster
RegionId String はい - リージョンID
ClusterId String はい - クラスタID
ReleaseInstance String いいえ true E-HPCによって作成されたインスタンスをリリースするかどうか

リターンパラメータ

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

エラーコード

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

ModifyClusterAttributes

ModifyClusterAttributes APIは、既存のクラスターの属性を変更します。現在、クラスター名のみを変更できます。

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:ModifyClusterAttributes
RegionId String はい - リージョンID
ClusterId String はい - クラスターID
Name String いいえ None クラスターの新しい名前
Description String いいえ None クラスター記述、2〜128文字の文字列

リターンパラメータ

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

エラーコード

コード 説明
InvalidParams 無効なパラメータ
UnknownError 不明なエラー

ListClusters

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:ListClusters
RegionId String はい - リージョンID
PageNumber Integer いいえ 1 表示されたページ番号。初期値:1
PageSize Integer いいえ 10 ページあたりのエントリ数。値の範囲:1〜50

リターンパラメータ

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

フィールド タイプ 説明
Clusters Array 簡単なクラスター情報の配列。ClusterInfoSimple構造の詳細については、次のオブジェクトの説明を参照してください。
TotalCount Integer リスト内のエントリの合計数。
PageNumber Integer 現在のページ番号。
PageSize Integer 現在のページのエントリ数。

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

フィールド 説明
ID String クラスターID。
RegionId String リージョンID。
Name String クラスター名。
Description String クラスターの説明。
Status String クラスターの状態。
OsTag String オペレーティングシステムイメージタグ。ListImages APIを使用して照会することができます。
AccountType String アカウントサーバーの種類。現在、「nis」のみがサポートされています。
SchedulerType String スケジューリング・サーバーのタイプ。現在、「pbs」のみがサポートされています。
Count Integer クラスター内の計算ノードの数。
IntanceType String クラスター内のコンピューティングノードのインスタンスタイプ。たとえば、ecs.n1.large。
CreateTime String 作成時間。

ステータス(クラスターステータス)のオプション値:

説明
uninit クラスターは初期化されていません。
creating クラスターが作成されています。
init クラスターが初期化されています。
running クラスターが実行されています。
exception クラスターが異常です。
release クラスターが解放されています。

エラーコード

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

DescribeCluster

DescribeCluster APIは、指定されたクラスターの詳細情報を照会します。

リクエストパラメータ

フィールド タイプ 必須? デフォルト値 説明
Action String はい - 操作インタフェース名、必須パラメータ。値:DescribeCluster
RegionId String はい - リージョンID
ClusterId String はい - クラスタID

リターンパラメータ

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

フィールド タイプ 説明
ClusterInfo ClusterInfo クラスターの詳細情報。ClusterInfo構造体の詳細については、次のオブジェクトの説明を参照してください。

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

フィールド 説明
ID String クラスターID。
RegionId String リージョンID。
Name String クラスター名。
Description String クラスタの説明。
Status String クラスターの状態。
OsTag String オペレーティングシステムイメージタグ。ListImages APIを使用して照会することができます。
AccountType String アカウントサーバーの種類。現在、「nis」のみがサポートされています。
SchedulerType String スケジューリング・サーバーのタイプ。現在、「pbs」のみがサポートされています。
CreateTime String 作成時間。
ApplicationInfo Array クラスタで使用されるアプリケーションソフトウェアのリスト。各エントリには、ソフトウェアの名前とバージョンが含まれます。
SecurityGroupId String セキュリティグループID。
VSwitchId String VPC内のスイッチのID。現在、VPCネットワークタイプのみがサポートされています。
VolumeType String 共有ネットワークストレージタイプ。現在、Alibaba Cloud NASのみがサポートされています。
VolumeId String Alibaba Cloud NASインスタンスID。現在、Alibaba Cloud NASインスタンスの自動作成はサポートされていません。
VolumeProtocal String 共有ネットワークストレージプロトコル。現在、NFSのみがサポートされています。
VolumeMountpoint String NAS VPCマウントポイント。現在、Alibaba Cloud NASマウントポイントの自動作成はサポートされていません。
RemoteDirectory String 共有ストレージがマウントされたリモートディレクトリ。最終的なマウントパスは、マウントポイントとリモートディレクトリの組み合わせで、NasMountpoint:/ RemoteDirectoryの形式です。
HaEnable Boolean 高可用性を有効にするかどうか。有効になっている場合、クラスター内の各制御ロールは、マスタ/バックアップモードで動作する2つのインスタンスを使用します。
EcsInfo EcsInfoType クラスターの各コンポーネントが使用するECSインスタンスの数とインスタンスの種類を記述するデータ構造。EcsInfo:{“Manager”:{“Count”:2、 “InstanceType”: “ecs.n1.large”}、 “Compute”:{“Count”:8、} “JSON形式で返される結果は、 “InstanceType”: “ecs.n1.large”}、 “Login”:{“Count”:1、 “InstanceType”: “ecs.n1.large”}}XML形式で返された結果はそれに従って推論することができます。
EcsChargeType String クラスターで使用されるECSインスタンスの請求方法。オプションの値:従量課金(Pay-As-You-Go)およびサブスクリプション(Subscription)。サブスクリプションを選択すると、デフォルトで自動更新が有効になります。ノードが解放されると、自動更新は無効になります。現在、Pay-As-You-Goオプションのみがサポートされています。現在、Pay-As-You-Goオプションのみがサポートされています。
KeyPairName String ECS AccessKeyを使用してクラスター内のステップディングインスタンスにログインすると、AccessKeyの名前が返されます。

オプションのStatus(ノードステータス)の値については、ListClustersの説明を参照してください。

ApplicationInfo構造体の形式は次のとおりです。

フィールド タイプ 説明
Tag String ソフトウェアタグ(例:OpenMPI_1.8.7)
Name String ソフトウェア名
Version String ソフトウェアバージョン

エラーコード

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