All Products
Search

This Product

    Elastic High Performance Computing:SetSchedulerInfo

    Document Center

    Elastic High Performance Computing:SetSchedulerInfo

    Last Updated:Jul 31, 2025

    Configures the scheduler settings of a cluster.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • For mandatory resource types, indicate with a prefix of * .
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    ehpc:SetSchedulerInfo
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    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
    ClusterIdstringYes

    The ID of the E-HPC cluster.

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

    		ehpc-hz-FYUr32****
    PbsInfoarray<object>No

    The information about PBS schedulers.

    objectNo
    AclLimitarray<object>No

    The information about limits on the queue.

    objectNo
    QueuestringNo

    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
    AclUsersstringNo

    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
    ResourceLimitarray<object>No

    The information about the nodes that are used by cluster users.

    objectNo
    NodesintegerNo

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

    		2
    CpusintegerNo

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

    		2
    UserstringNo

    The name of the user that runs jobs.

    		user1
    QueuestringNo

    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
    MemstringNo

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

    • gb
    • mb
    • kb
    		2gb
    MaxJobsintegerNo

    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
    JobHistoryDurationintegerNo

    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
    SchedIntervalintegerNo

    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
    SchedMaxJobsintegerNo

    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
    SchedMaxQueuedJobsintegerNo

    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
    SlurmInfoarray<object>No

    The information about Slurm schedulers.

    objectNo
    BackfillIntervalintegerNo

    The backfill scheduling period. Unit: seconds.

    Default value: 60.

    		60
    SchedIntervalintegerNo

    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
    Schedulerarray<object>Yes

    The scheduler information.

    objectYes
    SchedNamestringYes

    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

    ParameterTypeDescriptionExample
    object
    Messagestring

    The data returned.

    		pbs: scheduler setting successfully.
    RequestIdstring

    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 codeError codeError messageDescription
    400InvalidParamsThe specified parameter %s is invalid.The specified parameter %s is invalid.
    404ClusterNotFoundThe target cluster is not found.The target cluster is not found.
    406AliyunErrorAn Alibaba Cloud product error occurred.Alibaba Cloud product error. %s
    406DbErrorA database service error occurred.Database request failed.
    406EcsErrorAn error occurred while calling the ECS API operation.ECS API call error. %s
    407NotAuthorizedNo authorization is granted.No authorization is granted.
    500UnknownErrorAn unknown error occurred.An unknown error occurred.
    503ServiceUnavailableThe request has failed due to a temporary failure of the serverThe request has failed due to a temporary failure of the server.

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

    Change history

    Change timeSummary of changesOperation
    No change history