GetPool-阿里云帮助中心

Retrieves the details of a specified resource pool.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ehpc:GetPool

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PoolName	string	Yes	The name of the resource pool. The name can be up to 15 characters long. The name can contain letters, digits, underscores (_), and periods (.).	PoolTest

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	896D338C-E4F4-41EC-A154-D605E5DE****
PoolInfo	object	The details of the resource pool.
PoolName	string	The name of the resource pool. The name can be up to 15 characters long. The name can contain letters, digits, underscores (_), and periods (.).	PoolTest
Status	string	The status of the resource pool. Valid values: `Creating`: The resource pool is being created. `Updating`: The resource pool is being updated. `Deleting`: The resource pool is being deleted. `Working`: The resource pool is active. `Deleted`: The resource pool has been deleted.	Working
IsDefault	boolean	Indicates whether the resource pool is the default resource pool. Valid values: true false	true
Priority	integer	The priority of the resource pool. Valid values: 1 to 99. A larger value indicates a higher priority. Default value: 1. Jobs in a resource pool with a higher priority are scheduled before pending jobs in a resource pool with a lower priority. The priority of the resource pool takes precedence over the priority of a job.	1
MaxExecutorNum	integer	The maximum number of concurrent executors per user in the resource pool.
ExecutorUsage	integer	The number of executors that are in use in the resource pool.
CreateTime	string	The time when the resource pool was created.	2024-12-01 20:00:00
UpdateTime	string	The time when the resource pool was last updated.	2024-12-01 20:00:00
Reason	string	The reason for the error.	Fails to * pool: *.
SchedulingPolicyId	string	The ID of the scheduling policy.	policy-xxx

Examples

Success response

JSON format

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****",
  "PoolInfo": {
    "PoolName": "PoolTest",
    "Status": "Working",
    "IsDefault": true,
    "Priority": 1,
    "MaxExecutorNum": 0,
    "ExecutorUsage": 0,
    "CreateTime": "2024-12-01 20:00:00",
    "UpdateTime": "2024-12-01 20:00:00",
    "Reason": "Fails to *** pool: ***.",
    "SchedulingPolicyId": "policy-xxx"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
400	InDebt	Your account has overdue payments.	Your account has overdue payments.
400	NotEnabled	You have not enabled this service.	You have not enabled this service
403	GetResourceFailed	Failed to get resource.	Failed to get resource
403	RecommendEmpty.InstanceTypeSoldOut	The resource is out of stock.	Resources are sold out
403	PoolNotFound	The specified pool was not found.	Resource pool does not exist
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The request has failed due to a temporary failure of the server.
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
406	EcsError	An error occurred while calling the ECS API operation.	An error occurred while calling the ECS API operation.
406	DbError	A database error occurred.	A database error occurred.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.