proposalbot fe5dbb94c5 Changes to gaussdb_mysql_api-ref from docs/doc-exports#546 (gaussdb API 20221230

Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

2023-06-12 09:45:17 +00:00

7.8 KiB

Raw Blame History

original_name: gaussdb_04_0012.html

Configuring Resource Quotas

Function

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

Learn how to authorize and authenticate <gaussdb_03_0001> it.
Obtain the required region and endpoint <gaussdb_00_0003>.

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 <gaussdb_10_0004>`.

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 <gaussdb_04_0012__request_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.
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 DB 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 DB 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 DB instances created, this parameter value must be greater than the used memory size.)

Response Parameters

Status code: 201

**Table 5** Response body parameters
Parameter	Type	Description
quota_list	Array of `setQuota <gaussdb_04_0012__response_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.

Example Request

POST 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: 201

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 <gaussdb_10_0002>.

Error Code

For details, see Error Codes <gaussdb_10_0003>.

7.8 KiB Raw Blame History