文档首页/ 云数据库 GeminiDB/ API参考/ API v3(推荐)/ 企业项目管理/ 查询企业项目配额 - QueryingEnterpriseProjectQuotas
更新时间:2026-05-28 GMT+08:00
分享

查询企业项目配额 - QueryingEnterpriseProjectQuotas

功能介绍

查询企业项目配额。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    gaussdbfornosql::listEpsQuota

    List

    -

    -

    nosql:quota:list

    -

URI

GET /v3/{project_id}/enterprise-projects/quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户在某一region下的project ID。获取方法请参见获取项目ID

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_name

String

参数解释:

企业项目名称。

约束限制:

支持模糊搜索,若不指定则返回所有企业项目配额。

取值范围:

不涉及。

默认取值:

不涉及。

offset

Integer

参数解释:

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

约束限制:

大于或等于0的数字。

取值范围:

不涉及。

默认取值:

默认为0。

limit

Integer

参数解释:

查询个数上限值。

约束限制:

大于或等于1的数字。

取值范围:

1~100。

默认取值:

100。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

total_count

Integer

参数解释:

总记录数。

取值范围:

不涉及。

quotas

Array of NoSqlQueryEpsQuotaInfo objects

参数解释:

需要修改的配额信息。

取值范围:

不涉及。

表5 NoSqlQueryEpsQuotaInfo

参数

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID。

取值范围:

不涉及。

enterprise_project_name

String

参数解释:

企业项目名称。

取值范围:

不涉及。

quota

NoSqlEpsQuotaTotal object

参数解释:

企业项目配额。

取值范围:

不涉及。

used

NoSqlEpsQuotaUsed object

参数解释:

企业项目已使用配额。

取值范围:

不涉及。

表6 NoSqlEpsQuotaTotal

参数

参数类型

描述

instance

Integer

参数解释:

实例配额。

取值范围:

不涉及。

vcpus

Integer

参数解释:

vcpus配额。

取值范围:

不涉及。

ram

Integer

参数解释:

ram配额。

取值范围:

不涉及。

表7 NoSqlEpsQuotaUsed

参数

参数类型

描述

instance

Integer

参数解释:

已使用实例配额。

取值范围:

不涉及。

vcpus

Integer

参数解释:

已使用vcpus配额。

取值范围:

不涉及。

ram

Integer

参数解释:

已使用ram配额。

取值范围:

不涉及。

请求示例

URI样例
GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/enterprise-projects/quotas?enterprise_project_name=test&offset=1&limit=10

响应示例

状态码: 200

Success.

{ 
  "quotas" : [ { 
    "enterprise_project_id" : "c0348bb1-d09d-4ee2-8edd-53e496fe6b52", 
    "enterprise_project_name" : "test1", 
    "quota" : { 
      "instance" : 500, 
      "vcpus" : 1000, 
      "ram" : 2000 
    }, 
    "used" : { 
      "instance" : 15, 
      "vcpus" : 88, 
      "ram" : 256 
    } 
  }, { 
    "enterprise_project_id" : "780a6b1f-58b8-4df6-a85e-326d052de704", 
    "enterprise_project_name" : "test2", 
    "quota" : { 
      "instance" : 500, 
      "vcpus" : 1000, 
      "ram" : 2000 
    }, 
    "used" : { 
      "instance" : 36, 
      "vcpus" : 64, 
      "ram" : 192 
    } 
  } ], 
  "total_count" : 2 
}

状态码

请参见状态码

错误码

请参见错误码

相关文档