UpdateQueue-阿里云帮助中心

Updates the configuration of a specified queue in an E-HPC cluster.

Operation description

When you update a queue configuration, the system sets all fields based on the parameters in your current request. If you call this operation multiple times, only the parameters from the last call take effect.

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

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	No	The cluster ID. Call ListClusters to get the cluster ID.	ehpc-hz-FYUr32****
Queue	object	No	The queue information to update.
QueueName	string	Yes	The queue name.	comp
EnableScaleOut	boolean	No	Enable auto scale-out for the queue. Valid values: true false	true
EnableScaleIn	boolean	No	Enable auto scale-in for the queue. Valid values: true false	true
MinCount	integer	No	The minimum number of nodes that the queue retains.	0
MaxCount	integer	No	The maximum number of compute nodes that the queue can retain.	1000
InitialCount	integer	No	The initial number of compute nodes in the queue.	0
InterConnect	string	No	The interconnect network type for compute nodes in the queue.	erdma
VSwitchIds	array	No	The list of vSwitches available for compute nodes in the queue.
	string	No	The vSwitch ID.	VSwitchId
ComputeNodes	array	No	The hardware configuration of compute nodes in the queue. Valid values for N: 1 to 10.
	NodeTemplate	No	The detailed configuration of a compute node.
AllocationStrategy	string	No	The strategy for selecting instance types when the queue scales out automatically. Valid values: PriorityInstanceType	PriorityInstanceType
RamRole	string	No	The name of the instance role attached to compute nodes in the queue.	AliyunECSInstanceForEHPCRole
HostnamePrefix	string	No	The hostname prefix for compute nodes in the queue.	compute
HostnameSuffix	string	No	The hostname suffix for compute nodes in the queue.	hpc
MaxCountPerCycle	integer	No	The minimum number of compute nodes created during auto scale-out.	99
KeepAliveNodes	array	No	The list of exceptional compute nodes in the queue.
	string	No	Hostname of the compute node to exclude.	compute000
ReservedNodePoolId	string	No

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
Success	boolean	Indicates whether the command succeeded. Valid values: true false	true

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
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	DbError	A database service error occurred.	Database request failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.