Help Center> Cloud Stream Service> API Reference> APIs> APIs Related to Cluster Management> Creating an Exclusive Cluster
View PDF

Creating an Exclusive Cluster

Function

This API is used to create an exclusive cluster for CS users with the cs_adm role. The exclusive cluster is converted to stream processing units (SPUs) for on-demand charging.

URI

  • URI format

    POST /v1.0/{project_id}/reserved_cluster

  • Parameter description
    Table 1 URI parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request

Create an exclusive cluster, for which the request parameters are in JSON format.

  • Example request 
    {
  "name": "mycluster",
  "desc": "This is my cluster.",
  "maximum_spu_quota": 100,
  "vpc_cidr": "172.16.0.0/23",
  "subnet_cidr": "172.16.0.0/23",
  "subnet_gateway": "172.16.0.1"
}
  • Parameter description
    Table 2 Request parameters

    Parameter

    Mandatory

    Type

    Description

    name

    Yes

    String

    Cluster name.

    desc

    No

    String

    Cluster description.

    maximum_spu_quota

    No

    Int

    Maximum SPU quota of a cluster.

    vpc_cidr

    No

    String

    VPC network segment where the cluster is located.

    subnet_cidr

    No

    String

    Subnet network segment where the cluster is located.

    subnet_gateway

    No

    String

    Subnet gateway for the cluster.

    tags

    No

    String

    Job tag.

    sys_enterprise_project_id

    No

    String

    ID of the enterprise project to which a job belongs.

    manager_node_spu

    No

    String

    SPU specifications of management nodes.

    is_arm_arch

    No

    Boolean

    CPU type of a cluster.

Response

  • Example response 
    {
  "message_id": "CS.21000",
  "message": "Cluster 1000000 is created successfully.",
  "payload": {
    "cluster_id": "1000000"
  },
  "current_time": 1550197806373
}
  • Parameter description
    Table 3 Response parameters

    Parameter

    Mandatory

    Type

    Description

    message_id

    No

    String

    Message type ID.

    message

    No

    String

    Message content.

    payload

    No

    None

    Information about the exclusive cluster.

    cluster_id

    No

    String

    Cluster ID.

    current_time

    No

    Int

    Current time, expressed by milliseconds.

Status Code

Table 4 describes the status code.

Table 4 Status code

Status Code

Description

200

An exclusive cluster is successfully created.

400

The input parameters are invalid.

Error Code

For details, see Error Codes.