Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Atualizado em 2024-09-14 GMT+08:00

Consulta de detalhes da cota

Função

Essa API é usada para consultar detalhes da cota.

Método de chamada

Para obter detalhes, consulte Chamada de APIs.

URI

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

Tabela 1 Parâmetros de caminho

Parâmetro

Obrigatório

Tipo

Descrição

project_id

Sim

String

ID do projeto

Mínimo: 1

Máximo: 256

Tabela 2 Parâmetros de consulta

Parâmetro

Obrigatório

Tipo

Descrição

enterprise_project_id

Não

String

ID do projeto empresarial. Para consultar todos os projetos empresariais, defina este parâmetro como all_granted_eps.

Padrão: 0

Mínimo: 1

Máximo: 256

version

Não

String

Edição do HSS. Seu valor pode ser:

  • hss.version.null

  • hss.version.basic: edição básica

  • hss.version.advanced: edição profissional

  • hss.version.enterprise: edição empresarial

  • hss.version.premium: edição premium

  • hss.version.wtp: edição WTP

  • hss.version.container.enterprise: edição de container

Mínimo: 1

Máximo: 64

category

Não

String

Tipo. Seu valor pode ser:

  • host_resource

  • container_resource

Mínimo: 1

Máximo: 64

quota_status

Não

String

Status da cota. Pode ser:

  • QUOTA_STATUS_NORMAL

    • QUOTA_STATUS_EXPIRED

    • QUOTA_STATUS_FREEZE

Mínimo: 1

Máximo: 64

used_status

Não

String

Status de uso. Pode ser:

  • USED_STATUS_IDLE

  • USED_STATUS_USED

Mínimo: 1

Máximo: 64

host_name

Não

String

Nome de servidor

Mínimo: 0

Máximo: 128

resource_id

Não

String

Especifica o ID do recurso da cota do HSS.

Mínimo: 0

Máximo: 128

charging_mode

Não

String

Modo de cobrança. Seu valor pode ser:

  • packet_cycle: anual/mensal

  • on_demand: pagamento por uso

Mínimo: 1

Máximo: 32

limit

Não

Integer

Número de itens por página

Mínimo: 10

Máximo: 200

Padrão: 10

offset

Não

Integer

Deslocamento, que especifica a posição inicial do registro a ser retornado. O valor deve ser um número.

Mínimo: 0

Máximo: 2000000

Padrão: 0

Parâmetros de solicitação

Tabela 3 Parâmetros de cabeçalho de solicitação

Parâmetro

Obrigatório

Tipo

Descrição

X-Auth-Token

Sim

String

Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token.

Mínimo: 32

Máximo: 4096

region

Não

String

ID da região

Mínimo: 0

Máximo: 128

Parâmetros de resposta

Código de status: 200

Tabela 4 Parâmetros do corpo de resposta

Parâmetro

Tipo

Descrição

packet_cycle_num

Integer

Cotas anuais/mensais

Mínimo: 0

Máximo: 10000000

on_demand_num

Integer

Cotas de pagamento por uso

Mínimo: 0

Máximo: 10000000

used_num

Integer

Cotas usadas

Mínimo: 0

Máximo: 10000000

idle_num

Integer

Cotas ociosas

Mínimo: 0

Máximo: 10000000

normal_num

Integer

Cotas normais

Mínimo: 0

Máximo: 10000000

expired_num

Integer

Cotas expiradas

Mínimo: 0

Máximo: 10000000

freeze_num

Integer

Cotas congeladas

Mínimo: 0

Máximo: 10000000

quota_statistics_list

Array of QuotaStatisticsResponseInfo objects

Lista de estatísticas de cota

Comprimento da matriz: 0–200

total_num

Integer

Cotas totais

Mínimo: 0

Máximo: 10000000

data_list

Array of QuotaResourcesResponseInfo objects

Lista de cotas

Comprimento da matriz: 0–200

Tabela 5 QuotaStatisticsResponseInfo

Parâmetro

Tipo

Descrição

version

String

Flavor do recurso. Seu valor pode ser:

  • hss.version.basic: edição básica

  • hss.version.advanced: edição profissional

  • hss.version.enterprise: edição empresarial

  • hss.version.premium: edição premium

  • hss.version.wtp: edição WTP

  • hss.version.container: edição de container

Mínimo: 1

Máximo: 64

total_num

Integer

Cotas totais

Mínimo: 0

Máximo: 10000000

Tabela 6 QuotaResourcesResponseInfo

Parâmetro

Tipo

Descrição

resource_id

String

ID de recurso de uma cota de HSS

Mínimo: 0

Máximo: 256

version

String

Flavor do recurso. Seu valor pode ser:

  • hss.version.basic: edição básica

  • hss.version.advanced: edição profissional

  • hss.version.enterprise: edição empresarial

  • hss.version.premium: edição premium

  • hss.version.wtp: edição WTP

  • hss.version.container: edição de container

Mínimo: 1

Máximo: 64

quota_status

String

Status da cota. Pode ser:

  • normal

  • expired

  • freeze

Mínimo: 1

Máximo: 64

used_status

String

Status de uso. Seu valor pode ser:

  • idle

  • used

Mínimo: 1

Máximo: 64

host_id

String

ID do host

Mínimo: 1

Máximo: 64

host_name

String

Nome de servidor

Mínimo: 1

Máximo: 128

charging_mode

String

Modo de cobrança. Seu valor pode ser:

  • packet_cycle: anual/mensal

  • on_demand: pagamento por uso

Mínimo: 1

Máximo: 64

tags

Array of TagInfo objects

Tag

Comprimento da matriz: 0–2097152

expire_time

Long

Tempo de expiração. O valor -1 indica que o recurso não expirará.

Mínimo: 0

Máximo: 2147483647

shared_quota

String

Se as cotas são compartilhadas. Seu valor pode ser:

  • shared

  • unshared

Mínimo: 1

Máximo: 64

enterprise_project_id

String

ID do projeto empresarial

Mínimo: 0

Máximo: 256

enterprise_project_name

String

Nome do projeto empresarial

Mínimo: 0

Máximo: 256

Tabela 7 TagInfo

Parâmetro

Tipo

Descrição

key

String

Chave. Pode conter até 128 caracteres Unicode. O key não pode ser deixado em branco.

Mínimo: 1

Máximo: 128

value

String

Valor. Cada valor de tag pode conter um máximo de 255 caracteres Unicode.

Mínimo: 1

Máximo: 255

Exemplo de solicitações

Essa API é usada para consultar detalhes de cotas em todos os projetos empresariais.

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

Exemplo de respostas

Código de status: 200

Detalhes da cota

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

Código de amostra do SDK

O código de amostra do SDK é o seguinte.

Java

 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());
        }
    }
}

Python

 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)

Go

 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)
    }
}

Mais

Para obter o código de amostra do SDK de mais linguagens de programação, consulte a guia Código de amostra no API Explorer. O código de amostra do SDK pode ser gerado automaticamente.

Códigos de status

Código de status

Descrição

200

Detalhes da cota

Códigos de erro

Consulte Códigos de erro.