調用ListClusters API查詢叢集列表-彈性高效能運算-阿里雲

查詢使用者帳號中在每個地區擁有的所有叢集的列表。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

ehpc:ListClusters

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ClusterIds	array	否	待查詢叢集 ID。N 的取值範圍：0～20。
	string	否	叢集 ID。	ehpc-cn-wulanchabu-llsu******
ClusterNames	array	否	待查詢的叢集名稱列表。N 的取值範圍：0～20。
	string	否	叢集名稱。	slurm22.05.8-cluster-20240802
PageNumber	integer	否	列表的頁碼，預設值為 1。	1
PageSize	integer	否	分頁查詢時設定的每頁行數。取值範圍：10~100。預設值：10。	10

返回參數

名稱	類型	描述	樣本值
	object	返回參數集合。
TotalCount	integer	列表條目總數。	2
RequestId	string	請求 ID。	04F0F334-1335-436C-A1D7-6C044FE73368
PageNumber	string	當前頁碼。	1
PageSize	integer	本頁條數。	10
Clusters	array<object>	叢集詳細資料。
	array<object>	叢集資訊。
ClusterId	string	叢集 ID。	ehpc-hz-VMKe******
ClusterName	string	叢集名稱。	slurm22.05.8-cluster-20240227
ClusterDescription	string	叢集描述。	Demo
ClusterCreateTime	string	叢集的建立時間。以 ISO 8601 為標準，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mmZ。更多資訊，請參見ISO 8601。	2024-08-06T12:43:01.000Z
ClusterModifyTime	string	叢集的修改時間。以 ISO 8601 為標準，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mmZ。更多資訊，請參見ISO 8601。	2024-08-06T12:43:01.000Z
ClusterCategory	string	叢集系列，取值範圍： Standard Serverless	Standard
ClusterStatus	string	叢集狀態。取值範圍： uninit：安裝中。 creating：建立中。 initing：初始化中。 running：運行中。 releasing：釋放中。 stopping：停止中。 stopped：已停止。 exception：異常。 pending：待配置。	running
ClusterVpcId	string	叢集使用的Virtual Private Cloud ID。	vpc-m5efjevmclc0xdmys****
ClusterVSwitchId	string	叢集使用的虛擬交換器 ID。	vsw-f8za5p0mwzgdu3wgx****
SecurityGroupId	string	叢集使用的安全性群組 ID。	sg-bp13n61xsydodfyg****
ClusterCustomConfiguration	object	叢集使用的後處理指令碼。
Script	string	叢集後處理指令碼的連結。	https://xxxxx
Args	string	叢集後處理指令碼的參數。	demo
MaxCount	integer	叢集可管理的計算節點數量。	500
MaxCoreCount	integer	叢集可管理的計算節點總核心數。	10000
DeletionProtection	boolean	叢集是否開啟刪除保護。取值範圍： true：啟動刪除保護。 false：不啟用刪除保護。	true
ResourceGroupId	string	資源群組 ID。	rg-acfmxazb4ph****
Manager	object	叢集管理節點配置。
Scheduler	object	調度器服務配置資訊。
Type	string	調度器類型。	SLURM
Version	string	調度器版本。	22.05.8
DirectoryService	object	域帳號服務配置資訊。
Type	string	域帳號類型。	NIS
Version	string	域帳號版本。	2.31
DNS	object	網域名稱解析服務配置資訊。
Type	string	網域名稱解析類型。	NIS
Version	string	網域名稱解析版本。	2.31
EhpcVersion	string	E-HPC 產品叢集的版本。	2.0.0
Nodes	object	叢集的節點數量資訊。
RunningCounts	integer	運行中的計算節點數量。	1
AbnormalCounts	integer	異常的計算節點數量。	0
CreatingCounts	integer	建立中的計算節點數量。	0
Users	object	叢集的使用者屬性資訊。
SudoCounts	integer	管理使用者數量。	2
NormalCounts	integer	普通使用者數量。	2
AdditionalPackages	array<object>	叢集安裝的軟體資訊。
	object	軟體資訊詳情。
Name	string	軟體名稱。	gromacs
Version	string	軟體版本。	2024.1
Addons	array<object>	叢集自訂服務元件資訊。
	array<object>	自訂服務元件詳情。
