文档首页/ 云数据库 TaurusDB/ API参考/ API（推荐）/ 配额管理/ 查询租户基于企业项目的资源配额- ShowGaussMySqlQuotas
更新时间：2025-10-21 GMT+08:00
在线调试
CLI示例
查看PDF
分享

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

功能介绍

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

接口约束

该接口目前公测阶段，如需使用，请提交工单联系客服人员申请权限。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:quota:list

    Read

    -

    -

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

获取方法请参见获取项目ID。

约束限制：

不涉及。

取值范围：

只能由英文字母、数字组成，且长度为32个字符。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

String

参数解释：

索引位置，偏移量。从第一条数据偏移offset条数据后开始查询。

约束限制：

必须为整数，不能为负数。

取值范围：

≥0。

默认取值：

0。

limit

否

String

参数解释：

查询记录数。

约束限制：

必须为整数，不能为负数。

取值范围：

1-100。

默认取值：

100。

enterprise_project_name

否

String

参数解释：

企业项目名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

X-Language

否

String

参数解释：

请求语言类型。

约束限制：

不涉及。

取值范围：

  • en-us

  • zh-cn

默认取值：

en-us。

响应参数

状态码： 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

参数解释：

实例个数配额，-1表示无限制。

取值范围：

不涉及。

vcpus_quota

Integer

参数解释：

CPU核数配额，-1表示无限制。

取值范围：

不涉及。

ram_quota

Integer

参数解释：

内存使用配额，单位为GB，-1表示无限制。

取值范围：

不涉及。

availability_instance_quota

Integer

参数解释：

实例剩余配额，-1表示无限制。

取值范围：

不涉及。

availability_vcpus_quota

Integer

参数解释：

CPU核数剩余配额，-1表示无限制。

取值范围：

不涉及。

availability_ram_quota

Integer

参数解释：

内存剩余配额，-1表示无限制。

取值范围：

不涉及。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

获取资源配额。

GET https://{endpoint}/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
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 配额管理