调用 ListResourcePool 接口,查询资源池列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListResourcePool |
系统规定参数。对于您自行拼凑HTTP或HTTPS URL发起的API请求,该参数为必选参数。取值:ListResourcePool。 |
ClusterId | String | 是 | C-EBD62A703A43**** |
集群ID。您可以调用ListClusters查看集群的ID。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
PoolType | String | 否 | CAPACITY_SCHEDULER |
资源池类型,合法值:CAPACITY_SCHEDULER、FAIR_SCHEDULER。 |
PageNumber | Integer | 否 | 100 |
分页查询的页码。 |
PageSize | Integer | 否 | 50 |
分页查询的每页记录数。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 |
分页序号。 |
PageSize | Integer | 20 |
分页大小。 |
PoolInfoList | Array of PoolInfo |
资源池列表。 |
|
PoolInfo | |||
EcmResourcePool | Struct |
资源池。 |
|
Active | Boolean | true |
激活状态。 |
Id | Long | 116 |
资源池ID。 |
Name | String | DEFAULT |
资源池名称。 |
Note | String | test |
资源池描述。 |
PoolType | String | CAPACITY_SCHEDULER |
资源池类型。 |
UserId | String | 1528342356764**** |
用户ID。 |
YarnSiteConfig | String | null |
YarnSite配置。 |
EcmResourcePoolConfigList | Array of EcmResourcePoolConfig |
资源池配置列表。 |
|
EcmResourcePoolConfig | |||
Category | String | QUEUE_RESOURCE_LIMIT |
参数类别。 |
ConfigKey | String | minimum-user-limit-percent |
参数Key。 |
ConfigType | String | RESOURCE_QUEUE_CONFIG |
参数类型。 |
ConfigValue | String | 0 |
参数值。 |
Id | Long | 2926 |
参数ID。 |
Note | String | test |
参数描述。 |
Status | String | NORMAL |
参数状态。 |
QueueList | Array of Queue |
资源池队列列表。 |
|
Queue | |||
EcmResourcePoolConfigList | Array of EcmResourcePoolConfig |
资源池配置。 |
|
EcmResourcePoolConfig | |||
Category | String | QUEUE_RESOURCE_LIMIT |
参数类别。 |
ConfigKey | String | minimum-user-limit-percent |
参数Key。 |
ConfigType | String | RESOURCE_QUEUE_CONFIG |
参数类型。 |
ConfigValue | String | 0 |
参数值。 |
Id | Long | 2926 |
参数ID。 |
Note | String | test |
参数描述。 |
Status | String | NORMAL |
参数状态。 |
EcmResourceQueue | Struct |
资源队列。 |
|
Id | Long | 2928 |
队列ID。 |
Leaf | Boolean | false |
是否叶子节点。 |
Name | String | DEFAULT2 |
队列名称。 |
ParentQueueId | Long | 116 |
父队列ID。 |
QualifiedName | String | default |
QualifiedName。 |
QueueType | String | null |
队列类型。 |
ResourcePoolId | Long | 116 |
资源池ID。 |
Status | String | NORMAL |
队列状态。 |
UserId | String | 1528342356764**** |
用户ID。 |
RequestId | String | A544317F-4A60-4532-AC96-191B9D80420A |
请求ID。 |
Total | Integer | 10 |
总记录数。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListResourcePool
&ClusterId=C-EBD62A703A43****
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
<data>
<PoolInfoList>
<PoolInfo>
<EcmResourcePoolConfigList>
</EcmResourcePoolConfigList>
<EcmResourcePool>
<Name>DEFAULT</Name>
<YarnSiteConfig/>
<PoolType>CAPACITY_SCHEDULER</PoolType>
<Active>true</Active>
<Id>116</Id>
<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/>
<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/>
<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/>
<ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
</EcmResourcePoolConfig>
<EcmResourcePoolConfig>
<Status>NORMAL</Status>
<Category>QUEUE_RESOURCE_LIMIT</Category>
<ConfigKey>user-limit-factor</ConfigKey>
<ConfigValue/>
<Id>2928</Id>
<Note/>
<ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
</EcmResourcePoolConfig>
<EcmResourcePoolConfig>
<Status>NORMAL</Status>
<Category>QUEUE_RESOURCE_LIMIT</Category>
<ConfigKey>maximum-allocation-mb</ConfigKey>
<ConfigValue/>
<Id>2929</Id>
<Note/>
<ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
</EcmResourcePoolConfig>
<EcmResourcePoolConfig>
<Status>NORMAL</Status>
<Category>QUEUE_RESOURCE_LIMIT</Category>
<ConfigKey>maximum-allocation-vcores</ConfigKey>
<ConfigValue/>
<Id>2930</Id>
<Note/>
<ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
</EcmResourcePoolConfig>
<EcmResourcePoolConfig>
<Status>NORMAL</Status>
<Category>QUEUE_RESOURCE_LIMIT</Category>
<ConfigKey>maximum-applications</ConfigKey>
<ConfigValue/>
<Id>2931</Id>
<Note/>
<ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
</EcmResourcePoolConfig>
<EcmResourcePoolConfig>
<Status>NORMAL</Status>
<Category>QUEUE_RESOURCE_LIMIT</Category>
<ConfigKey>maximum-am-resource-percent</ConfigKey>
<ConfigValue/>
<Id>2932</Id>
<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/>
<ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
</EcmResourcePoolConfig>
<EcmResourcePoolConfig>
<Status>NORMAL</Status>
<Category>QUEUE_SUBMISSION_ACCESS_CONTROL</Category>
<ConfigKey>acl_submit_applications</ConfigKey>
<ConfigValue/>
<Id>2934</Id>
<Note/>
<ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
</EcmResourcePoolConfig>
<EcmResourcePoolConfig>
<Status>NORMAL</Status>
<Category>QUEUE_ADMINISTRATION_ACCESS_CONTROL</Category>
<ConfigKey>acl_administer_queue</ConfigKey>
<ConfigValue/>
<Id>2935</Id>
<Note/>
<ConfigType>RESOURCE_QUEUE_CONFIG</ConfigType>
</EcmResourcePoolConfig>
</EcmResourcePoolConfigList>
<EcmResourceQueue>
<Name>default</Name>
<Status>NORMAL</Status>
<QualifiedName>default</QualifiedName>
<Id>247</Id>
<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/>
<PoolType>CAPACITY_SCHEDULER</PoolType>
<Active>true</Active>
<Id>117</Id>
<Note/>
<UserId>152834231764****</UserId>
</EcmResourcePool>
<QueueList>
</QueueList>
</PoolInfo>
</PoolInfoList>
<RequestId>213DD361-EF38-4A31-A909-96857AEE42DE</RequestId>
</data>
<requestId>213DD361-EF38-4A31-A909-96857AEE42DE</requestId>
JSON
格式
{
"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"
}