ListPools - 查询资源池列表

更新时间:
复制 MD 格式

查询资源池列表。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ehpc:ListPools

list

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

Filter

object

否

查询资源池过滤条件。

PoolName

array

否

查询资源池名称列表。

["MyPool"]

string

否

资源池名称。

  • 长度不超过 15 个字符。

  • 可包含数字、大写字母、小写字母、下划线(_)和点(.)。

PoolTest

Status

array

否

查询资源池状态列表。

["Working"]

string

否

资源池状态。取值范围:

  • Creating:资源池创建中

  • Updating:资源池更新中

  • Deleting:资源池删除中

  • Working:资源池工作中

  • Deleted:资源池删除完成

枚举值:

  • Working :

    资源池工作中

  • Creating :

    资源池创建中

  • Updating :

    资源池更新中

  • Deleted :

    资源池删除完成

  • Deleting :

    资源池删除中

Working

TimeCreatedBefore

integer

否

在此时间之前创建的节点池,以所在地域的时间转化为(中国内地为东八区)Unix 时间戳。

1703820113

TimeCreatedAfter

integer

否

在此时间之后创建的节点池,以所在地域的时间转化为(中国内地为东八区)Unix 时间戳。

1703819914

PageSize

integer

否

分页查询时每页的行数,最大值为 50,默认值为 10。

10

PageNumber

integer

否

当前页码。默认值:1。

1

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

896D338C-E4F4-41EC-A154-D605E5DE****

PageSize

integer

分页查询时每页的行数,最大值为 50,默认值为 10。

10

PageNumber

integer

当前页码。默认值:1。

1

TotalCount

integer

列表条目总数。

2

PoolList

array<object>

查询资源池列表。

array<object>

列表中单个资源池信息。

PoolName

string

资源池名称。

  • 长度不超过 15 个字符。

  • 可包含数字、大写字母、小写字母、下划线(_)和点(.)。

PoolTest

Status

string

资源池状态。取值范围:

  • Creating:资源池创建中

  • Updating:资源池更新中

  • Deleting:资源池删除中

  • Working:资源池工作中

  • Deleted:资源池删除完成

Working

Priority

integer

资源池的优先级。

  • 优先级可设置范围:1~99。默认值为 1,即最低优先级。

  • 提交到具有较高优先级层级值的资源池的作业将在较低优先级层级值的资源池中的挂起作业之前进行调度,资源池的优先级层级优先于作业的优先级。

1

IsDefault

boolean

是否是默认资源池。取值说明:

  • true:是

  • false:否

true

MaxExecutorNum

integer

在一个资源池内正在运行的执行节点用量。

100

SchedulingPolicyId

string

调度策略 ID。

policy-xxx

CreateTime

string

资源池创建时间。 示例采用 YYYY-MM-DD HH:mm:ss 格式。

2026-04-20 11:09:59

UpdateTime

string

资源池更新时间。 示例采用 YYYY-MM-DD HH:mm:ss 格式。

2026-04-20 11:09:59

Tags

array<object>

标签信息。

object

标签信息。

Key

string

标签键。

TestKey

Value

string

标签值。

TestValue

示例

正常返回示例

JSON格式

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 2,
  "PoolList": [
    {
      "PoolName": "PoolTest",
      "Status": "Working",
      "Priority": 1,
      "IsDefault": true,
      "MaxExecutorNum": 100,
      "SchedulingPolicyId": "policy-xxx",
      "CreateTime": "2026-04-20 11:09:59",
      "UpdateTime": "2026-04-20 11:09:59",
      "Tags": [
        {
          "Key": "TestKey",
          "Value": "TestValue"
        }
      ]
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParams The specified parameter %s is invalid. 无效的参数:%s
407 NotAuthorized No authorization is granted. 未授权

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

变更历史

更多信息,参考变更详情。