Help Center/ Host Security Service/ API Reference/ API Description/ Quota Management/ Querying Quota Details
Updated on 2026-04-03 GMT+08:00
View PDF
Share

Querying Quota Details

Function

This API is used to query quota details.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

version

No

String

Definition

Enabled HSS edition.

Constraints

N/A

Range

The options are as follows:

  • hss.version.null: none

  • hss.version.basic: basic edition

  • hss.version.advanced: professional edition

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container.enterprise: container edition

Default Value

N/A

category

No

String

Definition

Type.

Constraints

N/A

Range

The options are as follows:

  • host_resource: server

  • container_resource: container

Default Value

N/A

quota_status

No

String

Definition

Quota status.

Constraints

N/A

Range

The options are as follows:

  • normal

  • expired

  • freeze

Default Value

N/A

used_status

No

String

Definition

Usage status.

Constraints

N/A

Range

The options are as follows:

  • idle

  • used

Default Value

N/A

host_name

No

String

Definition

Server name.

Constraints

N/A

Range

The value contains 1 to 256 characters.

Default Value

N/A

resource_id

No

String

Definition

Resource ID of an HSS quota.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

charging_mode

No

String

Definition

Billing mode.

Constraints

N/A

Range

  • packet_cycle: yearly/monthly

  • on_demand: pay-per-use

Default Value

N/A

limit

No

Integer

Definition

Number of records displayed on each page.

Constraints

N/A

Range

Value range: 10-200

Default Value

10

offset

No

Integer

Definition

Offset, which specifies the start position of the record to be returned.

Constraints

N/A

Range

The value range is 0 to 2,000,000.

Default Value

The default value is 0.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

region

No

String

Definition

Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID.

Constraints

N/A

Range

The value can contain 1 to 128 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

packet_cycle_num

Integer

Definition

Yearly/Monthly quotas.

Range

0 to 10,000,000

on_demand_num

Integer

Definition

Pay-per-use quotas.

Range

0 to 10,000,000

used_num

Integer

Definition

Used quotas.

Range

0 to 10,000,000

idle_num

Integer

Definition

Idle quotas.

Range

0 to 10,000,000

normal_num

Integer

Definition

Normal quotas.

Range

0 to 10,000,000

expired_num

Integer

Definition

Expired quotas.

Range

0 to 10,000,000

create_time

Long

Definition

Creation time.

Range

0 to 9,223,372,036,854,775,807

freeze_num

Integer

Definition

Frozen quotas.

Range

0 to 10,000,000

quota_statistics_list

Array of QuotaStatisticsResponseInfo objects

Definition

Quota statistics list.

Range

N/A

total_num

Integer

Definition

Total quotas.

Range

0 to 10,000,000

data_list

Array of QuotaResourcesResponseInfo objects

Definition

Quota list.

Range

N/A
Table 5 QuotaStatisticsResponseInfo

Parameter

Type

Description

version

String

Definition

Resource specification code.

Range

The options are as follows:

  • hss.version.basic: basic edition

  • hss.version.advanced: professional edition

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container.enterprise: container edition

total_num

Integer

Definition

Total quotas.

Range

0 to 10,000,000
Table 6 QuotaResourcesResponseInfo

Parameter

Type

Description

resource_id

String

Definition

Resource ID of an HSS quota.

Range

The value can contain 1 to 128 characters.

version

String

Definition

Resource specification code.

Range

The options are as follows:

  • hss.version.basic: basic edition

  • hss.version.advanced: professional edition

  • hss.version.enterprise: enterprise edition

  • hss.version.premium: premium edition

  • hss.version.wtp: WTP edition

  • hss.version.container.enterprise: container edition

quota_status

String

Definition

Quota status.

Range

The options are as follows:

  • normal

  • expired

  • freeze

used_status

String

Definition

Usage status.

Range

The options are as follows:

  • idle

  • used

host_id

String

Definition

Server ID.

Range

The value can contain 1 to 64 characters.

host_name

String

Definition

Server name.

Range

The value can contain 1 to 128 characters.

charging_mode

String

Definition

Billing mode.

Range

  • packet_cycle: yearly/monthly

  • on_demand: pay-per-use

tags

Array of TagInfo objects

Definition

Tag.

Range

N/A

expire_time

Long

Definition

Expiration time.

Range

-1 to 9,223,372,036,854,775,807. -1 indicates that the expiration time is not specified.

create_time

Long

Definition

Creation time.

Range

0 to 9,223,372,036,854,775,807

shared_quota

String

Definition

Whether quotas are shared.

Range

  • shared

  • unshared

enterprise_project_id

String

Definition

ID of the enterprise project that the server belongs to.

The default value of an enterprise project ID is 0, indicating the default enterprise project. To query servers in all enterprise projects, set this parameter to all_granted_eps. If you only have the permissions for a specific enterprise project, to query a server in the project, specify the enterprise project ID. Otherwise, an error will be reported due to insufficient permission.

Range

The value can contain 1 to 256 characters.

enterprise_project_name

String

Definition

Enterprise project name.

Range

The value can contain 1 to 256 characters.
Table 7 TagInfo

Parameter

Type

Description

key

String

Definition

Key.

Range

Each tag key can contain a maximum of 128 Unicode characters. The key cannot be left blank.

value

String

Definition

Value.

Range

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.basic&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "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" : "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,
  "packet_cycle_num" : 60,
  "quota_statistics_list" : [ {
    "total_num" : 8,
    "version" : "hss.version.basic"
  } ],
  "total_num" : 60,
  "used_num" : 40
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Quota Management