Use SetSchedulerInfo API to configure cluster scheduler settings - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Configures the scheduler settings of an Elastic High Performance Computing (E-HPC) cluster.

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:SetSchedulerInfo

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the ListRegions operation to query the regions supported by E-HPC.	cn-hangzhou
ClusterId	string	Yes	The ID of the cluster. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-FYUr32****
PbsInfo	array<object>	No	The PBS scheduler configurations.
	array<object>	No
AclLimit	array<object>	No	The access control limits on the queue.
	object	No
Queue	string	No	The queue to which access control limits apply. Valid values of N: 0 to 100. If you set `PbsInfo.N.AclLimit.N.Queue` to `workq` and `PbsInfo.N.AclLimit.N.AclUsers` to `user1,user2`, workq can be used only by user1 and user2.	workq
AclUsers	string	No	The users allowed to use the queue. Separate multiple users with commas (`,`). If you specify users, you must specify the PbsInfo.N.AclLimit.N.Queue parameter.	user1,user2
ResourceLimit	array<object>	No	The resource limits for nodes used by cluster users.
	object	No
Nodes	integer	No	The maximum number of nodes available in a queue.	2
Cpus	integer	No	The maximum number of vCPUs available for nodes in a queue.	2
User	string	No	The name of the user that runs jobs.	user1
Queue	string	No	PbsInfo specifies the number of PBS schedulers that can be configured in the cluster. Valid values of N: 0 to 100. ResourceLimit specifies the maximum number of queue resources that can be used. Valid values of N: 0 to 100. Queue specifies the name of the queue that is used to run jobs. If one of the User, Cpus, Nodes, and Mem parameters is set in ResourceLimit, you must specify the Queue parameter.	workq
Mem	string	No	The maximum memory that can be used in a queue. Units: gb mb kb	2gb
MaxJobs	integer	No	The maximum number of jobs that can be submitted to the cluster. No more jobs can be submitted if the total number of running and queued jobs exceeds this value.	1000
JobHistoryDuration	integer	No	The retention period of job history. Job data is deleted after this period expires. Unit: days. Valid values: 1 to 30. Default value: 14.	14
SchedInterval	integer	No	The scheduling interval between two consecutive job runs. Unit: seconds. Valid values of N: 0 to 100. For example, if you set SchedInterval to 60, the next job starts 60 seconds after the previous job begins running. Default value: 60.	60
SchedMaxJobs	integer	No	The maximum number of jobs that can be scheduled in the cluster. No more jobs can be submitted if the total number of running and queued jobs exceeds this value. Default value: 20000.	20000
SchedMaxQueuedJobs	integer	No	The maximum number of queued jobs in the cluster. No more jobs can be submitted if the number of queued jobs exceeds this value. Default value: 10000.	10000
SlurmInfo	array<object>	No	The Slurm scheduler configurations.
	object	No
BackfillInterval	integer	No	The backfill scheduling period. Unit: seconds. Default value: 60.	60
SchedInterval	integer	No	The scheduling interval. Unit: seconds. Valid values of N: 0 to 100. Default value: 60.	60
Scheduler	array<object>	Yes	The scheduler type.
	object	No
SchedName	string	Yes	The name of the scheduler. Valid values: pbs pbs19 slurm slurm19 slurm20 Note If you set Scheduler.N.SchedName to pbs or pbs19, you must specify at least one of the PbsInfo.N.SchedInterval, PbsInfo.N.JobHistoryDuration, PbsInfo.N.ResourceLimit, and PbsInfo.N.AclLimit parameters. If you set Scheduler.N.SchedName to slurm, slurm19, or slurm20, you must specify at least one of the SlurmInfo.N.SchedInterval and SlurmInfo.N.BackfillInterval parameters.	pbs

Response elements

Element	Type	Description	Example
	object
Message	string	The response data.	pbs: scheduler setting successfully.
RequestId	string	The request ID.	BBC2F93D-003A-49C4-850C-B826EECF****

Examples

Success response

JSON format

{
  "Message": "pbs: scheduler setting successfully.",
  "RequestId": "BBC2F93D-003A-49C4-850C-B826EECF****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
404	ClusterNotFound	The target cluster is not found.	The target cluster is not found.
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	DbError	A database service error occurred.	Database request failed.
406	EcsError	An error occurred while calling the ECS API operation.	ECS API call error. %s
407	NotAuthorized	No authorization is granted.	No authorization is granted.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.