Help Center/ Workspace/ API Reference/ Workspace APIs/ Quota/ Querying Resource Quotas

Updated on 2026-02-10 GMT+08:00

View PDF

Querying Resource Quotas

Function

Console Framework and WKSDesktopManager call this API to query tenant quotas.

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, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:quotas:get	Read	-	-	-	-

URI

GET /v2/{project_id}/quotas

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
quotas	QuotaNoLimit object	Quota information.
site_quotas	Array of SiteQuotaNoLimit objects	Site quota information, excluding the central site.

**Table 3** QuotaNoLimit
Parameter	Type	Description
resources	Array of ResourceNoLimit objects	Quota resources.

**Table 4** SiteQuotaNoLimit
Parameter	Type	Description
resources	Array of ResourceNoLimit objects	Quota resources.
site_id	String	Site ID.

**Table 5** ResourceNoLimit
Parameter	Type	Description
type	String	Resource type. general_instances: common desktop Memory: memory cores: CPU volumes: number of disks volume_gigabytes: disk capacity gpu_instances: GPU desktop deh: cloud office host users: user policy_groups: policy group Cores: CPU (used by the quota tool)
quota	Integer	Number of quotas.
used	Integer	Used quota.
unit	String	Quota unit.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/quotas

Example Responses

Status code: 200

Response to the request for querying tenant quotas.

{
  "quotas" : {
    "resources" : [ {
      "type" : "general_instances",
      "quota" : 10,
      "used" : 3
    }, {
      "type" : "volumes",
      "quota" : 500,
      "used" : 33
    }, {
      "type" : "volume_gigabytes",
      "quota" : 21500,
      "unit" : "GB",
      "used" : 2090
    }, {
      "type" : "cores",
      "quota" : 80,
      "used" : 10
    }, {
      "type" : "Memory",
      "quota" : 100,
      "unit" : "GB",
      "used" : 19
    }, {
      "type" : "gpu_instances",
      "quota" : 10,
      "used" : 0
    }, {
      "type" : "users",
      "quota" : 3000,
      "used" : 29
    }, {
      "type" : "policy_groups",
      "quota" : 10,
      "used" : 0
    }, {
      "type" : "Cores",
      "quota" : 80,
      "used" : 0
    } ]
  },
  "site_quotas" : [ {
    "site_id" : 147258369,
    "resources" : [ {
      "type" : "gpu_instances",
      "quota" : 50,
      "used" : 0
    }, {
      "type" : "ies_instances",
      "quota" : 500,
      "used" : 0
    } ]
  } ]
}

Status Codes

Status Code	Description
200	Response to the request for querying tenant quotas.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.