调用ListFlowCluster接口,查询项目中可用的集群列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListFlowCluster

系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求,该参数为必选参数。取值:ListFlowCluster。

ProjectId String FP-5D55DA9DEDF2****

项目ID。您可以调用ListFlowProject查看项目的ID。

RegionId String cn-hangzhou

地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

PageNumber Integer 1

当前页码,从1开始。

PageSize Integer 10

分页查询时设置的每页行数。

ResourceGroupId String rg-acfmv6jutt6****

资源组ID。您可以调用ListResourceGroups查看资源组ID。

返回数据

名称 类型 示例值 描述
Clusters Array of ClusterInfo

集群列表。

ClusterInfo
ChargeType String PostPaid

付费类型:

  • PostPaid:按量付费集群
  • PrePaid:包年包月集群
CreateResource String ECM_EMR

资源。

CreateTime Long 1542953603000

创建时间。

ExpiredTime Long 1542953605000

过期时间。

FailReason Struct

集群失败原因。

ErrorCode String 400

错误码。

ErrorMsg String failed

错误原因。

RequestId String 0d18b019-00ab-455f-b60c-2891bf02f538

请求ID。

HasUncompletedOrder Boolean false

是否有未完成订单:

  • true:有未完成订单
  • false:没有未完成订单
Id String C-2E6ABBD39BD0****

集群ID。

K8sClusterId String

保留字段。

Name String my_cluster

集群名字。

OrderList String 1,2

订单列表。

OrderTaskInfo Struct

订单任务信息。

CurrentCount Integer 2

当前数量。

OrderIdList String 1,2

订单列表。

TargetCount Integer 2

目标数量。

Period Integer 1

包年包月时间(包月数有:1、2、3、4、5、6、7、8、9、12、24、36)。ChargeType=PrePaid 时,必填。

RunningTime Integer 200

运行时间,单位:秒。

Status String IDLE

集群状态:

  • CREATING:集群创建中
  • CREATE_FAILED:集群创建失败
  • RUNNING:运行中
  • IDLE:集群空闲
  • RELEASING:集群释放中
  • RELEASE_FAILED:集群释放失败
  • RELEASED:集群已释放
  • WAIT_FOR_PAY:待支付
  • ABNORMAL:集群状态异常
Type String HADOOP

集群类型:

  • HADOOP
  • KAFKA
  • GATEWAY
  • DRUID
  • ZOOKEEPER
  • DATA_SCIENCE
PageNumber Integer 1

当前页码,从1开始。

PageSize Integer 10

分页查询时设置的每页行数。

RequestId String 0d18b019-00ab-455f-b60c-2891bf02f538

请求ID。

TotalCount Integer 2

总数。

示例

请求示例

http(s)://[Endpoint]/?Action=ListFlowCluster
&ProjectId=FP-5D55DA9DEDF2****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<TotalCount>2</TotalCount>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Clusters>
    <ClusterInfo>
        <Status>IDLE</Status>
        <Type>HADOOP</Type>
        <CreateResource>ECM_EMR</CreateResource>
        <ChargeType>PostPaid</ChargeType>
        <OrderTaskInfo/>
        <CreateTime>1542953603000</CreateTime>
        <FailReason/>
        <Id>C-4042079DFF01****</Id>
        <HasUncompletedOrder>false</HasUncompletedOrder>
        <RunningTime>1322</RunningTime>
        <Name>zx-presto-1</Name>
    </ClusterInfo>
    <ClusterInfo>
        <Status>IDLE</Status>
        <Type>HADOOP</Type>
        <CreateResource>ECM_EMR</CreateResource>
        <ChargeType>PostPaid</ChargeType>
        <OrderTaskInfo/>
        <CreateTime>1542950611000</CreateTime>
        <FailReason/>
        <Id>C-3D0B53253595****</Id>
        <HasUncompletedOrder>false</HasUncompletedOrder>
        <RunningTime>4314</RunningTime>
        <Name>zx-presto-213</Name>
    </ClusterInfo>
</Clusters>

JSON格式

{
    "TotalCount": 2,
    "PageSize": 10,
    "PageNumber": 1,
    "Clusters": {
        "ClusterInfo": [
            {
                "Status": "IDLE",
                "Type": "HADOOP",
                "CreateResource": "ECM_EMR",
                "ChargeType": "PostPaid",
                "OrderTaskInfo": {},
                "CreateTime": 1542953603000,
                "FailReason": {},
                "Id": "C-4042079DFF01****",
                "HasUncompletedOrder": false,
                "RunningTime": 1322,
                "Name": "zx-presto-1"
            },
            {
                "Status": "IDLE",
                "Type": "HADOOP",
                "CreateResource": "ECM_EMR",
                "ChargeType": "PostPaid",
                "OrderTaskInfo": {},
                "CreateTime": 1542950611000,
                "FailReason": {},
                "Id": "C-3D0B53253595****",
                "HasUncompletedOrder": false,
                "RunningTime": 4314,
                "Name": "zx-presto-213"
            }
        ]
    }
}