Help Center/ GeminiDB/ API Reference/ API v3/ Enterprise Projects/ Querying Enterprise Project Quotas
Updated on 2026-09-22 GMT+08:00

Querying Enterprise Project Quotas

Function

This API is used to query enterprise project quotas.

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • 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

    gaussdbfornosql::listEpsQuota

    List

    -

    -

    nosql:quota:list

    -

URI

GET /v3/{project_id}/enterprise-projects/quotas

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

enterprise_project_name

No

String

Definition

Enterprise project name.

To obtain the enterprise project ID, see the response parameter enterprise_projects in section "Listing Enterprise Projects" in Enterprise Management API Reference.

Constraints

Fuzzy search is supported. If this parameter is not specified, all enterprise project quotas are returned.

Range

N/A

Default Value

N/A

offset

No

Integer

Definition

Index offset. The query starts from the next piece of data indexed by this parameter.

Constraints

The value must be a number greater than or equal to 0.

Range

≥ 0

Default Value

0

limit

No

Integer

Definition

Maximum records to be queried.

Constraints

The value must be a number greater than or equal to 1.

Range

1–100

Default Value

100

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total_count

Integer

Definition

Total number of records.

Range

≥ 0

quotas

Array of NoSqlQueryEpsQuotaInfo objects

Definition

Quota information.

Table 5 NoSqlQueryEpsQuotaInfo

Parameter

Type

Description

enterprise_project_id

String

Definition

Enterprise project ID.

Range

N/A

enterprise_project_name

String

Definition

Enterprise project name.

Range

N/A

quota

NoSqlEpsQuotaTotal object

Definition

Enterprise project quotas.

used

NoSqlEpsQuotaUsed object

Definition

Enterprise project quota used.

Table 6 NoSqlEpsQuotaTotal

Parameter

Type

Description

instance

Integer

Definition

Instance quota.

Range

0–5,000

vcpus

Integer

Definition

vCPU quota.

Range

0–8,000,000

ram

Integer

Definition

RAM quota, in GB.

Range

0–16,000,000

Table 7 NoSqlEpsQuotaUsed

Parameter

Type

Description

instance

Integer

Definition

Used instance quota.

Range

0–5,000

vcpus

Integer

Definition

Quota of used vCPUs.

Range

0–8,000,000

ram

Integer

Definition

Used RAM quota, in GB.

Range

0–16,000,000

Example Requests

URI example
GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/enterprise-projects/quotas?enterprise_project_name=test&offset=1&limit=10

Example Responses

Status code: 200

Success

{ 
  "quotas" : [ { 
    "enterprise_project_id" : "c0348bb1-d09d-4ee2-8edd-53e496fe6b52", 
    "enterprise_project_name" : "test1", 
    "quota" : { 
      "instance" : 500, 
      "vcpus" : 1000, 
      "ram" : 2000 
    }, 
    "used" : { 
      "instance" : 15, 
      "vcpus" : 88, 
      "ram" : 256 
    } 
  }, { 
    "enterprise_project_id" : "780a6b1f-58b8-4df6-a85e-326d052de704", 
    "enterprise_project_name" : "test2", 
    "quota" : { 
      "instance" : 500, 
      "vcpus" : 1000, 
      "ram" : 2000 
    }, 
    "used" : { 
      "instance" : 36, 
      "vcpus" : 64, 
      "ram" : 192 
    } 
  } ], 
  "total_count" : 2 
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.