查询企业项目配额 - QueryingEnterpriseProjectQuotas

功能介绍

查询企业项目配额。

调试

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

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql::listEpsQuota
List
-
-
nosql:quota:list
-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
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。取值必须为数字，且不能为负数。
limit	否	Integer	查询个数上限值。取值范围：1~100。不传该参数时，默认查询前100条信息。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
total_count	Integer	总记录数。
quotas	objects	企业项目配额信息列表。详情请参考表5。

表5 NoSqlQueryEpsQuotaInfo
参数	参数类型	描述
enterprise_project_id	String	企业项目ID。
enterprise_project_name	String	企业项目名称。
quota	object	企业项目配额。详情请参考表6。
used	object	企业项目已使用配额。详情请参考表7。

表6 NoSqlEpsQuotaTotal
参数	参数类型	描述
instance	Integer	实例配额。
vcpus	Integer	vcpus配额。
ram	Integer	ram配额。

表7 NoSqlEpsQuotaUsed
参数	参数类型	描述
instance	Integer	已使用实例配额。
vcpus	Integer	已使用vcpus配额。
ram	Integer	已使用ram配额。

请求示例

URI样例

GET https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/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 
}