All Products
Search
Document Center

Elastic Compute Service:CreateHpcCluster

Last Updated:Nov 01, 2024

Creates a high performance computing (HPC) 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:
    • The required resource types are displayed in bold characters.
    • 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
ecs:CreateHpcClustercreate
  • HpcCluster
    acs:ecs:{#regionId}:{#accountId}:hpc/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the HPC cluster. You can call the DescribeRegions operation to query the most recent list of regions.

cn-hangzhou
ClientTokenstringNo

The client token that is used to ensure the idempotence of the request. You can use the client to generate a client token. Make sure that a unique client token is used for each request. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.

123e4567-e89b-12d3-a456-426655440000
RegionIdstringYes

The region ID of the HPC cluster. You can call the DescribeRegions operation to query the most recent list of regions.

cn-hangzhou
DescriptionstringNo

The description of the HPC cluster. The description must be 2 to 256 characters in length. It cannot start with http:// or https://.

This parameter is empty by default.

testHPCDescription
NamestringYes

The name of the HPC cluster. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.

hpc-Cluster-01

Response parameters

ParameterTypeDescriptionExample
object
HpcClusterIdstring

The ID of cluster.

hpc-pnlg1ds9rky4****
RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "HpcClusterId": "hpc-pnlg1ds9rky4****",
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter RegionId that is mandatory for processing this request is not supplied.-
400InvalidHpcClusterName.MalformedSpecified hpc cluster name is not valid.The specified HPC cluster name is invalid.
400InvalidHpcClusterDescription.MalformedThe specified parameter Description is not valid.The specified HPC cluster description is invalid.
400Invalid.ParameterInvalid parametersInvalid parameters.
404InvalidRegionId.NotFoundThe specified parameter "RegionId" is not valid.-
404InternalErrorFailed to create hpc clusterThe HPC cluster cannot be created.

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