ListPools - 查询资源池列表

查询资源池列表。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ehpc:ListPoolslist
*全部资源
*

请求参数

名称类型必填描述示例值
Filterobject

查询资源池过滤条件。

PoolNamearray

查询资源池名称列表。

string

资源池名称。

  • 长度不超过 15 个字符。
  • 可包含数字、大写字母、小写字母、下划线(_)和点(.)。
PoolTest
Statusarray

查询资源池状态列表。

string

资源池状态。取值范围:

  • Creating:资源池创建中
  • Updating:资源池更新中
  • Deleting:资源池删除中
  • Working:资源池工作中
  • Deleted:资源池删除完成
Working
TimeCreatedBeforeinteger

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

1703820113
TimeCreatedAfterinteger

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

1703819914
PageSizeinteger

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

10
PageNumberinteger

当前页码。默认值:1。

1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

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

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

10
PageNumberinteger

当前页码。默认值:1。

1
TotalCountinteger

列表条目总数。

2
PoolListarray<object>

查询资源池列表。

Poolsobject

列表中单个资源池信息。

PoolNamestring

资源池名称。

  • 长度不超过 15 个字符。
  • 可包含数字、大写字母、小写字母、下划线(_)和点(.)。
PoolTest
Statusstring

资源池状态。取值范围:

  • Creating:资源池创建中
  • Updating:资源池更新中
  • Deleting:资源池删除中
  • Working:资源池工作中
  • Deleted:资源池删除完成
Working
Priorityinteger

资源池的优先级。

  • 优先级可设置范围:1~99。默认值为 1,即最低优先级。
  • 提交到具有较高优先级层级值的资源池的作业将在较低优先级层级值的资源池中的挂起作业之前进行调度,资源池的优先级层级优先于作业的优先级。
1
IsDefaultboolean

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

  • true:是
  • false:否
true
MaxExectorNuminteger

用户在一个资源池内允许并发运行的执行节点数量限制。

2000

示例

正常返回示例

JSON格式

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "PageSize": 10,
  "PageNumber": 1,
  "TotalCount": 2,
  "PoolList": [
    {
      "PoolName": "PoolTest",
      "Status": "Working",
      "Priority": 1,
      "IsDefault": true,
      "MaxExectorNum": 2000
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400InvalidParamsThe specified parameter %s is invalid.无效的参数:%s
400InDebtYour account has overdue payments.您的账户已欠费
400NotEnabledYou have not enabled this service.您的账户还未开通此服务
403GetResourceFailedFailed to get resource.获取资源失败
403RecommendEmpty.InstanceTypeSoldOutThe resource is out of stock.资源已售罄
404ImageNotFoundThe specified image does not exist.指定的镜像不存在,请您检查该参数是否正确。
406AliyunErrorAn Alibaba Cloud product error occurred.阿里云产品错误. %s
406EcsErrorAn error occurred while calling the ECS API operation.ECS API调用出错
406DbErrorA database error occurred.数据库错误
503ServiceUnavailableThe request has failed due to a temporary failure of the server.请求失败,服务暂时不可用

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

变更历史

变更时间变更内容概要操作
暂无变更历史