文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 配额管理/ 查询配额信息 - ShowResourceQuotas
更新时间：2025-10-31 GMT+08:00
查看PDF
分享

查询配额信息 - ShowResourceQuotas

功能介绍

查询配额信息

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/billing/quotas

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

version

否

String

参数解释：

主机开通的版本

约束限制:

不涉及

取值范围：

包含如下7种输入。

  • hss.version.null ：无。

  • hss.version.basic ：基础版。

  • hss.version.advanced ：专业版。

  • hss.version.enterprise ：企业版。

  • hss.version.premium ：旗舰版。

  • hss.version.wtp ：网页防篡改版。

  • hss.version.container.enterprise：容器版。

默认取值:

不涉及

charging_mode

否

String

参数解释：

收费模式

约束限制:

不涉及

取值范围:

  • packet_cycle ：包年/包月。

  • on_demand ：按需。

默认取值:

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

data_list

Array of ResourceQuotasInfo objects

参数解释：

配额统计列表

取值范围：

不涉及
表5 ResourceQuotasInfo

参数

参数类型

描述

version

String

参数解释：

主机开通的版本

取值范围：

包含如下7种输入。

  • hss.version.null ：无。

  • hss.version.basic ：基础版。

  • hss.version.advanced ：专业版。

  • hss.version.enterprise ：企业版。

  • hss.version.premium ：旗舰版。

  • hss.version.wtp ：网页防篡改版。

  • hss.version.container.enterprise：容器版。

total_num

Integer

参数解释：

总配额数

取值范围：

0-2000000

used_num

Integer

参数解释：

已使用配额数

取值范围：

0-2000000

available_num

Integer

参数解释：

可用总配额数

取值范围：

0-2000000

available_resources_list

Array of AvailableResourceIdsInfo objects

参数解释：

可用资源列表

取值范围：

不涉及
表6 AvailableResourceIdsInfo

参数

参数类型

描述

resource_id

String

参数解释：

资源ID

取值范围：

字符长度1-256位

current_time

String

参数解释：

当前时间

取值范围：

字符长度1-64位

shared_quota

String

参数解释：

是否共享配额

取值范围：

  • shared：共享的

  • unshared：非共享的

请求示例

查询所有企业项目下的基础版配额信息

GET https://{endpoint}/v5/{project_id}/billing/quotas?version=hss.version.basic&enterprise_project_id=all_granted_eps

响应示例

状态码：200

请求已成功

{
  "data_list" : [ {
    "available_num" : 1,
    "available_resources_list" : [ {
      "current_time" : "2022-09-17T17:00:24Z",
      "resource_id" : "9ecb83a7-8b03-4e37-a26d-c3e90ca97eea",
      "shared_quota" : "shared"
    } ],
    "total_num" : 2,
    "used_num" : 1,
    "version" : "hss.version.basic"
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： 配额管理

相关文档