You can call this operation to query resource pools.

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 ListResourcePool

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

ClusterId String Yes C-EBD62A703A43****

The ID of the cluster.

RegionId String Yes cn-hangzhou

The ID of the region to which your cluster belongs.

AccessKeyId String No LTAI8ljWyu7y****

The AccessKey ID provided to you by Alibaba Cloud. This parameter identifies the user.

PageNumber Integer No 100

The number of the page to return.

PageSize Integer No 50

The number of entries to return on each page.

PoolType String No CAPACITY_SCHEDULER

The scheduler type of the resource pool. Valid values: CAPACITY_SCHEDULER and FAIR_SCHEDULER.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

The number of entries returned per page.

PoolInfoList

The resource pools of the cluster.

PoolInfo

A resource pool of the cluster.

EcmResourcePool

The basic information of the resource pool.

Active Boolean true

Indicates whether the resource pool is in active state.

Id Long 116

The ID of the resource pool.

Name String DEFAULT

The name of the resource pool.

Note String test

The description of the resource pool.

PoolType String CAPACITY_SCHEDULER

The scheduler type of the resource pool.

UserId String 1528342356764****

The ID of the user.

YarnSiteConfig String null

The configurations of the yarn-site.xml file.

EcmResourcePoolConfigList

The configuration parameters of the resource pool.

EcmResourcePoolConfig

The information of a configuration parameter of the resource pool.

Category String QUEUE_RESOURCE_LIMIT

The category of the parameter.

ConfigKey String minimum-user-limit-percent

The key of the parameter.

ConfigType String RESOURCE_QUEUE_CONFIG

The type of the parameter.

ConfigValue String 0

The value of the parameter.

Id Long 2926

The ID of the parameter.

Note String test

The description of the parameter.

Status String NORMAL

The status of the parameter.

QueueList

The queues of the resource pool.

Queue

The information of a queue of the resource pool.

EcmResourcePoolConfigList

The configuration parameters of the resource pool.

EcmResourcePoolConfig

The information of a configuration parameter of the resource pool.

Category String QUEUE_RESOURCE_LIMIT

The category of the parameter.

ConfigKey String minimum-user-limit-percent

The key of the parameter.

ConfigType String RESOURCE_QUEUE_CONFIG

The type of the parameter.

ConfigValue String 0

The value of the parameter.

Id Long 2926

The ID of the parameter.

Note String test

The description of the parameter.

Status String NORMAL

The status of the parameter.

EcmResourceQueue

The queue of the resource pool.

Id Long 2928

The ID of the queue.

Leaf Boolean false

Indicates whether the queue is a leaf queue.

Name String DEFAULT2

The name of the queue.

ParentQueueId Long 116

The ID of the parent queue.

QualifiedName String default

The qualified name.

QueueType String null

The type of the queue.

ResourcePoolId Long 116

The ID of the resource pool.

Status String NORMAL

The status of the queue.

UserId String 1528342356764****

The ID of the user.

RequestId String A544317F-4A60-4532-AC96-191B9D80420A

The ID of the request.

Total Integer 10

The total number of entries returned.

Examples

Sample requests


http(s)://[Endpoint]/? Action=ListResourcePool
&ClusterId=C-EBD62A703A43****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<ListResourcePoolResponse>
	  <data>
		    <PoolInfoList>
			      <PoolInfo>
				        <EcmResourcePoolConfigList></EcmResourcePoolConfigList>
				        <EcmResourcePool>
					          <Name>DEFAULT</Name>
					          <YarnSiteConfig></YarnSiteConfig>
					          <PoolType>CAPACITY_SCHEDULER</PoolType>
					          <Active>true</Active>
					          <Id>116</Id>
					          <Note></Note>
					          <UserId>152834231764****</UserId>
				        </EcmResourcePool>
				        <QueueList>
					          <Queue>
						            <EcmResourcePoolConfigList>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>capacity</ConfigKey>
								                <ConfigValue>100</ConfigValue>
								                <Id>2925</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>minimum-user-limit-percent</ConfigKey>
								                <ConfigValue>0</ConfigValue>
								                <Id>2926</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-capacity</ConfigKey>
								                <ConfigValue>0</ConfigValue>
								                <Id>2927</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>user-limit-factor</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2928</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-allocation-mb</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2929</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-allocation-vcores</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2930</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-applications</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2931</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>maximum-am-resource-percent</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2932</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_RESOURCE_LIMIT</Category>
								                <ConfigKey>state</ConfigKey>
								                <ConfigValue>RUNNING</ConfigValue>
								                <Id>2933</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_SUBMISSION_ACCESS_CONTROL</Category>
								                <ConfigKey>acl_submit_applications</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2934</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
							              <EcmResourcePoolConfig>
								                <Status>NORMAL</Status>
								                <Category>QUEUE_ADMINISTRATION_ACCESS_CONTROL</Category>
								                <ConfigKey>acl_administer_queue</ConfigKey>
								                <ConfigValue></ConfigValue>
								                <Id>2935</Id>
								                <Note></Note>
								                <ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
							              </EcmResourcePoolConfig>
						            </EcmResourcePoolConfigList>
						            <EcmResourceQueue>
							              <Name>default</Name>
							              <Status>NORMAL</Status>
							              <QualifiedName>default</QualifiedName>
							              <Id>247</Id>
							              <QueueType></QueueType>
							              <ResourcePoolId>116</ResourcePoolId>
							              <UserId>152834231764****</UserId>
							              <Leaf>false</Leaf>
							              <ParentQueueId>0</ParentQueueId>
						            </EcmResourceQueue>
					          </Queue>
				        </QueueList>
			      </PoolInfo>
			      <PoolInfo>
				        <EcmResourcePoolConfigList></EcmResourcePoolConfigList>
				        <EcmResourcePool>
					          <Name>pool1</Name>
					          <YarnSiteConfig></YarnSiteConfig>
					          <PoolType>CAPACITY_SCHEDULER</PoolType>
					          <Active>true</Active>
					          <Id>117</Id>
					          <Note></Note>
					          <UserId>152834231764****</UserId>
				        </EcmResourcePool>
				        <QueueList></QueueList>
			      </PoolInfo>
		    </PoolInfoList>
		    <RequestId>213DD361-EF38-4A31-A909-96857AEE42DE</RequestId>
	  </data>
	  <requestId>213DD361-EF38-4A31-A909-96857AEE42DE</requestId>
