Querying Quota Details
Function
This API is used to query quota details.
Calling Method
For details, see Calling APIs.
URI
GET /v5/{project_id}/billing/quotas-detail
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID Minimum: 1 Maximum: 256 |
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:
Minimum: 1 Maximum: 64 |
category |
No |
String |
Type. Its value can be:
Minimum: 1 Maximum: 64 |
quota_status |
No |
String |
Quota status. It can be:
Minimum: 1 Maximum: 64 |
used_status |
No |
String |
Usage status. It can be:
Minimum: 1 Maximum: 64 |
host_name |
No |
String |
Server name Minimum: 0 Maximum: 128 |
resource_id |
No |
String |
Specifies the resource ID of the HSS quota. Minimum: 0 Maximum: 128 |
charging_mode |
No |
String |
Billing mode. Its value can be:
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. Minimum: 0 Maximum: 2000000 Default: 0 |
Request 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
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 quotas Minimum: 0 Maximum: 10000000 |
data_list |
Array of QuotaResourcesResponseInfo objects |
Quota list Array Length: 0 - 200 |
Parameter |
Type |
Description |
---|---|---|
version |
String |
Resource flavor. Its value can be:
Minimum: 1 Maximum: 64 |
total_num |
Integer |
Total quotas Minimum: 0 Maximum: 10000000 |
Parameter |
Type |
Description |
---|---|---|
resource_id |
String |
Resource ID of an HSS quota Minimum: 0 Maximum: 256 |
version |
String |
Resource flavor. Its value can be:
Minimum: 1 Maximum: 64 |
quota_status |
String |
Quota status. It can be:
Minimum: 1 Maximum: 64 |
used_status |
String |
Usage status. Its value can be:
Minimum: 1 Maximum: 64 |
host_id |
String |
Host ID Minimum: 1 Maximum: 64 |
host_name |
String |
Server name Minimum: 1 Maximum: 128 |
charging_mode |
String |
Billing mode. Its value can be:
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:
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 |
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 }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.hss.v5.region.HssRegion; import com.huaweicloud.sdk.hss.v5.*; import com.huaweicloud.sdk.hss.v5.model.*; public class ListQuotasDetailSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); HssClient client = HssClient.newBuilder() .withCredential(auth) .withRegion(HssRegion.valueOf("<YOUR REGION>")) .build(); ListQuotasDetailRequest request = new ListQuotasDetailRequest(); request.withEnterpriseProjectId("<enterprise_project_id>"); request.withVersion("<version>"); request.withCategory("<category>"); request.withQuotaStatus("<quota_status>"); request.withUsedStatus("<used_status>"); request.withHostName("<host_name>"); request.withResourceId("<resource_id>"); request.withChargingMode("<charging_mode>"); request.withLimit(<limit>); request.withOffset(<offset>); try { ListQuotasDetailResponse response = client.listQuotasDetail(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkhss.v5.region.hss_region import HssRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkhss.v5 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = HssClient.new_builder() \ .with_credentials(credentials) \ .with_region(HssRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListQuotasDetailRequest() request.enterprise_project_id = "<enterprise_project_id>" request.version = "<version>" request.category = "<category>" request.quota_status = "<quota_status>" request.used_status = "<used_status>" request.host_name = "<host_name>" request.resource_id = "<resource_id>" request.charging_mode = "<charging_mode>" request.limit = <limit> request.offset = <offset> response = client.list_quotas_detail(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" hss "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/hss/v5/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := hss.NewHssClient( hss.HssClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListQuotasDetailRequest{} enterpriseProjectIdRequest:= "<enterprise_project_id>" request.EnterpriseProjectId = &enterpriseProjectIdRequest versionRequest:= "<version>" request.Version = &versionRequest categoryRequest:= "<category>" request.Category = &categoryRequest quotaStatusRequest:= "<quota_status>" request.QuotaStatus = "aStatusRequest usedStatusRequest:= "<used_status>" request.UsedStatus = &usedStatusRequest hostNameRequest:= "<host_name>" request.HostName = &hostNameRequest resourceIdRequest:= "<resource_id>" request.ResourceId = &resourceIdRequest chargingModeRequest:= "<charging_mode>" request.ChargingMode = &chargingModeRequest limitRequest:= int32(<limit>) request.Limit = &limitRequest offsetRequest:= int32(<offset>) request.Offset = &offsetRequest response, err := client.ListQuotasDetail(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Quota details |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot