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

查询租户的实例配额 - ShowGaussMySqlProjectQuotas

功能介绍

获取指定租户的资源配额。

调用方法

请参见如何调用API。

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    gaussdbformysql:quota:list

    Read

    -

    -

    gaussdb:instance:list

    -

URI

GET /v3/{project_id}/project-quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

租户在某一Region下的project ID。

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

约束限制：

不涉及。

取值范围：

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

默认值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

参数解释：

根据type过滤查询指定类型的配额。

约束限制:

不涉及。

取值范围：

instance：实例类型。

默认值：

instance。

请求参数

表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参数

参数

参数类型

描述

quotas

project-quotas object

参数解释：

租户实例配额信息。
表5 project-quotas

参数

参数类型

描述

resources

Array of resource objects

参数解释：

资源列表对象。
表6 resource

参数

参数类型

描述

type

String

参数解释：

指定类型的配额。

取值范围：

instance：实例类型。

used

Integer

参数解释：

已创建的资源个数。

取值范围：

≥0。

quota

Integer

参数解释：

资源最大的配额数。

取值范围：

实例个数配额，取值范围0~100000，-1表示无限制。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误消息。

请求示例

查询租户的实例配额。

GET https://{endpoint}/v3/054e292c9880d4992f02c0196d3ea468/project-quotas?type=instance

响应示例

状态码： 200

Success.

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

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 配额管理