You can call ListResourcePool 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. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListResourcePool

The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Set the value to ListResourcePool.

ClusterId String Yes C-EBD62A703A43****

The ID of the cluster. You can call ListClusters You can call this operation to view the ID of a cluster.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call DescribeRegions To view the latest list of Alibaba Cloud regions.

PoolType String No CAPACITY_SCHEDULER

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

PageNumber Integer No 100

The page number of the returned page.

PageSize Integer No 50

The number of entries to return on each page.

Response parameters

Parameter Type Example Description
PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

The maximum number of exceptions on each page.

PoolInfoList Array of PoolInfo

The resource pools of the cluster.

PoolInfo
EcmResourcePool Struct

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 Array of EcmResourcePoolConfig

The configuration parameters of the resource pool.

EcmResourcePoolConfig
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 data 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 Array of Queue

The queues of the resource pool.

Queue
EcmResourcePoolConfigList Array of EcmResourcePoolConfig

The configuration parameters of the resource pool.

EcmResourcePoolConfig
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 data 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 Struct

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.

Examples

Sample requests

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

Sample responses

XML format

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

JSON Syntax


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