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

Terminating an Exclusive Cluster

Function

This API is used to terminate an exclusive cluster created by a user.

URI

  • URI format

    POST /v1.0/{project_id}/reserved_cluster/{cluster_id}/stop

  • 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

  • Example request 
    {
    "cluster_id":"10"
}
  • Parameter description
    Table 2 Request parameter

    Parameter

    Mandatory

    Type

    Description

    cluster_id

    Yes

    String

    ID of an exclusive cluster.

Response

  • Example response 
    {
 "message_id": "CS.20050",
  "message": "Cluster is stopping.",
  "current_time": 1533686888000
}
  • 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

The request for terminating an exclusive cluster is delivered successfully.

400

The input parameters are invalid.

Error Code

For details, see Error Codes.