</ListResourcePoolResponse>

JSON format

{
	"requestId":"213DD361-EF38-4A31-A909-96857AEE42DE",
	"data":{
		"PoolInfoList":{
			"PoolInfo":[
				{
					"EcmResourcePoolConfigList":{
						"EcmResourcePoolConfig":[]
					},
					"EcmResourcePool":{
						"YarnSiteConfig":"",
						"Name":"DEFAULT",
						"Active":true,
						"PoolType":"CAPACITY_SCHEDULER",
						"Note":"",
						"Id":116,
						"UserId":"152834231764****"
					},
					"QueueList":{
						"Queue":[
							{
								"EcmResourcePoolConfigList":{
									"EcmResourcePoolConfig":[
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"capacity",
											"ConfigValue":"100",
											"Note":"",
											"Id":2925,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"minimum-user-limit-percent",
											"ConfigValue":"0",
											"Note":"",
											"Id":2926,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-capacity",
											"ConfigValue":"0",
											"Note":"",
											"Id":2927,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"user-limit-factor",
											"ConfigValue":"",
											"Note":"",
											"Id":2928,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-allocation-mb",
											"ConfigValue":"",
											"Note":"",
											"Id":2929,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-allocation-vcores",
											"ConfigValue":"",
											"Note":"",
											"Id":2930,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-applications",
											"ConfigValue":"",
											"Note":"",
											"Id":2931,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"maximum-am-resource-percent",
											"ConfigValue":"",
											"Note":"",
											"Id":2932,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_RESOURCE_LIMIT",
											"ConfigKey":"state",
											"ConfigValue":"RUNNING",
											"Note":"",
											"Id":2933,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_SUBMISSION_ACCESS_CONTROL",
											"ConfigKey":"acl_submit_applications",
											"ConfigValue":"",
											"Note":"",
											"Id":2934,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										},
										{
											"Status":"NORMAL",
											"Category":"QUEUE_ADMINISTRATION_ACCESS_CONTROL",
											"ConfigKey":"acl_administer_queue",
											"ConfigValue":"",
											"Note":"",
											"Id":2935,
											"ConfigType":"RESOURCE_QUEUE_CONFIG"
										}
									]
								},
								"EcmResourceQueue":{
									"Name":"default",
									"Status":"NORMAL",
									"QualifiedName":"default",
									"ResourcePoolId":116,
									"QueueType":"",
									"Id":247,
									"UserId":"152834231764****",
									"Leaf":false,
									"ParentQueueId":0
								}
							}
						]
					}
				},
				{
					"EcmResourcePoolConfigList":{
						"EcmResourcePoolConfig":[]
					},
					"EcmResourcePool":{
						"YarnSiteConfig":"",
						"Name":"pool1",
						"Active":true,
						"PoolType":"CAPACITY_SCHEDULER",
						"Note":"",
						"Id":117,
						"UserId":"152834231764****"
					},
					"QueueList":{
						"Queue":[]
					}
				}
			]
		},
		"RequestId":"213DD361-EF38-4A31-A909-96857AEE42DE"
	}
}

Error codes

HTTP status code Error code Error message Description
403 Params.Illegal The specified parameters are wrongly formed. The error message returned because the format of the specified parameter is invalid.
403 User.OtherUserResource.NotAllow It is not allowed to operate other user's resource. The error message returned because you are not authorized to manage the resources of other users.
403 Invalid.Cluster.Status Invalid cluster status %s in status list. The error message returned because the status of the specified cluster is invalid.
403 Invalid.Cluster.Type Invalid cluster type %s in cluster type list. The error message returned because the type of the specified cluster is invalid.
500 InternalError The request processing has failed due to some unknown error. The error message returned because the request processing has failed due to an internal error. Submit a ticket.

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