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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes SetSchedulerInfo

The operation that you want to perform. Set the value to SetSchedulerInfo.

ClusterId String Yes ehpc-hz-FYUr32****

The ID of the cluster.

You can call the ListClusters operation to obtain the cluster ID.

RegionId String Yes cn-hangzhou

The ID of the region.

You can call the ListRegions operation to obtain the IDs of regions supported by Elastic High Performance Computing (E-HPC).

Scheduler.N.SchedName String Yes pbs

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, 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.
PbsInfo.N.SchedInterval Integer No 60

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

PbsInfo.N.JobHistoryDuration Integer No 14

The retention period of jobs. After the retention period is exceeded, job data is deleted. Unit: days.

Default value: 14

PbsInfo.N.ResourceLimit.N.Queue String No workq

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.

PbsInfo.N.ResourceLimit.N.User String No user1

The name of the user that runs jobs.

PbsInfo.N.ResourceLimit.N.Cpus Integer No 2

The maximum number of vCPUs that can be used for nodes in a queue.

PbsInfo.N.ResourceLimit.N.Nodes Integer No 2

The maximum number of nodes that can be used in a queue.

PbsInfo.N.ResourceLimit.N.Mem String No 2gb

The maximum memory resources that can be used in a queue. Units:

  • gb
  • mb
  • kb
PbsInfo.N.AclLimit.N.Queue String No workq

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.

PbsInfo.N.AclLimit.N.AclUsers String No user1,user2

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.

SlurmInfo.N.SchedInterval Integer No 60

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

SlurmInfo.N.BackfillInterval Integer No 60

The backfill scheduling period. Unit: seconds.

Default value: 60

Response parameters

Parameter Type Example Description
Message String pbs: scheduler setting successfully.

The response message.

RequestId String BBC2F93D-003A-49C4-850C-B826EECF****

The ID of the request.

Examples

Sample requests

http(s)://ehpc.cn-hangzhou.aliyuncs.com/?Action=SetSchedulerInfo
&ClusterId=ehpc-hz-FYUr32****
&RegionId=cn-hangzhou
&Scheduler.1.SchedName=pbs
&<Common request parameters>

Sample success responses

XML format

<SetSchedulerInfoResponse>
  <Message>pbs: scheduler setting successfully.</Message>
  <RequestId>BBC2F93D-003A-49C4-850C-B826EECF****</RequestId>
</SetSchedulerInfoResponse>

JSON format

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

Error codes

HttpCode Error code Error message Description
406 AliyunError An Alibaba Cloud product error occurred. The error message returned because the operation has failed to call another Alibaba Cloud service.
404 ClusterNotFound The target cluster is not found. The error message returned because the specified cluster does not exist.
406 DbError A database service error occurred. The error message returned because the database request has failed.
406 EcsError An error occurred while calling the ECS API operation. The error message returned because the ECS API call has failed.
400 InvalidParams The specified parameter %s is invalid. The error message returned because the following parameter is invalid: %s.
407 NotAuthorized No authorization is granted. The error message returned because you are not authorized by RAM for the request.
500 UnknownError An unknown error occurred. The error message returned because an unknown error has occurred.
503 ServiceUnavailable The request has failed due to a temporary failure of the server The error message returned because the request has failed. The service is temporarily unavailable.

For a list of error codes, visit the API Error Center.