CreatePool-阿里云帮助中心

Creates a 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:CreatePool

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PoolName	string	Yes	The name of the pool. The name can be up to 15 characters long. The name can contain digits, uppercase and lowercase letters, underscores (_), and periods (.).	PoolTest
Priority	integer	No	The priority of the pool. Valid values: 1 to 99. The default value is 1, which indicates the lowest priority. Jobs in higher-priority pools are scheduled before pending jobs in lower-priority pools. The pool's priority overrides an individual job's priority.	1
ResourceLimits	object	No	The limits on the resources that a single user can use concurrently in the pool.
MaxExecutorNum	integer	No	The maximum number of executor nodes a user can run concurrently in a pool.

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	896D338C-E4F4-41EC-A154-D605E5DE****

Examples

Success response

JSON format

{
  "RequestId": "896D338C-E4F4-41EC-A154-D605E5DE****"
}

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
400	PoolAlreadyExists	The pool already exists.	Pool already exists
403	GetResourceFailed	Failed to get resource.	Failed to get resource
403	RecommendEmpty.InstanceTypeSoldOut	The resource is out of stock.	Resources are sold out
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.