You need to enable JavaScript to run this app.
导航
批式计算 Spark版
  • 文档首页
    • /
  • 批式计算 Spark版

ListResourcePool

最近更新时间：2023.05.11 16:26:02

首次发布时间：2023.05.11 16:17:41

我的收藏

调用 ListResourcePool 接口，查询符合条件的 Spark 资源池列表。

前提条件

您必须是资源池所属项目的项目成员，否则无法查询到资源池详情。相关文档，请参见权限概述。

请求参数

参数

类型

是否必填

示例值

说明

ZoneId

string

是

ZoneA

目标可用区的 ID。

ProjectId

string

是

qh8***e0xt

目标项目的 ID。

NameKey

string

否

doc-resource

根据资源池实例名称的关键词进行模糊搜索。

StatusKey

string

否

RUNNING

根据资源池状态筛选。可选取值如下：

  • INITIALIZING：初始化中。
  • INITIALIZATION_FAILED：初始化失败。
  • RUNNING：运行中。
  • MODIFYING：更新中。
  • RELEASING：释放中。
  • STOPPING：停止中。
  • STOPPED：已停止。
  • RECOVERING：恢复中。
  • EXCEPTION：异常。

PageNum

int

否

1

页数，默认为 1。

PageSize

int

否

10

每页能展示的资源池数量，默认为 10。

返回参数

参数

类型

示例值

说明

DataList

List

-

返回的资源池列表详情。详情请参见 DataList 数据结构。

Total

int

1

符合查询条件的资源池总数。

PageNum

int

1

当前页数。

PageSize

int

10

每页展示的资源池数量。

DataList 数据结构

参数

类型

示例值

说明

ResourcePoolTrn

string

doc-resource-1-***226

资源池的唯一标识符。

RegionId

string

cn-beijing

资源池所属地域的 ID。

ZoneId

string

ZoneA

资源池所属可用区的 ID。

Name

string

doc-resource-1

资源池实例名称。

ProjectId

string

w4***rd65

资源池所属项目的 ID。

Status

string

RUNNING

资源池的状态。

StatusMessage

string

-

状态信息。

BillingType

string

POST

资源池的计费方式，目前仅支持 POST（按量计费）方式。

CreateTime

string

2023-02-14T15:29:03Z

资源池的创建时间，格式为YYYY-MM-DD'T'HH:MM:SS'Z'。

UpdateTime

string

2023-02-14T15:29:03Z

资源池的更新时间，格式为YYYY-MM-DD'T'HH:MM:SS'Z'。

请求示例

POST https://open.volcengineapi.com?Action=ListResourcePool &Version=2021-06-01
Content-Type: application/json
Region: cn-beijing
ServiceName: spark
{
    "ZoneId": "ZoneA",
    "NameKey": "doc-spark-pool",
    "ProjectId": "qh8***e0xt",
    "StatusKey": "RUNNING"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230414161703A70E5EEBCC071B2FF5F4",
        "Action": "ListResourcePool",
        "Version": "2021-06-01",
        "Service": "spark",
        "Region": "cn-beijing"
    },
    "Result": {
        "PageNum": 1,
        "PageSize": 10,
        "Total": 1,
        "DataList": [
            {
                "ResourcePoolTrn": "doc-resource-1-***226",
                "RegionId": "cn-beijing",
                "ZoneId": "ZoneA",
                "Name": "doc-spark-pool",
                "ProjectId": "qh8***e0xt",
                "Status": "RUNNING",
                "StatusMessage": "",
                "BillingType": "POST",
                "CreateTime": "2023-02-14T15:28:58Z",
                "UpdateTime": "2023-02-14T15:29:03Z"
            }
        ]
    }
}