Querying the DB Instance Quotas of a Tenant

Function

This API is used to obtain the resource quotas of a specified tenant. Before using this API:

• Learn how to authorize and authenticate it.

• Obtain the required region and endpoint.

URI

GET /v3/{project_id}/project-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.

Table 2 Query parameters

Parameter	Mandatory	Type	Description
type	No	String	Resource type used to filter quotas. Its value can be instance. Valid value: instance

Request Parameters

Table 3 Request header parameters

Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token.
X-Language	No	String	Language.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter	Type	Description
quotas	project-quotas object	Tenant instance quota information.

Table 5 project-quotas

Parameter	Type	Description
resources	Array of resource objects	Resource list objects.

Table 6 resource

Parameter	Type	Description
type	String	Quota of a specified type. instance: indicates the DB instance quota. Valid value: instance
used	Integer	Number of created resources.
quota	Integer	Maximum resource quota.

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

GET https://gaussdb-mysql.eu-de.otc.t-systems.com/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance

Example Response

Status code: 200

Success.

{
  "quotas" : {
    "resources" : [ {
      "type" : "instance,",
      "used" : "4,",
      "quota" : 50
    } ]
  }
}

Status Code

For details, see Status Codes.

Error Code

For details, see Error Codes.

last updated: 2024-11-13 14:30 UTC - commit: 805f4aa7e58669fc866d3eb0c4241508900e849d