gaussdb-mysql/api-ref/source/api/managing_quotas/configuring_resource_quotas.rst

original_name

rds_06_0002.html

Configuring Resource Quotas

Function

This API is used to set resource quotas for a specified enterprise project.

• Learn how to authorize and authenticate <rds_03_0001> this API before using it.
• Before calling this API, obtain the required region and endpoint <gaussdb_00_0003>.

URI

• URI format

  POST https://{Endpoint}/mysql/v3/{project_id}/quotas

• Example

  POST https://{Endpoint}/mysql/v3/0483b6b16e954cb88930a360d2c4e663/quotas

• 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 <rds_03_0002>.
  quota_list	Yes	Quota details. A maximum of 10 quota records can be configured at a time. For details, see Table 2 <rds_06_0002__table1453814912427>.

Request

• Parameter description

  Table 2 quota_list field data structure description

  Name	Type	Description
  enterprise_project_id	String	Enterprise project ID.
  instance_quota	Integer	DB instance quantity quota. The value ranges from 0 to 1000. (If there are already DB instances created, this parameter value must be greater than the number of existing DB instances.)
  vcpus_quota	Integer	vCPUs quota. The value ranges from 0 to 3600000. (If there are already DB instances created, this parameter value must be greater than the number of used vCPUs.)
  ram_quota	Integer	Memory quota in GB. The value ranges from 0 to 19200000. (If there are already DB instances created, this parameter value must be greater than the used memory size.)

• Request example

  {
    "quota_list": [
      {
        "enterprise_project_id": "0",
        "instance_quota": 1,
        "vcpus_quota": 4,
        "ram_quota": 8
      }
    ]
  }

Response

• Parameter description

  Table 3 Parameter description

  Name	Type	Description
  quota_list	Array of objects	Configured quota information. For details, see Table 4 <rds_06_0002__table66531170>.

  Table 4 quota_list data structure description

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

• Example response

  {
    "quota_list": [
      {
        "enterprise_project_id": "0",
        "instance_quota": 1,
        "vcpus_quota": 4,
        "ram_quota": 8
      }
    ]
  }

Status Code

For details, see Status Codes <rds_10_0200>.

Error Code

For details, see Error Codes <rds_10_0201>.