更新时间:2024-04-26 GMT+08:00
分享

查询配额详情

功能介绍

查询配额详情

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

最小长度:1

最大长度:256

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

企业项目ID,查询所有企业项目时填写:all_granted_eps

缺省值:0

最小长度:1

最大长度:256

version

String

主机开通的版本,包含如下7种输入。

  • hss.version.null :无。

  • hss.version.basic :基础版。

  • hss.version.advanced :专业版。

  • hss.version.enterprise :企业版。

  • hss.version.premium :旗舰版。

  • hss.version.wtp :网页防篡改版。

  • hss.version.container.enterprise:容器版。

最小长度:1

最大长度:64

category

String

类别,包含如下几种:

  • host_resource :HOST_RESOURCE

  • container_resource :CONTAINER_RESOURCE

最小长度:1

最大长度:64

quota_status

String

配额状态,包含如下几种:

  • normal : QUOTA_STATUS_NORMAL

  • expired :QUOTA_STATUS_EXPIRED

  • freeze :QUOTA_STATUS_FREEZE

最小长度:1

最大长度:64

used_status

String

使用状态,包含如下几种:

  • idle :USED_STATUS_IDLE

  • used :USED_STATUS_USED

最小长度:1

最大长度:64

host_name

String

服务器名称

最小长度:0

最大长度:128

resource_id

String

HSS配额的资源ID

最小长度:0

最大长度:128

charging_mode

String

收费模式,包含如下2种。

  • packet_cycle :包年/包月。

  • on_demand :按需。

最小长度:1

最大长度:32

limit

Integer

每页数量

最小值:10

最大值:200

缺省值:10

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字

最小值:0

最大值:2000000

缺省值:0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

最小长度:32

最大长度:4096

region

String

Region ID

最小长度:0

最大长度:128

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

packet_cycle_num

Integer

包周期配额数

最小值:0

最大值:10000000

on_demand_num

Integer

按需配额数

最小值:0

最大值:10000000

used_num

Integer

已使用配额数

最小值:0

最大值:10000000

idle_num

Integer

空闲配额数

最小值:0

最大值:10000000

normal_num

Integer

正常配额数

最小值:0

最大值:10000000

expired_num

Integer

过期配额数

最小值:0

最大值:10000000

freeze_num

Integer

冻结配额数

最小值:0

最大值:10000000

quota_statistics_list

Array of QuotaStatisticsResponseInfo objects

配额统计列表

数组长度:0 - 200

total_num

Integer

配额总数

最小值:0

最大值:10000000

data_list

Array of QuotaResourcesResponseInfo objects

配额列表

数组长度:0 - 200

表5 QuotaStatisticsResponseInfo

参数

参数类型

描述

version

String

资源规格编码,包含如下:

  • hss.version.basic : 基础版

  • hss.version.advanced : 专业版

  • hss.version.enterprise : 企业版

  • hss.version.premium : 旗舰版

  • hss.version.wtp : 网页防篡改版

  • hss.version.container : 容器版

最小长度:1

最大长度:64

total_num

Integer

配额总数

最小值:0

最大值:10000000

表6 QuotaResourcesResponseInfo

参数

参数类型

描述

resource_id

String

主机安全配额的资源ID

最小长度:0

最大长度:256

version

String

资源规格编码,包含如下:

  • hss.version.basic : 基础版

  • hss.version.advanced : 专业版

  • hss.version.enterprise : 企业版

  • hss.version.premium : 旗舰版

  • hss.version.wtp : 网页防篡改版

  • hss.version.container : 容器版

最小长度:1

最大长度:64

quota_status

String

配额状态

  • normal : 正常

  • expired : 已过期

  • freeze : 已冻结

最小长度:1

最大长度:64

used_status

String

使用状态

  • idle : 空闲

  • used : 使用中

最小长度:1

最大长度:64

host_id

String

主机ID

最小长度:1

最大长度:64

host_name

String

服务器名称

最小长度:1

最大长度:128

charging_mode

String

计费模式

  • packet_cycle : 包周期

  • on_demand : 按需

最小长度:1

最大长度:64

tags

Array of TagInfo objects

标签

数组长度:0 - 2097152

expire_time

Long

过期时间,-1表示没有到期时间

最小值:0

最大值:2147483647

shared_quota

String

是否共享配额

  • shared:共享的

  • unshared:非共享的

最小长度:1

最大长度:64

enterprise_project_id

String

企业项目ID

最小长度:0

最大长度:256

enterprise_project_name

String

所属企业项目名称

最小长度:0

最大长度:256

表7 TagInfo

参数

参数类型

描述

key

String

键。最大长度128个unicode字符。 key不能为空

最小长度:1

最大长度:128

value

String

值。最大长度255个unicode字符。

最小长度:1

最大长度:255

请求示例

查询所有企业项目下的配额详情

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

响应示例

状态码: 200

配额详情列表

{
  "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" : "服务",
      "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代码示例

SDK代码示例如下。

 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
# coding: utf-8

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 = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("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 = &quotaStatusRequest
	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)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

配额详情列表

错误码

请参见错误码

分享:

    相关文档

    相关产品