Modifying Resource Quotas

Function

This API is used to modify the resource quota of a specified enterprise project.

Precautions

Before using this API, ensure that the enterprise project has been enabled and you have the gaussdb:quota:modify permission.

URI

PUT /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.

X-Language

No

String

Language.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

quota_list

Yes

Array of setQuota objects

Enterprise project resource quotas to be updated. A maximum of 10 quotas can be updated at a time.

Table 4 setQuota

Parameter

Mandatory

Type

Description

enterprise_project_id

Yes

String

Enterprise project ID.

enterprise_project_name

Yes

String

Enterprise project name.

instance_quota

Yes

Integer

Quota of the DB instance quantity. Value: 0 to 100000. (If there are already instances created, this parameter value must be greater than the number of existing instances.)

vcpus_quota

Yes

Integer

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

ram_quota

Yes

Integer

Memory quota in GB. Value: 0 to 2147483646. (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.

enterprise_project_name

String

Enterprise project name.

instance_quota

Integer

Quota of the DB instance quantity.

vcpus_quota

Integer

Quota of vCPUs.

ram_quota

Integer

Memory quota in GB.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Request

PUT https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/quotas
{
  "quota_list" : [ {
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default",
    "instance_quota" : 20,
    "vcpus_quota" : 20,
    "ram_quota" : 40
  } ]
}

Example Response

Status code: 200

Success.

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

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.