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

Querying Quota Information

Function

This API is used to query quota information.

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

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

charging_mode

No

String

Definition

Billing mode.

Constraints

N/A

Range

  • packet_cycle: yearly/monthly

  • on_demand: pay-per-use

Default Value

N/A

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

data_list

Array of ResourceQuotasInfo objects

Definition

Quota statistics list.

Range

N/A

Table 5 ResourceQuotasInfo

Parameter

Type

Description

version

String

Definition

Enabled HSS edition.

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

total_num

Integer

Definition

Total quotas.

Range

0-2000000

used_num

Integer

Definition

Used quotas.

Range

0-2000000

available_num

Integer

Definition

Total available quotas.

Range

0-2000000

available_resources_list

Array of AvailableResourceIdsInfo objects

Definition

Available resource list.

Range

N/A

Table 6 AvailableResourceIdsInfo

Parameter

Type

Description

resource_id

String

Definition

Resource ID.

Range

The value can contain 1 to 256 characters.

current_time

String

Definition

Current time.

Range

The value can contain 1 to 64 characters.

shared_quota

String

Definition

Whether quotas are shared.

Range

  • shared

  • unshared

Example Requests

This API is used to query quotas of the basic edition in all enterprise projects.

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

Example Responses

Status code: 200

Request succeeded.

{
  "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"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Quota Management