Help Center/ Workspace/ API Reference/ Workspace APIs/ Quota/ Querying Tenant Quota Details of a Single Site
Updated on 2026-02-10 GMT+08:00

Querying Tenant Quota Details of a Single Site

Function

Queries tenant quota details of a single site.

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/detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

site_id

No

String

Site ID.

az_code

No

String

AZ code.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

resources

Array of ResourceNoLimit objects

Quota resources.

site_id

String

Site ID.

Table 4 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 5 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 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: 403

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: 404

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: 500

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.

Example Requests

GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/quotas/detail?site_id=147258369&az_code=cn-north-7-ies-ohzce

Example Responses

Status code: 200

Response to the request for querying tenant quotas.

{
  "resources" : [ {
    "type" : "string",
    "quota" : 2147483647,
    "used" : 2147483647,
    "unit" : "string"
  } ],
  "site_id" : "string"
}

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.

Error Codes

See Error Codes.