Help Center/ GaussDB/ API Reference/ APIs (Recommended)/ Instance Management/ Querying the Instance Quotas of a Tenant
Updated on 2024-08-20 GMT+08:00
View PDF
Share

Querying the Instance Quotas of a Tenant

Function

This API is used to query the instance quotas of a tenant. Before calling this API:

URI

GET https://{Endpoint}/v3/{project_id}/project-quotas

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Explanation:

Project ID of a tenant in a region.

For details about how to obtain the project ID, see Obtaining a Project ID.

Restrictions:

None

Value range:

The value can contain 32 characters. Only letters and digits are allowed.

Default value:

None

Request Parameters

None

Response Parameters

Table 2 Parameter description

Parameter

Type

Description

quotas

object

Explanation:

Instance quota of a tenant.

For details, see Table 3.
Table 3 quotas

Parameter

Type

Description

resources

Array of objects

Explanation:

Resource objects.

For details, see Table 4.
Table 4 resources

Parameter

Type

Description

type

String

Explanation:

Quota of a specified type.

Value range:

instance: indicates the instance quota.

used

Integer

Explanation:

Number of created resources.

Value range:

None

quota

Integer

Explanation:

Maximum resource quota.

Value range:

None

Example Request

Querying the instance quotas of a tenant

GET https://gaussdb-opengauss.ap-southeast-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/project-quotas

Example Response

Instance quotas of the tenant queried. 
{ 
  "quotas" : { 
    "resources" : [ { 
      "type" : "instance", 
      "used" : 4, 
      "quota" : 50 
    } ] 
  } 
}

Status Code

Error Code

For details, see Error Codes.

Parent topic: Instance Management