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

Updating an Exclusive Cluster

Function

This API is used to update exclusive clusters created by a user.

URI

  • URI format

    PATCH /v1.0/{project_id}/reserved_cluster/{cluster_id}

  • 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.

    cluster_id

    Yes

    ID of an exclusive cluster.

Request

Submit the request for modifying an exclusive cluster.

  • Example request 
    {
"name": "my_cluster",
  "desc": "This is my_cluster.",
  "maximum_spu_quota": 100
}
  • 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.

    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.

Response

  • Example response 
    {
  "message_id": "CS.21030",
  "message": "Cluster 1000000 is updated successfully.",
  "current_time": 1550201682465
}
  • Parameter description
    Table 3 Response parameters

    Parameter

    Mandatory

    Type

    Description

    message_id

    No

    String

    Message type ID.

    message

    No

    String

    Message content.

    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 updated.

400

The input parameters are invalid.

Error Code

For details, see Error Codes.