Help Center/ ModelArts/ API Reference/ Lite Server Management/ Querying the Logical Capacity Calculation Result of the hyperinstance-clusters Supernode

Updated on 2026-01-30 GMT+08:00

Online Debugging

CLI Examples

View PDF

Querying the Logical Capacity Calculation Result of the hyperinstance-clusters Supernode

Function

This API is used to obtain the logical capacity calculation result of a specified hyper instance cluster. It is used when you need to know the resource usage and capacity planning of a supernode cluster for resource management and optimization. Before using this API, ensure that you have logged in to the system and have the permission to query the logical capacity of a supernode cluster, and the specified supernode cluster exists. After the query, the API returns the logical capacity calculation result of a specified supernode cluster, including the available capacity information. If you do not have the required permission to perform the operation, the specified supernode cluster does not exist, or the cluster ID is invalid, the API returns an error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v1/{project_id}/dev-servers/hyperinstance/cluster-capacity-evaluations

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
hyperinstance_cluster_ids	No	Array of strings	Supernode cluster ID list.
flavor	No	String	Flavor name.
availability_zone	No	String	AZs.
resource_flavor	No	String	Resource flavor.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
capacities	Array of ServerHpsClusterCapacity objects	Capacity information list.

**Table 4** ServerHpsClusterCapacity
Parameter	Type	Description
flavor	String	Flavor name.
availability_zone	String	AZ ID.
hyperinstance_cluster_id	String	Supernode cluster ID.
hyperinstance_cluster_name	String	Supernode cluster name.
resource_flavor	String	Resource flavor.
is_sold_out	Boolean	On-sale status.

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Status code: 404

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Definition: ModelArts error code. Range: N/A
error_msg	String	Definition: Error message. Range: N/A

Example Requests

POST https://{endpoint}/v1/{project_id}/dev-servers/hyperinstance/cluster-capacity-evaluations

{
  "hyperinstance_cluster_ids" : [ "a1b2c3d4-e5f6-7890-abcd-ef1234567890" ],
  "flavor" : "kat3ne-8.48xlarge.8.800t.matrix",
  "availability_zone" : "cn-east-3a",
  "resource_flavor" : "gpu.8xlarge"
}

Example Responses

Status code: 200

Capacity query result.

{
  "capacities" : [ {
    "flavor" : "kat3ne-8.48xlarge.8.800t.matrix",
    "availability_zone" : "cn-east-3a",
    "hyperinstance_cluster_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "hyperinstance_cluster_name" : "production-cluster-1",
    "resource_flavor" : "gpu.8xlarge",
    "is_sold_out" : true
  }, {
    "flavor" : "kat3ne-16.96xlarge.16.1600t.matrix",
    "availability_zone" : "cn-east-3b",
    "hyperinstance_cluster_id" : "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "hyperinstance_cluster_name" : "production-cluster-2",
    "resource_flavor" : "gpu.16xlarge",
    "is_sold_out" : true
  } ]
}