Name	string	自訂服務元件的名稱。	Login
Version	string	自訂服務元件的版本。	1.0
Label	string	自訂服務元件標籤。	登入節點
AddonId	string	自訂服務元件 ID。	Login-1.0-W2g****
Description	string	自訂服務元件描述。	登入節點，主要用於E-HPC叢集環境的串連登入及使用者任務的提交。
Status	string	自訂服務元件狀態。	Running
ServicesSpec	array<object>	元件服務配置資訊。
	object	服務配置詳情。
ServiceName	string	服務名稱。	Web Portal
ServiceAccessType	string	服務訪問類型。	URL
ServiceAccessUrl	string	服務訪問 Url。	https://47.96.xx.xx:12008
ResourcesSpec	object	組件資源配置資訊。
EipInstanceId	string	彈性公網 IP ID。	eip-bp1vi9124tbx1g3kr****
EcsInstanceId	string	組件執行個體 ID。	i-bp1bg85d2q6laic8****
ClusterUsedCoreTime	number	叢集已用核時資訊。	1000
ClusterMode	string	叢集的部署類型。可能值： Integrated：公用雲 Hybrid：混合雲 Custom：自訂叢集	Integrated
ClusterCredentials	array	叢集登入憑證的類型。取值範圍： password：使用密碼登入叢集。 keypair：使用金鑰組登入叢集。
	string	憑證類型。	password

樣本

正常返回樣本

JSON格式

{
  "TotalCount": 2,
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "PageNumber": "1",
  "PageSize": 10,
  "Clusters": [
    {
      "ClusterId": "ehpc-hz-VMKe******",
      "ClusterName": "slurm22.05.8-cluster-20240227",
      "ClusterDescription": "Demo",
      "ClusterCreateTime": "2024-08-06T12:43:01.000Z",
      "ClusterModifyTime": "2024-08-06T12:43:01.000Z",
      "ClusterCategory": "Standard",
      "ClusterStatus": "running",
      "ClusterVpcId": "vpc-m5efjevmclc0xdmys****\n",
      "ClusterVSwitchId": "vsw-f8za5p0mwzgdu3wgx****\n",
      "SecurityGroupId": "sg-bp13n61xsydodfyg****\n",
      "ClusterCustomConfiguration": {
        "Script": "https://xxxxx",
        "Args": "demo"
      },
      "MaxCount": 500,
      "MaxCoreCount": 10000,
      "DeletionProtection": true,
      "ResourceGroupId": "rg-acfmxazb4ph****",
      "Manager": {
        "Scheduler": {
          "Type": "SLURM",
          "Version": "22.05.8\n"
        },
        "DirectoryService": {
          "Type": "NIS",
          "Version": "2.31\n"
        },
        "DNS": {
          "Type": "NIS",
          "Version": "2.31"
        }
      },
      "EhpcVersion": "2.0.0",
      "Nodes": {
        "RunningCounts": 1,
        "AbnormalCounts": 0,
        "CreatingCounts": 0
      },
      "Users": {
        "SudoCounts": 2,
        "NormalCounts": 2
      },
      "AdditionalPackages": [
        {
          "Name": "gromacs",
          "Version": "2024.1"
        }
      ],
      "Addons": [
        {
          "Name": "Login",
          "Version": "1.0",
          "Label": "登入節點\n",
          "AddonId": "Login-1.0-W2g****\n",
          "Description": "登入節點，主要用於E-HPC叢集環境的串連登入及使用者任務的提交。\n",
          "Status": "Running\n",
          "ServicesSpec": [
            {
              "ServiceName": "Web Portal\n",
              "ServiceAccessType": "URL",
              "ServiceAccessUrl": "https://47.96.xx.xx:12008\n"
            }
          ],
          "ResourcesSpec": {
            "EipInstanceId": "eip-bp1vi9124tbx1g3kr****\n",
            "EcsInstanceId": "i-bp1bg85d2q6laic8****"
          }
        }
      ],
      "ClusterUsedCoreTime": 1000,
      "ClusterMode": "Integrated",
      "ClusterCredentials": [
        "password"
      ]
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	請求失敗，服務暫時不可用
407	NotAuthorized	You are not authorized by RAM for this request.	此請求未獲得RAM授權

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。