doc-exports/docs/gaussdb_mysql/api-ref/gaussdb_11_0031.html
Hasko, Vladimir c1056e5100 Recreating PR
Reviewed-by: Drobnak, David <david.drobnak@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-07-11 13:57:29 +00:00

22 KiB

Modifying Enterprise Project Resource Quotas of a Tenant

Function

This API is used to modify the resource quotas of a specified enterprise project. Before calling this API:

URI

  • Parameter description
    Table 1 Parameter description

    Name

    Mandatory

    Description

    project_id

    Yes

    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.

Content-Type

Yes

String

MIME type of the request body. You are advised to use the default value application/json. For APIs used to upload objects or images, the value can vary depending on the flow type.

Table 3 Request body parameter

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.

instance_quota

Yes

Integer

Quota of the DB instance quantity. Value: 0 to 1000. (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 3600000. (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 19200000. (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

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

POST https://gaussdb-mysql.eu-de.otc.t-systems.com/mysql/v3/0483b6b16e954cb88930a360d2c4e663/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.