DescribeHpcClusters - Elastic Compute Service - Alibaba Cloud ドキュメントセンター

利用可能な High Performance Computing (HPC) クラスターを照会します。リクエストパラメーターはフィルターとして機能します。フィルターは論理 AND を使用して評価されます。パラメーターは互いに独立しています。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ecs:DescribeHpcClusters

get

*HpcCluster

acs:ecs:{#regionId}:{#accountId}:hpc/*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。	cn-hangzhou
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認してください。ClientToken の値には ASCII 文字のみを含めることができ、64 文字を超えることはできません。詳細については、「べき等性を確保する方法」をご参照ください。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	必須	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
HpcClusterIds	string	任意	HPC クラスターの ID。値は最大 100 個の HPC クラスター ID で構成される JSON 配列を指定できます。ID はコンマ (,) で区切ります。	["hpc-xxxxxxxxx", "hpc-yyyyyyyyy", … "hpc-zzzzzzzzz"]
PageNumber	integer	任意	HPC クラスターリストのページ番号。最小値: 1。デフォルト値: 1。	1
PageSize	integer	任意	ページングクエリの 1 ページあたりのエントリ数。最大値: 100。デフォルト値: 10。	10

レスポンスフィールド

フィールド	型	説明	例
	object
PageSize	integer	ページあたりのエントリ数	10
RequestId	string	リクエスト ID	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
PageNumber	integer	HPC クラスターリストのページ番号。	1
TotalCount	integer	HPC クラスターの合計数。	2
HpcClusters	object
HpcCluster	array<object>	HPC クラスターの情報を含む HpcCluster オブジェクトの配列。
	object
HpcClusterId	string	HPCクラスターID。	hpc-bp1a5zr3u7nq9cx****
Name	string	HPCクラスターの名前。	testName
Description	string	HPCクラスターの説明。	testDescription

例

成功レスポンス

JSONJSON

{
  "PageSize": 10,
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "PageNumber": 1,
  "TotalCount": 2,
  "HpcClusters": {
    "HpcCluster": [
      {
        "HpcClusterId": "hpc-bp1a5zr3u7nq9cx****",
        "Name": "testName",
        "Description": "testDescription"
      }
    ]
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidRegionId.NotFound	指定されたパラメーター "RegionId" は無効です。
400	MissingParameter.HpcClusterId	このリクエストの処理に必須の入力パラメーター HpcClusterId が指定されていません。	HpcClusterIdパラメーターは空にできません。
400	InvalidHpcClusterIds.ExceedLimit	指定されたHPCクラスターIDの数が上限を超えています。	HpcClusterIdsパラメーターの値の数が許容範囲外です。
400	InvalidHpcClusterIds.Malformed	指定されたHPCクラスターIDの数が無効です。	HpcClusterIdsパラメーターの値の数が許容範囲外です。
400	Invalid.Parameter	無効なパラメーターです。	無効なパラメーターです。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。