Querying the List of Cluster Overview Information

Function

This API is used to query the cluster overview information list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/service/instances/overview

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Project ID and Account ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of records that can be queried.
offset	No	Integer	Start coordinate of the query.
name	No	String	Cluster name. This parameter supports fuzzy match.
create_user	No	String	Creator name.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. You can obtain it from the value of X-Subject-Token in the response message header returned by the "Obtaining a User Token" API of the IAM service.
workspace	Yes	String	Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID.
Dlm-Type	No	String	Specifies the version type of the data service. The value can be SHARED or EXCLUSIVE.
Content-Type	No	String	Type (format) of the message body. This parameter is mandatory if the message body exists. If the message body does not exist, leave this parameter blank. If the request body contains Chinese characters, use charset=utf8 to specify the Chinese character set, for example, application/json;charset=utf8.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Number of clusters
scale_down	Boolean	Specifies whether scale-in is supported.
scale_out	Boolean	Specifies whether capacity expansion is supported.
instances	Array of InstanceOverviewDTO objects	Cluster overview information.

**Table 5** InstanceOverviewDTO
Parameter	Type	Description
id	String	Cluster ID
name	String	Cluster name
description	String	Provides supplementary information about the cluster.
external_address	String	External IP address.
intranet_address	String	Internal IPv4 address.
intranet_address_ipv6	String	Internal IPv6 address.
public_zone_id	String	Public zone ID.
public_zone_name	String	Specifies the public zone name.
private_zone_id	String	Specifies the private zone ID.
private_zone_name	String	Specifies the private zone name.
enterprise_project_id	String	Enterprise project ID
create_time	Long	Time when the bandwidth was specified.
create_user	String	Creator.
current_namespace_publish_api_num	Integer	Number of APIs that have been published in the current workspace.
all_namespace_publish_api_num	Integer	Number of APIs that have been published in all workspaces.
api_publishable_num	Integer	Specifies the total API quota of a cluster.
deletable	Boolean	Specifies whether a cluster can be deleted.
charge_status	String	Charging status of a cluster. The options are as follows: NO_CHARGE: not charged; CHARGED: charged; GRACE: grace period; RETENTION: retention period.
order_id	String	Order ID

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Example Requests

Query the list of cluster overview information.

/v1/0833a5737480d53b2f250010d01a7b88/service/instances/overview

Example Responses

Status code: 200

The request is successful.

{
  "total" : 1,
  "scale_down" : false,
  "scale_out" : false,
  "instances" : [ {
    "id" : "c830776ec23fdffe237a44845f871180",
    "name" : "dlm_HCS_20240205",
    "description" : "",
    "external_address" : "100.85.122.140",
    "intranet_address" : "192.168.0.157",
    "intranet_address_ipv6" : "2407:c080:11f0:535:8b8f:1825:a0d8:669",
    "private_zone_id" : null,
    "private_zone_name" : null,
    "public_zone_id" : null,
    "public_zone_name" : null,
    "enterprise_project_id" : "0",
    "create_time" : 1708400912000,
    "create_user" : "user",
    "current_namespace_publish_api_num" : 1,
    "all_namespace_publish_api_num" : 1,
    "api_publishable_num" : 500,
    "deletable" : true,
    "charge_status" : "CHARGED",
    "order_id" : "c0c3fd9770a54baa8a430ef82218732f"
  } ]
}