You can call this operation to query the clusters available for a project.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListFlowCluster

The operation that you want to perform. Set the value to ListFlowCluster.

ProjectId String Yes FP-5D55DA9DEDF22ED3

The ID of the project.

RegionId String Yes cn-hangzhou

The ID of the region where your project resides.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 20

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
Clusters

The list of clusters.

ClusterInfo

The list of clusters available for the project.

ChargeType String PostPaid

The billing method of the cluster.

CreateResource String ECM_EMR

The label of the cluster.

CreateTime Long 1542953603000

The creation time of the cluster.

ExpiredTime Long 1542953603000

The expiration time of the cluster.

FailReason

The cause of the cluster failure.

ErrorCode String 123

The error code of the failure.

ErrorMsg String failed

The error message of the failure.

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

The ID of the request.

HasUncompletedOrder Boolean false

Indicates whether an order is uncompleted.

Id String C-2E6ABBD39BD09F97

The ID of the cluster.

Name String my_cluster

The name of the cluster.

OrderList String 1,2

The list of orders.

OrderTaskInfo

The information of the order.

CurrentCount Integer 2

The number of completed orders.

OrderIdList String 1,2

The list of order IDs.

TargetCount Integer 2

The target number of orders to be completed.

Period Integer 1

The payment cycle of the cluster.

RunningTime Integer 200

The execution time of the cluster. Unit: seconds.

Status String SUCCESS

The status of the cluster.

Type String HADOOP

The type of the cluster.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

The page number of the returned page.

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

The ID of the request.

TotalCount Integer 42

The total number of entries returned.

Examples

Sample requests


http(s)://[Endpoint]/? Action=ListFlowCluster
&ProjectId=FP-5D55DA9DEDF22ED3
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<ListFlowClusterResponse>
  <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></OrderTaskInfo>
			      <CreateTime>1542953603000</CreateTime>
			      <FailReason></FailReason>
			      <Id>C-4042079DFF01A3F5</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></OrderTaskInfo>
			      <CreateTime>1542950611000</CreateTime>
			      <FailReason></FailReason>
			      <Id>C-3D0B53253595DBB0</Id>
			      <HasUncompletedOrder>false</HasUncompletedOrder>
			      <RunningTime>4314</RunningTime>
			      <Name>zx-presto-213</Name>
		    </ClusterInfo>
	  </Clusters>
	

</ListFlowClusterResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.