文档

ListClusters - 列出集群信息

更新时间:

列出注册到 DataWorks 的集群信息,目前支持 EMR 集群、CDH 集群。

接口说明

本接口当前处于试用阶段。需要体验的用户可以提出申请,管理员加入试用名单后即可调用。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

集群类型,支持的集群类型如下:

  • CDH(CDH 集群)
  • EMR(EMR 集群)
EMR
PageNumberinteger

页码,大于等于 1 的正整数,默认为 1。

1
PageSizeinteger

每页记录数,默认为 10 条,最大 100 条。

10

返回参数

名称类型描述示例值
object

返回结构。

Dataobject

返回数据。

PageNumberinteger

页码。

1
PageSizeinteger

每页记录数。

10
TotalCountinteger

总记录数。

100
Clustersarray

集群信息列表。

ClustersCluster

集群信息。

RequestIdstring

请求的 ID,用于定位日志、排查问题。

0000-ABCD-E****
Successboolean

请求是否成功:

  • true(成功)
  • false(失败)
true
ErrorCodestring

错误码。

101011005
ErrorMessagestring

错误信息。

Invalid.Cluster.ClusterNotFound
HttpStatusCodeinteger

HTTP 状态码。

200

示例

正常返回示例

JSON格式

{
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "Clusters": [
      {
        "ClusterId": 1234,
        "ClusterBizId": "c-d8a7523****"
      }
    ]
  },
  "RequestId": "0000-ABCD-E****",
  "Success": true,
  "ErrorCode": "101011005",
  "ErrorMessage": "Invalid.Cluster.ClusterNotFound",
  "HttpStatusCode": 200
}

错误码

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