全部产品
Search

搜索本产品

    人工智能平台 PAI：ListResourceInstances - 查询资源组机器列表

    文档中心

    人工智能平台 PAI：ListResourceInstances - 查询资源组机器列表

    更新时间：Nov 21, 2024

    获取指定专属资源组中的机器实例列表。

    调试

    您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    eas:ListResourceInstancesget
    *Resource
    acs:eas:{#regionId}:{#accountId}:resource/{#ResourceId}
      无
    		无

    请求语法

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

    请求参数

    名称类型必填描述示例值
    ClusterIdstring是

    资源组所在的地域 ID。

    		cn-shanghai
    ResourceIdstring是

    资源组的 ID。如何查询资源组 ID，请参见 ListResources 。

    		iot
    ChargeTypestring否

    过滤机器付费类型，取值如下：

    • PrePaid：预付费。
    • PostPaid：后付费。
    		PrePaid
    PageNumberinteger否

    专属资源组机器列表的页码。起始值为 1，默认为 1。

    		1
    PageSizeinteger否

    分页查询时设置的每页显示的机器数量，默认为 100。

    		20
    InstanceNamestring否

    按实例名称过滤。

    		e-xxxx***
    InstanceIdstring否

    按实例 ID 过滤。如何获取实例 ID，请参见 ListResourceInstances 。

    		i-bp1jd6x3uots****a
    InstanceIPstring否

    机器 IP。

    		10.224.xx.xx
    Filterstring否

    关键字搜索。支持按机器 ID 或 IP 进行搜索。

    		10.224.xx.xx
    InstanceStatusstring否

    机器状态。

    枚举值：
    • Ready-SchedulingDisabled：机器可用-不可调度。
    • Ready：运行中。
    • NotReady：未就绪。
    • Stopped：已停机。
    • NotReady-SchedulingDisabled：机器不可用-不可调度。
    • Attaching：启动中。
    • Deleting：删除中。
    • CreateFailed：创建失败。
    		Ready
    Sortstring否

    排序字段。

    枚举值：
    • CreateTime：创建时间。
    • MemoryUsed：内存使用量。
    • GpuUsed：GPU使用量。
    • ExpireTime：过期时间。
    • CpuUsed：CPU使用率。
    		CreateTime
    Orderstring否

    排序顺序。

    枚举值：
    • asc：升序。
    • desc：降序。
    		desc

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    		40325405-579C-4D82****
    Instancesarray

    实例列表。

    ResourceInstance

    实例信息。

    PageNumberinteger

    返回查询的资源组机器列表的页码。

    		1
    PageSizeinteger

    返回每页显示的资源组机器数量。

    		20
    TotalCountinteger

    实例总数。

    		2

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "40325405-579C-4D82****",
  "Instances": [
    {
      "InstanceId": "eas-i-1800z74n30kao****",
      "InstanceName": "eas01122713204*****",
      "InstanceIp": "11.227.XX.XX",
      "InstanceStatus": "Ready",
      "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"
    }
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "TotalCount": 2
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-05-06OpenAPI 入参发生变更查看变更详情
    2022-11-29OpenAPI 入参发生变更查看变更详情