Help Center/ Data Lake Insight/ API Reference/ Out-of-Date APIs/ Cluster-related APIs/ Querying All Cluster Information (Discarded)
Updated on 2023-11-27 GMT+08:00

Querying All Cluster Information (Discarded)

Function

This API is used to list all clusters under the project.

This API has been discarded and is not recommended.

URI

  • URI format

    GET/v2.0/{project_id}/clusters

  • Parameter description
    Table 1 URI parameter

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Project ID, which is used for resource isolation. For details about how to obtain its value, see Obtaining a Project ID.

Request

None

Response

  • Return code

    Code 200 is returned if the operation is successful.

  • Response parameters
    Table 2 Response parameters

    Parameter

    Mandatory

    Type

    Description

    create_time

    Yes

    Long

    Time when a cluster is created

    description

    No

    String

    Description of a cluster.

    cu_count

    Yes

    Integer

    Number of CUs that are bound to a cluster.

    owner

    Yes

    String

    User who creates the cluster.

    cluster_name

    Yes

    String

    Cluster name

    status

    Yes

    String

    Cluster status. For details, see Table 3.

    resource_mode

    Yes

    Integer

    Cluster type.

    • 0: Shared cluster
    • 1: Dedicated cluster

Example

  • Example request
    None
  • Example response (successful request)
    { 
       "clusters": [ 
         { 
          "create_time": 1508143955000, 
          "cu_count": 16, 
          "description": "test", 
          "owner": "tenant1", 
          "cluster_name": "cluster1",
          "status": "AVAILABLE",
          "resource_mode": 0
         } 
       ] 
     }

    If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see Error Codes.