Help Center/ Host Security Service/ API Reference/ API Description/ Quota Management/ Querying Quota Details
Updated on 2025-09-22 GMT+08:00
View PDF

Querying Quota Details

Function

This API is used to query quota details.

URI

GET /v5/{project_id}/billing/quotas-detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.

version

No

String

HSS edition. Its value can be:

  • hss.version.null

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container.enterprise: container edition

category

No

String

Type. Its value can be:

  • host_resource

  • container_resource

quota_status

No

String

Quota status. It can be:

  • QUOTA_STATUS_NORMAL

    • QUOTA_STATUS_EXPIRED

    • QUOTA_STATUS_FREEZE

used_status

No

String

Usage status. It can be:

  • USED_STATUS_IDLE

  • USED_STATUS_USED

host_name

No

String

Server name

resource_id

No

String

Specifies the resource ID of the HSS quota.

charging_mode

No

String

on_demand: pay-per-use

limit

No

Integer

Number of items per page

offset

No

Integer

Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

IAM token.

It can be obtained by calling the IAM API used to obtain an IAM token. The value of X-Subject-Token in the response header is a token.

region

No

String

Region ID

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

on_demand_num

Integer

Pay-per-Use quotas

used_num

Integer

Used quotas

idle_num

Integer

Idle quotas

normal_num

Integer

Normal quotas

expired_num

Integer

Expired quotas

freeze_num

Integer

Frozen quotas

quota_statistics_list

Array of QuotaStatisticsResponseInfo objects

Quota statistics list

total_num

Integer

Total quotas

data_list

Array of QuotaResourcesResponseInfo objects

Quota list
Table 5 QuotaStatisticsResponseInfo

Parameter

Type

Description

version

String

Resource flavor. Its value can be:

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container: container edition

total_num

Integer

Total quotas
Table 6 QuotaResourcesResponseInfo

Parameter

Type

Description

resource_id

String

Resource ID of an HSS quota

version

String

Resource flavor. Its value can be:

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container: container edition

quota_status

String

Quota status. It can be:

  • normal

    • expired

    • freeze

used_status

String

Usage status. Its value can be:

  • idle

  • used

host_id

String

Host ID

host_name

String

Server name

charging_mode

String

on_demand: pay-per-use

tags

Array of TagInfo objects

Tag

expire_time

Long

Expiration time. The value -1 indicates that the resource will not expire.

shared_quota

String

Whether quotas are shared. Its value can be:

  • shared

  • unshared

enterprise_project_id

String

Enterprise project ID

enterprise_project_name

String

Enterprise project name
Table 7 TagInfo

Parameter

Type

Description

key

String

Key. It can contain up to 128 Unicode characters. The key cannot be left blank.

value

String

Value. Each tag value can contain a maximum of 255 Unicode characters.

Example Requests

This API is used to query quotas details in all enterprise projects.

GET https://{endpoint}/v5/{project_id}/billing/quotas-detail?offset=0&limit=100&version=hss.version.enterprise&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

quota details

{
  "data_list" : [ {
    "charging_mode" : "on_demand",
    "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" : "Service",
      "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,
  "quota_statistics_list" : [ {
    "total_num" : 8,
    "version" : "hss.version.enterprise"
  } ],
  "total_num" : 60,
  "used_num" : 40
}

Status Codes

Status Code

Description

200

quota details

Error Codes

See Error Codes.

Parent Topic: Quota Management