Help Center/ TaurusDB/ API Reference/ APIs (Recommended)/ Quota Management/ Configuring Resource Quotas for a Specified Enterprise Project
Updated on 2025-10-21 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Configuring Resource Quotas for a Specified Enterprise Project

Function

This API is used to configure resource quotas for a specified enterprise project. Before calling this API:

Constraints

This API is in the open beta test (OBT) phase. To use this API, submit a service ticket.

Calling Method

For details, see Calling APIs.

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

    Dependency

    gaussdbformysql:quota:modify

    Write

    -

    -

    gaussdb:quota:modify

    -

URI

POST /v3/{project_id}/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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. To obtain this value, call the IAM API for obtaining a user token.

The value of X-Subject-Token in the response header is the token value.

Constraints

N/A

Range

N/A

Default Value

N/A

X-Language

No

String

Definition

Request language type.

Constraints

N/A

Range

  • en-us

  • zh-cn

Default Value

en-us
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

quota_list

Yes

Array of setQuota objects

Definition

Resource objects.

Constraints

N/A
Table 4 setQuota

Parameter

Mandatory

Type

Description

enterprise_project_id

Yes

String

Definition

Enterprise project ID.

Constraints

N/A

Range

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

Default Value

N/A

instance_quota

No

Integer

Definition

Instance quantity quota.

Constraints

N/A

Range

  • 0–100000 (If there are already instances created, this parameter value must be greater than the number of existing instances.)

  • -1: no limit

Default Value

N/A

vcpus_quota

No

Integer

Definition

vCPU quota.

Constraints

N/A

Range

  • 0–2147483646 (If there are already instances created, this parameter value must be greater than the number of used vCPUs.)

  • -1: no limit

Default Value

N/A

ram_quota

No

Integer

Definition

Memory quota, in GB.

Constraints

N/A

Range

  • 0–2147483646 (If there are already instances created, this parameter value must be greater than the used memory size.)

  • -1: no limit

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

quota_list

Array of setQuota objects

Definition

Resource objects.

Constraints

N/A
Table 6 setQuota

Parameter

Type

Description

enterprise_project_id

String

Definition

Enterprise project ID.

Constraints

N/A

Range

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

Default Value

N/A

instance_quota

Integer

Definition

Instance quantity quota.

Constraints

N/A

Range

  • 0–100000 (If there are already instances created, this parameter value must be greater than the number of existing instances.)

  • -1: no limit

Default Value

N/A

vcpus_quota

Integer

Definition

vCPU quota.

Constraints

N/A

Range

  • 0–2147483646 (If there are already instances created, this parameter value must be greater than the number of used vCPUs.)

  • -1: no limit

Default Value

N/A

ram_quota

Integer

Definition

Memory quota, in GB.

Constraints

N/A

Range

  • 0–2147483646 (If there are already instances created, this parameter value must be greater than the used memory size.)

  • -1: no limit

Default Value

N/A

Example Request

Configuring resource quotas

POST https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/quotas
{
  "quota_list" : [ {
    "enterprise_project_id" : "0",
    "instance_quota" : 20,
    "vcpus_quota" : 20,
    "ram_quota" : 40
  } ]
}

Example Response

Status code: 200

Success.

{
  "quota_list" : [ {
    "enterprise_project_id" : "0",
    "instance_quota" : 20,
    "vcpus_quota" : 20,
    "ram_quota" : 40
  } ]
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

Parent topic: Quota Management