Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Quota Management/ Verifying Quota
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Verifying Quota

Function

Verifies the quota. Before purchasing a server, you can call this API to check whether the server resources are sufficient.

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 /v1/{project_id}/check/quota

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

product_id

Yes

String

Product ID

flavor_id

No

String

Specification ID.

subscription_num

Yes

Integer

Total number of instances to be created and purchased

disk_size

Yes

Integer

Disk size required by a single instance (a maximum of one system disk of 1024 GB and 10 data disks of 32,768 GB)

disk_num

Yes

Integer

Number of disks required by a single instance (a maximum of one system disk and 10 data disks)

is_period

No

Boolean

Whether the monthly/yearly subscription is used

deh_id

No

String

Host ID.

cluster_id

No

String

ID of the cloud-based dedicated distributed storage pool

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token.

It can be obtained by calling the IAM API 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

is_enough

Boolean

Indicates whether quotas are enough. The options can be true (yes) and false (no).

quota_remainder

Array of QuotaRemainderData objects

Number of remaining quotas.
Table 5 QuotaRemainderData

Parameter

Type

Description

type

String

Quota – Resource type:

  • GPU_INSTANCES: number of GPU resource instances

  • INSTANCES: number of common instances

  • VOLUME_GIGABYTES: total disk capacity, in GB

  • VOLUMES: number of disks

  • CORES: number of CPUs

  • MEMORY: memory capacity, in MB

remainder

Integer

Remaining quota.

need

Integer

Required quota.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

/v1/a4da8115c9d8464ead3a38309130523f/check/quota?disk_size=60&subscription_num=1&disk_num=1&product_id=workspace.appstream.general.xlarge.2

Example Responses

Status code: 200

Response to verifying whether the requested resources of an order are available.

{
  "is_enough" : true,
  "quota_remainder" : [ {
    "type" : "INSTANCES",
    "remainder" : 490,
    "need" : 1
  }, {
    "type" : "VOLUME_GIGABYTES",
    "remainder" : 69360,
    "need" : 60
  }, {
    "type" : "VOLUMES",
    "remainder" : 9990,
    "need" : 1
  }, {
    "type" : "CORES",
    "remainder" : 39980,
    "need" : 2
  }, {
    "type" : "MEMORY",
    "remainder" : 99959040,
    "need" : 4096
  } ]
}

Status Codes

Status Code

Description

200

Response to verifying whether the requested resources of an order are available.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

Resources not found.

405

The method specified in the request is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Quota Management