GetQuotaUsage - MaxCompute: Central de Documentação do Alibaba Cloud

Consulta as informações de consumo de recursos de cota.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

odps:GetQuotaUsage

get

*Quota

acs:odps:{#regionId}:{#accountId}:quotas/{#nickName}

Nenhuma

Sintaxe da solicitação

GET /api/v1/quotas/{nickname}/usage HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
nickname	string	Sim	O alias da cota de nível 1.	os_quota_p

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
tenantId	string	Não	O ID do locatário. Você pode fazer login no console do MaxCompute e escolher Locatários > Propriedade do Locatário no painel de navegação à esquerda para visualizar o ID do locatário.	478403690625249
region	string	Não	O ID da região.	cn-chengdu
from	integer	Sim	A hora em que a consulta começa. O valor é a hora do log especificada quando os dados de log são gravados. O intervalo de tempo especificado nesta operação é um intervalo fechado à esquerda e aberto à direita. O intervalo inclui a hora de início especificada pelo parâmetro from, mas não inclui a hora de término especificada pelo parâmetro to. Se você definir os parâmetros from e to com o mesmo valor, o intervalo de tempo será inválido e uma mensagem de erro será retornada. Este valor é um timestamp UNIX que representa o número de segundos decorridos desde 1 de janeiro de 1970, 00:00:00 UTC.	1669081045
to	integer	Sim	A hora em que a consulta termina. O valor é a hora do log especificada quando os dados de log são gravados. O intervalo de tempo especificado nesta operação é um intervalo fechado à esquerda e aberto à direita. O intervalo inclui a hora de início especificada pelo parâmetro from, mas não inclui a hora de término especificada pelo parâmetro to. Se você definir os parâmetros from e to com o mesmo valor, o intervalo de tempo será inválido e uma mensagem de erro será retornada. Este valor é um timestamp UNIX que representa o número de segundos decorridos desde 1 de janeiro de 1970, 00:00:00 UTC.	1669360870
subQuotaNickname	string	Não	O alias da cota de nível 2.	ot_tunnel_quota
aggMethod	string	Não	O algoritmo de agregação. Para uma melhor experiência na página, até 60 pontos podem ser exibidos para cada métrica. Se você selecionar um intervalo de tempo superior a 1 hora, o gráfico usará o valor médio dentro do intervalo (minutos do intervalo de tempo selecionado/60) para agregar dados por padrão. Você pode alterar o algoritmo de agregação com base nos requisitos do seu negócio.	max
productId	string	Não	O tipo de cota. Valor padrão: ODPS. ODPS: cota de computação TUNNEL: cota do Tunnel	ODPS
plotTypes	array	Não	Os tipos dos gráficos.
	string	Não	O tipo do gráfico. Quando productId é definido como ODPS, este parâmetro é opcional e possui os seguintes valores válidos: cpu: recursos de CPU. memory: recursos de memória. Se este parâmetro não for configurado, ambas as métricas serão retornadas. Quando productId é definido como TUNNEL, este parâmetro é obrigatório e possui os seguintes valores válidos: request: o paralelismo da solicitação. throughput: a taxa de transferência. error: o número de solicitações com erro.	cpu
yAxisTypes	array	Não	Os campos de métrica de dados.
	string	Não	O campo de métrica de dados. Você não precisa especificar este parâmetro se o parâmetro productId estiver definido como ODPS. Você pode inserir um nome de projeto quando productId estiver definido como TUNNEL. Nesse caso, o resultado retornado são as informações da dimensão do projeto.	your_project_name

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
requestId	string	O ID da solicitação.	0b87b7a416652014358483492eea0b
httpCode	integer	O código de status HTTP. 1xx: resposta informativa. A solicitação foi recebida e está sendo processada. 2xx: sucesso. A solicitação foi recebida, compreendida e aceita com sucesso pelo servidor. 3xx: redirecionamento. A solicitação é redirecionada e outras ações são necessárias para concluir a solicitação. 4xx: erro do cliente. A solicitação contém parâmetros e sintaxes de solicitação inválidos, ou condições específicas de solicitação não podem ser atendidas. 5xx: erro do servidor. O servidor não pode atender aos requisitos devido a outros motivos.	200
errorCode	string	O código de erro.	OBJECT_NOT_EXIST
errorMsg	string	A mensagem de erro.	This object does not exist.
data	object	Os dados retornados.
metrics	object	Os resultados das métricas.	"timestamps": [1668046140000, 1668065220000], //milliseconds "project1#upload#request": [10, 20], "project1#download#request": [20, 30], "project1#upload#throughput": [50, 50], "project1#download#throughput": [60, 70], "pro2#errorNum": [5, 10]
plot	array<object>	As informações sobre o gráfico.
	object	As informações sobre o gráfico.
title	string	The title of the chart.	Project request concurrency
type	string	The type of the chart.	request
yAxis	array	The data metric field.
	string	The data metric field. If the productId parameter is set to ODPS: CPU metric type or memory metric type If the productId parameter is set to TUNNEL and a project name is entered: project#operation#type	project1#download#request

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "0b87b7a416652014358483492eea0b",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "This object does not exist.",
  "data": {
    "metrics": {
      "test": "test",
      "test2": 1
    },
    "plot": [
      {
        "title": "Project request concurrency",
        "type": "request",
        "yAxis": [
          "project1#download#request"
        ]
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.