doc-exports/docs/gaussdb_mysql/api-ref/gaussdb_04_0013.html
Wang , Deng Ke a8436b1d56 gaussdb API Initial version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com>
Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
2022-11-24 13:34:54 +00:00

14 KiB

Modifying Resource Quotas

Function

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

URI

  • URI format

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

  • Example

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

    quota_list

    Yes

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

    For details, see Table 2.

Request

  • Parameter description
    Table 2 quota_list field data structure description

    Name

    Type

    Description

    enterprise_project_id

    String

    Enterprise project ID.

    instance_quota

    Integer

    Quota of the DB instance quantity. The value ranges from 0 to 1000. (If there are already DB instances created, this parameter value must be greater than or equal to the number of existing DB instances.)

    vcpus_quota

    Integer

    Quota of vCPUs. The value ranges from 0 to 3600000. (If there are already DB instances created, this parameter value must be greater than or equal to the number of used vCPUs.)

    ram_quota

    Integer

    Memory quota in GB.

    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 or equal to 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.

    Table 4 quota_list field 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.

Error Code

For details, see Error Codes.