Creating a Hyper Cluster

Function

This API is used to create a hyper cluster in the system. It is used when you need to use a supernode network and create a hyper cluster. Before using this API, ensure that you have logged in to the system and have the permission to create a hyper cluster, and the required resources have been configured in the system. After the creation, a supernode network is created, and details about the supernode network are returned, including the ID, name, and subnet information. If you do not have the required permission, the system does not have the required resources, or the configuration parameters are invalid, the API returns an error message.

Constraints

No constraints.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/dev-servers/hyper-clusters

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: User project ID. Constraints: Mandatory. Range: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition: Name of the hyper cluster. Range: ^[-_.a-zA-Z0-9]{1,64}$
hyper_cluster_subnet_id	No	String	Definition: ID of the hyper cluster. Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
type	No	String	Definition: Server type. Constraints: N/A. Range: HPS: Supernode server ECS: Elastic Cloud Server Default Value: N/A.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition: ID of the hyper cluster. Range: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
name	String	Definition: Name of the hyper cluster. Range: ^[-_.a-zA-Z0-9]{1,64}$
network_info	Array of network_info objects	Network information.

**Table 4** network_info
Parameter	Type	Description
hyper_cluster_subnet_id	String	Definition: Subnet name of the hyper cluster. Range: ^[-_.a-zA-Z0-9]{1,64}$
is_default	Boolean	Definition: Indicates whether the network is default. Constraints: N/A Range true: default network false: non-default network

Example Requests

POST https://{endpoint}/v1/{project_id}/dev-servers/hyper-clusters

{
  "name" : "test-hps--1107"
}

Example Responses

Status code: 200

{
  "id" : "74437437-6810-43b8-ba20-8f8e5bc034da",
  "name" : "test-hps--1107",
  "network_info" : [ {
    "hyper_cluster_subnet_id" : "47be1c96-b00c-4cc9-83cb-089893a632b6",
    "is_default" : true
  } ]
}