Querying Quota Details

Updated on 2024-01-31 GMT+08:00

View PDF

Function

This API is used to query quota details.

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	User project ID Minimum: 1 Maximum: 256

**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. Default: 0 Minimum: 1 Maximum: 256
version	No	String	HSS edition. Its value can be: hss.version.null 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 Minimum: 1 Maximum: 64
category	No	String	Type. Its value can be: host_resource container_resource Minimum: 1 Maximum: 64
quota_status	No	String	Quota status. It can be: QUOTA_STATUS_NORMAL QUOTA_STATUS_EXPIRED QUOTA_STATUS_FREEZE Minimum: 1 Maximum: 64
used_status	No	String	Usage status. It can be: USED_STATUS_IDLE USED_STATUS_USED Minimum: 1 Maximum: 64
host_name	No	String	Server name Minimum: 0 Maximum: 128
resource_id	No	String	Resource ID Minimum: 0 Maximum: 128
charging_mode	No	String	Billing mode. Its value can be: packet_cycle: yearly/monthly on_demand: pay-per-use Minimum: 1 Maximum: 32
limit	No	Integer	Number of items per page Minimum: 10 Maximum: 200 Default: 10
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. The default value is 0. Minimum: 0 Maximum: 2000000 Default: 0

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. Minimum: 32 Maximum: 4096
region	No	String	region id Minimum: 0 Maximum: 128

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
packet_cycle_num	Integer	Yearly/Monthly quotas Minimum: 0 Maximum: 10000000
on_demand_num	Integer	Pay-per-Use quotas Minimum: 0 Maximum: 10000000
used_num	Integer	Used quotas Minimum: 0 Maximum: 10000000
idle_num	Integer	Idle quotas Minimum: 0 Maximum: 10000000
normal_num	Integer	Normal quotas Minimum: 0 Maximum: 10000000
expired_num	Integer	Expired quotas Minimum: 0 Maximum: 10000000
freeze_num	Integer	Frozen quotas Minimum: 0 Maximum: 10000000
quota_statistics_list	Array of QuotaStatisticsResponseInfo objects	Quota statistics list Array Length: 0 - 200
total_num	Integer	Total number Minimum: 0 Maximum: 10000000
data_list	Array of QuotaResourcesResponseInfo objects	Quota list Array Length: 0 - 200

**Table 5** QuotaStatisticsResponseInfo
Parameter	Type	Description
version	String	Resource flavor. Its value can be: 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: container edition Minimum: 1 Maximum: 64
total_num	Integer	Total number Minimum: 0 Maximum: 10000000

**Table 6** QuotaResourcesResponseInfo
Parameter	Type	Description
resource_id	String	Resource ID of an HSS quota Minimum: 0 Maximum: 256
version	String	Resource flavor. Its value can be: 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: container edition Minimum: 1 Maximum: 64
quota_status	String	Quota status. It can be: normal expired freeze Minimum: 1 Maximum: 64
used_status	String	Usage status. Its value can be: idle used Minimum: 1 Maximum: 64
host_id	String	Server ID Minimum: 1 Maximum: 64
host_name	String	Server name Minimum: 1 Maximum: 128
charging_mode	String	Billing mode. Its value can be: packet_cycle: yearly/monthly on_demand: pay-per-use Minimum: 1 Maximum: 64
tags	Array of TagInfo objects	Tag Array Length: 0 - 2097152
expire_time	Long	Expiration time. The value -1 indicates that the resource will not expire. Minimum: 0 Maximum: 2147483647
shared_quota	String	Whether quotas are shared. Its value can be: shared unshared Minimum: 1 Maximum: 64
enterprise_project_id	String	Enterprise project ID Minimum: 0 Maximum: 256
enterprise_project_name	String	Enterprise project name Minimum: 0 Maximum: 256

**Table 7** TagInfo
Parameter	Type	Description
key	String	Key. It can contain up to 128 Unicode characters. The key cannot be left blank. Minimum: 1 Maximum: 128
value	String	Value. Each tag value can contain a maximum of 255 Unicode characters. Minimum: 1 Maximum: 255

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

Quota details

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