Help Center/ GaussDB(for MySQL)/ API Reference/ APIs (Recommended)/ Quota Management/ Configuring Resource Quotas for a Specified Enterprise Project
Updated on 2024-09-11 GMT+08:00
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.

URI

POST /v3/{project_id}/quotas

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

To obtain this value, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

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 token value.

X-Language

No

String

Request language type. The default value is en-us.

Values:

  • en-us
  • zh-cn
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

quota_list

Yes

Array of setQuota objects

Quota details. Up to 10 quota records can be configured at a time.
Table 4 setQuota

Parameter

Mandatory

Type

Description

enterprise_project_id

Yes

String

Enterprise project ID.

instance_quota

No

Integer

Instance quantity quota. Value range: 0 to 100000.

NOTE:

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

vcpus_quota

No

Integer

vCPU quota. Value range: 0 to 2147483646.

NOTE:

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

ram_quota

No

Integer

Memory quota in GB. Value range: 0 to 2147483646.

NOTE:

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

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

quota_list

Array of setQuota objects

Configured quota information.
Table 6 setQuota

Parameter

Type

Description

enterprise_project_id

String

Enterprise project ID.

instance_quota

Integer

Instance quantity quota.

vcpus_quota

Integer

vCPU quota.

ram_quota

Integer

Memory quota in GB.

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