查询配额详情 - ListQuotasDetail
功能介绍
查询配额详情
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/billing/quotas-detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
version |
否 |
String |
参数解释: 主机开通的版本 约束限制: 不涉及 取值范围: 包含如下7种输入。
默认取值: 不涉及 |
|
category |
否 |
String |
参数解释: 类别 约束限制: 不涉及 取值范围: 包含如下两种:
默认取值: 不涉及 |
|
quota_status |
否 |
String |
参数解释: 配额状态 约束限制: 不涉及 取值范围: 包含如下三种:
默认取值: 不涉及 |
|
used_status |
否 |
String |
参数解释: 使用状态 约束限制: 不涉及 取值范围: 包含如下两种:
默认取值: 不涉及 |
|
host_name |
否 |
String |
参数解释: 服务器名称 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
resource_id |
否 |
String |
参数解释 : HSS配额的资源ID 约束限制 : 不涉及 取值范围 : 字符长度1-128位 默认取值 : 不涉及 |
|
charging_mode |
否 |
String |
参数解释: 收费模式 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
offset |
否 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 默认为0 |
请求参数
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
packet_cycle_num |
Integer |
参数解释: 包周期配额数 取值范围: 0到10000000 |
|
on_demand_num |
Integer |
参数解释: 按需配额数 取值范围: 0到10000000 |
|
used_num |
Integer |
参数解释: 已使用配额数 取值范围: 0到10000000 |
|
idle_num |
Integer |
参数解释: 空闲配额数 取值范围: 0到10000000 |
|
normal_num |
Integer |
参数解释: 正常配额数 取值范围: 0到10000000 |
|
expired_num |
Integer |
参数解释: 过期配额数 取值范围: 0到10000000 |
|
create_time |
Long |
参数解释: 创建时间 取值范围: 0到9223372036854775807 |
|
freeze_num |
Integer |
参数解释: 冻结配额数 取值范围: 0到10000000 |
|
quota_statistics_list |
Array of QuotaStatisticsResponseInfo objects |
参数解释: 配额统计列表 取值范围: 不涉及 |
|
total_num |
Integer |
参数解释: 配额总数 取值范围: 0到10000000 |
|
data_list |
Array of QuotaResourcesResponseInfo objects |
参数解释: 配额列表 取值范围: 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
version |
String |
参数解释: 资源规格编码 取值范围: 包含如下6种。
|
|
total_num |
Integer |
参数解释: 配额总数 取值范围: 0到10000000 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resource_id |
String |
参数解释 : HSS配额的资源ID 取值范围 : 字符长度1-128位 |
|
version |
String |
参数解释: 资源规格编码 取值范围: 包含如下6种。
|
|
quota_status |
String |
参数解释: 配额状态 取值范围: 包含如下3种。
|
|
used_status |
String |
参数解释: 使用状态 取值范围: 包含如下2种。
|
|
host_id |
String |
参数解释: 服务器ID 取值范围: 字符长度1-64位 |
|
host_name |
String |
参数解释: 服务器名称 取值范围: 字符长度1-128位 |
|
charging_mode |
String |
参数解释: 计费模式 取值范围:
|
|
tags |
Array of TagInfo objects |
参数解释: 标签 取值范围: 不涉及 |
|
expire_time |
Long |
参数解释: 过期时间 取值范围: -1到9223372036854775807,-1表示没有到期时间 |
|
create_time |
Long |
参数解释: 创建时间 取值范围: 0到9223372036854775807 |
|
shared_quota |
String |
参数解释: 是否共享配额 取值范围:
|
|
enterprise_project_id |
String |
参数解释: 主机所属的企业项目ID。 企业项目ID默认取值为“0”,表示默认企业项目。如果需要查询所有企业项目下的主机,请传参“all_granted_eps”。如果您只有某个企业项目的权限,则需要传递该企业项目ID,查询该企业项目下的主机,否则会因权限不足而报错。 取值范围: 字符长度1-256位 |
|
enterprise_project_name |
String |
参数解释: 所属企业项目名称 取值范围: 字符长度1-256位 |
请求示例
查询所有企业项目下的配额详情
GET https://{endpoint}/v5/{project_id}/billing/quotas-detail?offset=0&limit=100&version=hss.version.basic&enterprise_project_id=all_granted_eps
响应示例
状态码:200
请求已成功
{
"data_list" : [ {
"charging_mode" : "packet_cycle",
"expire_time" : -1,
"host_id" : "71a15ecc-049f-4cca-bd28-5e90aca1817f",
"host_name" : "zhangxiaodong2",
"quota_status" : "normal",
"resource_id" : "af4d08ad-2b60-4916-a5cf-8d6a23956dda",
"shared_quota" : "shared",
"tags" : [ {
"key" : "服务",
"value" : "HSS"
} ],
"used_status" : "used",
"version" : "hss.version.wtp"
} ],
"expired_num" : 0,
"freeze_num" : 0,
"idle_num" : 20,
"normal_num" : 60,
"on_demand_num" : 0,
"packet_cycle_num" : 60,
"quota_statistics_list" : [ {
"total_num" : 8,
"version" : "hss.version.basic"
} ],
"total_num" : 60,
"used_num" : 40
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。