Help Center/ ModelArts/ API Reference/ Service Management/ Obtaining Dedicated Resource Pools

Updated on 2024-06-13 GMT+08:00

View PDF

Obtaining Dedicated Resource Pools

Function

This API is used to obtain dedicated resource pools.

URI

GET /v1/{project_id}/clusters

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID and Name.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
cluster_name	No	String	Cluster name. By default, the cluster name is not filtered.
status	No	String	Cluster status. By default, the status is not filtered.
offset	No	Integer	Start page for pagination display. The default value is 0.
limit	No	Integer	Maximum number of records returned on each page. Default value: 1000
sort_by	No	String	Sorting field. Options: created_at: default value cluster_name
order	No	String	Sorting mode. Options: asc: ascending order desc: descending order (default value)

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_count	Integer	Total number of clusters that meet the search criteria when no paging is performed
count	Integer	Number of clusters in the query result. If offset and limit are not configured, the values of count and total are the same.
clusters	Array of Cluster objects	Obtained clusters

**Table 5** Cluster
Parameter	Type	Description
owner	String	User to which a cluster belongs
cluster_name	String	Cluster name
period_num	Integer	Number of subscription periods. This parameter is returned only when the cluster is billed on a yearly/monthly basis.
created_at	Integer	Time when a cluster is created, in milliseconds calculated from 1970.1.1 0:0:0 UTC.
description	String	Cluster description
project	String	Project to which a cluster belongs
allocatable_memory	Integer	Number of available memory resources
cluster_id	String	Cluster ID
nodes	ClusterNode object	Cluster node configurations
allocatable_cpu_cores	Float	Number of available CPU cores
product_id	String	Product ID. This parameter is returned only when the cluster is billed on a yearly/monthly basis.
allocatable_gpus	Float	Number of available GPUs
order_id	String	Order ID. This parameter is returned only when the cluster is billed on a yearly/monthly basis.
period_type	String	Subscription period, which can be year or month. This parameter is returned only when the cluster is billed on a yearly/monthly basis.
tenant	String	Tenant to which a cluster belongs
status	String	Cluster status. Options: deploying: The cluster is being deployed. running: The cluster is running. concerning: An alarm has been reported for the cluster. abnormal: The cluster malfunctions.

**Table 6** ClusterNode
Parameter	Type	Description
available_count	Integer	Number of available nodes
count	Integer	Number of nodes
specification	String	Node specifications

Example Requests

GET https://{endpoint}/v1/{project_id}/clusters

Example Responses

Status code: 200

Service deployment flavors

{
  "total_count" : 1,
  "count" : 1,
  "clusters" : [ {
    "cluster_id" : "ff808081673fbb3d01673fbb824d0000",
    "cluster_name" : "my-cluster",
    "description" : "",
    "tenant" : "tenant_id",
    "project" : "project_id",
    "owner" : "owner_id",
    "created_at" : 1574923077927,
    "status" : "running",
    "nodes" : {
      "specification" : "modelarts.vm.cpu.8ud",
      "count" : 1,
      "available_count" : 1
    },
    "allocatable_cpu_cores" : 5.5,
    "allocatable_memory" : 4096,
    "allocatable_gpus" : 0.5
  } ]
}