調用ListResourceInstances擷取指定資源群組的機器執行個體列表-人工智慧平台 PAI-阿里雲 - Platform For AI

擷取指定專屬資源群組中的機器執行個體列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

eas:ListResourceInstances

get

*Resource

acs:eas:{#regionId}:{#accountId}:resource/{#ResourceId}

無

請求文法

GET /api/v2/resources/{ClusterId}/{ResourceId}/instances HTTP/1.1

路徑參數

名稱	類型	必填	描述	樣本值
ClusterId	string	是	資源群組所在的地區 ID。	cn-shanghai
ResourceId	string	是	資源群組的 ID。如何查詢資源群組 ID，請參見 ListResources 。	iot

請求參數

名稱	類型	必填	描述	樣本值
ChargeType	string	否	過濾機器付費類型，取值如下： PrePaid：預付費。 PostPaid：後付費。枚舉值： PostPaid : 後付費 PrePaid : 預付費	PrePaid
PageNumber	integer	否	專屬資源群組機器列表的頁碼。起始值為 1，預設為 1。	1
PageSize	integer	否	分頁查詢時設定的每頁顯示的機器數量，預設為 100。	20
InstanceName	string	否	按執行個體名稱過濾。	e-xxxx***
InstanceId	string	否	按執行個體 ID 過濾。如何擷取執行個體 ID，請參見 ListResourceInstances 。	i-bp1jd6x3uots****a
InstanceIP	string	否	機器 IP。	10.224.xx.xx
Filter	string	否	關鍵字搜尋。支援按機器 ID 或 IP 進行搜尋。	10.224.xx.xx
InstanceStatus	string	否	機器狀態。枚舉值： Ready-SchedulingDisabled : 機器可用-不可調度 Ready : 運行中 NotReady : 未就緒 Stopped : 已停機 NotReady-SchedulingDisabled : 機器不可用-不可調度 Attaching : 啟動中 Deleting : 刪除中 CreateFailed : 建立失敗	Ready
Label	object	否	按標籤過濾。
	string	否	按{"key":"value"}格式填寫。Value 可為 null 或Null 字元，代表只按 Key 過濾，Value 可為任意值。	{"key1":"value1","key2":null}
Sort	string	否	排序欄位。枚舉值： CreateTime : 建立時間 MemoryUsed : 記憶體使用量量 GpuUsed : GPU 使用量 ExpireTime : 到期時間 CpuUsed : CPU 使用率	CreateTime
Order	string	否	排序次序。枚舉值： asc : 升序 desc : 降序	desc
Zone	string	否	機器可用性區域。	J

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	40325405-579C-4D82****
Instances	array	執行個體列表。
	ResourceInstance	執行個體資訊。
PageNumber	integer	返回查詢的資源群組機器列表的頁碼。	1
PageSize	integer	返回每頁顯示的資源群組機器數量。	20
TotalCount	integer	執行個體總數。	2

樣本

正常返回樣本

JSON格式

{
  "RequestId": "40325405-579C-4D82****",
  "Instances": [
    {
      "InstanceId": "eas-i-1800z74n30kao****",
      "InstanceName": "eas01122713204*****",
      "InstanceIp": "11.227.XX.XX",
      "InstanceStatus": "Ready",
      "InstancePhase": "",
      "InstanceCpuCount": 4,
      "InstanceGpuCount": 0,
      "InstanceMemory": "8192M",
      "InstanceSystemDiskSize": 200,
      "InstanceGpuMemory": "0G",
      "InstanceUsedCpu": 2.4,
      "InstanceUsedGpu": 0,
      "InstanceUsedMemory": "1000M",
      "InstanceType": "ecs.s6-c1m2.xlarge",
      "CreateTime": "2020-07-05T22:51:32Z",
      "ChargeType": "PrePaid",
      "ExpiredTime": "2020-08-05T22:51:32Z",
      "AutoRenewal": false,
      "Arch": "arm64",
      "Region": "cn-hangzhou",
      "Zone": "cn-hangzhou-b",
      "ResourceId": "eas-r-xxxxx",
      "InstanceTenantIp": "192.168.XX.XX",
      "InstanceUsedGpuMemory": "470M",
      "Labels": [
        {
          "LabelKey": "key",
          "LabelValue": "value"
        }
      ],
      "LastCordonOperator": "",
      "LastCordonReason": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2
}

錯誤碼

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

變更歷史

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