文档首页/ 云数据库 GaussDB(for MySQL)/ API参考/ API（即将下线）/ 配额管理/ 查询租户基于企业项目的资源配额
更新时间：2024-06-07 GMT+08:00
查看PDF
分享

查询租户基于企业项目的资源配额

功能介绍

获取指定企业项目的资源配额。

该接口计划于2025-03-31下线，建议及时切换到新接口查询租户基于企业项目的资源配额。

调试

您可以在API Explorer中调试该接口。

URI

GET /mysql/v3/{project_id}/quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户在某一region下的project ID。

获取方法请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 取值范围：0 - 10000

limit

否

String

查询记录数。默认为10，不能为负数，最小值为1，最大值为100。

enterprise_project_name

否

String

企业项目名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取。

请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

Content-Type

是

String

内容类型。

取值：application/json。

X-Language

否

String

请求语言类型。默认en-us。 取值范围：

  • en-us
  • zh-cn

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

quota_list

Array of quota objects

资源列表对象。

total_count

Integer

配额记录的条数。
表5 quota

参数

参数类型

描述

enterprise_project_id

String

企业项目ID。

enterprise_project_name

String

企业项目名称。

instance_quota

Integer

实例个数配额。

vcpus_quota

Integer

CPU核数配额。

ram_quota

Integer

内存使用配额，单位为GB。

availability_instance_quota

Integer

实例剩余配额。

availability_vcpus_quota

Integer

CPU核数剩余配额。

availability_ram_quota

Integer

内存剩余配额。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

GET https://{endpoint}/mysql/v3/054e292c9880d4992f02c0196d3ea468/quotas

响应示例

状态码： 200

Success.

{
  "quota_list" : [ {
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default",
    "instance_quota" : 20,
    "vcpus_quota" : 20,
    "ram_quota" : 40,
    "availability_instance_quota" : 1,
    "availability_vcpus_quota" : 4,
    "availability_ram_quota" : 8
  } ]
}

状态码

状态码

描述

200

Success.

400

Client error.

500

Server error.

错误码

请参见错误码。

父主题： 配额管理

相关文档