# 查询配额 - QueryingQuota #### 功能介绍 查询单租户在GeminiDB服务下的资源配额。 #### 调试 您可以在[API Explorer](https://apiexplorer.developer.huaweicloud.com/apiexplorer/doc?product=GaussDBforNoSQL&api=ShowQuotas)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-nosql/nosql_05_0023.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | gaussdbfornosql::listResourceQuota | Read | - | - | nosql:instance:list | - | #### URI GET /v3/{project_id}/quotas 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 租户在某一region下的project ID。获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-nosql/nosql_projectid.html)。 **约束限制：** 不涉及。 **取值范围：** 长度为32个字符，仅由英文字母和数字组成。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | datastore_type | 否 | String | **参数解释：** 数据库类型。 **约束限制：** 传入该参数时mode参数才生效。 **取值范围：** - 取值为"cassandra"，表示查询GeminiDB Cassandra数据库实例配额。 - 取值为"mongodb"，表示查询GeminiDB Mongo数据库实例配额。 - 取值为"influxdb"，表示查询GeminiDB Influx数据库实例配额。 - 取值为"redis"，表示查询GeminiDB Redis数据库实例配额。 **默认取值：** 如果不传该参数，表示查询所有数据库实例配额。 | | mode | 否 | String | **参数解释：** 实例类型。 **约束限制：** 不涉及。 **取值范围：** - 取值为"Cluster"，表示GeminiDB Redis Proxy集群，GeminiDB Cassandra、GeminiDB Influx经典部署模式集群实例类型。 - 取值为"CloudNativeCluster"，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。 - 取值为"RedisCluster"，表示GeminiDB Redis Cluster经典部署模式集群实例类型。 - 取值为"Replication"，表示GeminiDB Redis经典部署模式主备实例类型。 - 取值为"InfluxdbSingle"，表示GeminiDB Influx经典部署模式单节点实例类型。 - 取值为"EnhancedCluster"，表示GeminiDB Influx经典部署模式集群增强版类型。 - 取值为"ReplicaSet"，表示GeminiDB Mongo副本集实例类型。 **默认取值：** 如果不传datastore_type参数，自动忽略该参数设置，传入datastore_type时，该参数必填。 | | product_type | 否 | String | **参数解释：** 产品类型。 **约束限制：** 当查询GeminiDB Redis云原生部署模式集群类型配额必传此参数。 **取值范围：** - Capacity：容量型。 - Performance：性能型。 **默认取值：** 不涉及。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | quotas | [ShowResourcesListResponseBody] object | **参数解释：** 配额信息。 | 表5ShowResourcesListResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resources | Array of [ShowResourcesDetailResponseBody] objects | **参数解释：** 资源列表对象。 | 表6ShowResourcesDetailResponseBody | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | **参数解释：** 配额资源类型。当前配额类型仅支持实例类型（instance）。 **取值范围：** 不涉及。 | | quota | Integer | **参数解释：** 当前配额值。 取值为0时，表示不限制当前配额值。 **取值范围：** 不涉及。 | | used | Integer | **参数解释：** 已使用的资源数。 **取值范围：** 不涉及。 | #### 请求示例 URI样例 ``` GET https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/quotas?mode=InfluxdbSingle&datastore_type=influxdb ``` #### 响应示例 **状态码： 200** Success ``` { "quotas" : { "resources" : [ { "type" : "instance", "quota" : 200, "used" : 58 } ] } } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-nosql/nosql_status_code.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-nosql/nosql_error_code.html)。