SetSchedulerInfo - Elastic High Performance Computing - Alibaba Cloud Documentation Center

Configures the scheduler settings of a cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the ListRegions operation to obtain the IDs of regions supported by Elastic High Performance Computing (E-HPC).	cn-hangzhou
ClusterId	string	Yes	The ID of the E-HPC cluster. You can call the ListClusters operation to query the cluster ID.	ehpc-hz-FYUr32****
PbsInfo	object []	No	The information about PBS schedulers.
AclLimit	object []	No	The information about limits on the queue.
Queue	string	No	AclLimit specifies the queue that has limits when it is used. 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 user that can 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	object []	No	The information about the nodes that are used by cluster users.
Nodes	integer	No	The maximum number of nodes that can be used in a queue.	2
Cpus	integer	No	The maximum number of vCPUs that can be used 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 resources 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. If the total number of running jobs and queuing jobs exceeds the value, no more jobs can be submitted.	1000
JobHistoryDuration	integer	No	The retention period of jobs. After the retention period is exceeded, job data is deleted. Unit: days. Valid values: 1 to 30. Default value: 14.	14
SchedInterval	integer	No	PbsInfo specifies the number of PBS schedulers that can be configured in the cluster. Valid values of N: 0 to 100. SchedInterval specifies the scheduling period. Unit: seconds. A scheduling period is the interval between two consecutive running jobs. If you set SchedInterval to 60, another job can be run 60 seconds after a job starts running. Default value: 60.	60
SchedMaxJobs	integer	No	The maximum number of jobs that can be scheduled in the cluster. If the total number of running jobs and queuing jobs exceeds the value, no more jobs can be submitted. Default value: 20000.	20000
SchedMaxQueuedJobs	integer	No	The maximum number of queuing jobs that can be scheduled in the cluster. If the number of queuing jobs exceeds the value, no more jobs can be submitted. Default value: 10000.	10000
SlurmInfo	object []	No	The information about Slurm schedulers.
BackfillInterval	integer	No	The backfill scheduling period. Unit: seconds. Default value: 60.	60
SchedInterval	integer	No	SlurmInfo specifies the number of Slurm schedulers that can be configured in the cluster. Valid values of N: 0 to 100. SchedInterval specifies the scheduling period. Unit: seconds. Default value: 60.	60
Scheduler	object []	Yes	The scheduler information.
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 parameters

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

Examples

Sample success responses

JSONformat

{
  "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.
404	ClusterNotFound	The target cluster is not found.	The target cluster is not found.
406	AliyunError	An Alibaba Cloud product error occurred.	An Alibaba Cloud product error occurred.
406	DbError	A database service error occurred.	Database request failed.
406	EcsError	An error occurred while calling the ECS API operation.	An error occurred while calling the ECS API operation.
407	NotAuthorized	No authorization is granted.	No authorization is granted.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
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.

For a list of error codes, visit the Service error codes.