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

Consulta os dados de métrica do serviço de transferência de dados do Tunnel dentro de um intervalo de tempo especificado.

Descrição da operação

Descrição da solicitação

Esta API suporta a consulta de várias métricas do Tunnel, incluindo uso de slots (slot_usage), limite máximo de slots (slot_max), taxa de transferência (throughput), velocidade de taxa de transferência (throughput_speed) e contagem de solicitações (request).
startTime e endTime são parâmetros obrigatórios, representando os carimbos de data/hora de início e fim (em segundos) do intervalo de tempo da consulta, respectivamente.
O parâmetro metric também é obrigatório e é usado para especificar o tipo exato de métrica a ser consultada.
Dependendo do valor de metric, parâmetros de filtro adicionais como quotaNickname, project, tableList, operationList, codeList, groupList e topN podem ser necessários para refinar ainda mais as condições da consulta.
Observe que para certos valores de metric (por exemplo, quando groupList inclui table ou ip), você deve especificar o projeto relacionado (project) e outros parâmetros obrigatórios, e o sistema retornará forçosamente os resultados do Top N.
O parâmetro strategy define a lógica de agregação de dados quando o tamanho da etapa adaptativa excede 60 segundos em um longo intervalo de tempo. O valor padrão é max.
Certifique-se de que todos os parâmetros fornecidos atendam aos requisitos listados na documentação para evitar falhas na solicitação.

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:QueryTunnelMetric

list

*Tunnel

acs:odps:{#regionId}:{#accountId}:tunnel/{#metric}

Nenhuma

Sintaxe da solicitação

POST /api/v1/observations/tunnel/{metric} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
metric	string	Sim	O nome da métrica de observação. Valores válidos: request : request. slot_max : slot_max. slot_usage : slot_usage. throughput : throughput. throughput_speed : throughput_speed.	slot_usage

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
startTime	integer	Sim	A hora de início do intervalo de tempo da consulta. O valor é um carimbo de data/hora UNIX em segundos.	1735534322
endTime	integer	Sim	A hora de fim do intervalo de tempo da consulta. O valor é um carimbo de data/hora UNIX em segundos.	1735536322
strategy	string	Não	A estratégia de agregação de dados. Valor padrão: max. A frequência de coleta de dados é de 1 minuto. Quando o intervalo de tempo da consulta é grande, o tamanho da etapa adaptativa para exibição de dados excede 1 minuto e as métricas são agregadas. Este parâmetro especifica a lógica de agregação de dados. Valores válidos: avg : avg. max : max.	max
body	object	Não	Os parâmetros do corpo da solicitação.
quotaNickname	string	Não	O apelido da cota de nível 2 do Tunnel. O apelido de uma cota compartilhada é default. O apelido de uma cota exclusiva está no formato quotaNickname#subQuotaNickname.	default
project	string	Não	O nome do projeto.	project_a
tableList	array	Não	A lista de nomes de tabelas. As tabelas pertencem a um projeto. Portanto, se tableList não estiver vazio, project não poderá estar vazio.
	string	Não	O nome da tabela.	tab_name
operationList	array	Não	A lista de tipos de operação.
	string	Não	O tipo de operação. Valores válidos: upload: Upload em lote do Tunnel. download: Download em lote do Tunnel. stream_upload: Upload de fluxo do Tunnel. max_storage_read: Download da API de armazenamento. download_instance: Download de instância do Tunnel. upsert: Upload Upsert do Tunnel. max_storage_write: Upload da API de armazenamento. table_preview: Download de visualização. Valores válidos: download : download. max_storage_read : max_storage_read. max_storage_write : max_storage_write. upload : upload. upsert : upsert. table_preview : table_preview. download_instance : download_instance. stream_upload : stream_upload.	upload
codeList	array	Não	A lista de códigos de status HTTP das solicitações.
	integer	Não	Código HTTP.	403
groupList	array	Não	A lista de critérios de agrupamento.
	string	Não	O critério de agrupamento. Valores válidos: quota project table operation ip (suportado apenas quando a métrica é throughput) code (suportado apenas quando a métrica é request)	quota
topN	integer	Não	O limite no número de entradas de dados. Este parâmetro entra em vigor quando o critério de agrupamento inclui table ou ip. Valor padrão: 10. Valor máximo: 100.	10

slot_usage

Uso de slots.
Parâmetros de filtro opcionais suportados: quotaNickname, project, tableList, operationList, groupList e topN.
- quotaNickname e project não podem estar vazios ao mesmo tempo.
- tableList e topN entram em vigor apenas quando project é especificado e groupList inclui table.
groupList suporta quota, project, table e operation.
- groupList não pode estar vazio e indica a granularidade de exibição dos dados.
- Quando quotaNickname é default, groupList deve incluir project porque as cotas compartilhadas estão no nível do projeto.
- Quando groupList inclui table, o parâmetro project deve ser especificado. Nesse caso, o sistema retorna forçosamente os dados de série temporal do Top N.

slot_max

Limite máximo de slots.
quotaNickname é obrigatório.
- Quando quotaNickname é default, o parâmetro project deve ser especificado porque as cotas compartilhadas estão no nível do projeto.
groupList suporta apenas quota e project.

throughput

Taxa de transferência.
Parâmetros de filtro opcionais suportados: quotaNickname, project, tableList, operationList, groupList e topN.
- quotaNickname e project não podem estar vazios ao mesmo tempo.
- tableList e topN entram em vigor apenas quando project é especificado e groupList inclui table ou ip.
groupList suporta quota, project, table, ip e operation.
- groupList não pode estar vazio e indica a granularidade de exibição dos dados.
- Quando groupList inclui table, o parâmetro project deve ser especificado. Nesse caso, o sistema retorna forçosamente os dados de série temporal do Top N.
- Quando groupList inclui ip, os parâmetros project e tableList devem ser especificados. Nesse caso, o sistema retorna forçosamente os dados de série temporal do Top N.

throughput_speed

Velocidade da taxa de transferência.
Parâmetros de filtro opcionais suportados: quotaNickname, project, tableList, operationList, groupList e topN.
- quotaNickname e project não podem estar vazios ao mesmo tempo.
- tableList e topN entram em vigor apenas quando project é especificado e groupList inclui table.
groupList suporta quota, project, table e operation.
- groupList não pode estar vazio e indica a granularidade de exibição dos dados.
- Quando groupList inclui table, o parâmetro project deve ser especificado. Nesse caso, o sistema retorna forçosamente os dados de série temporal do Top N.

request

Contagem de solicitações.
Parâmetros de filtro opcionais suportados: quotaNickname, project, tableList, operationList, codeList, groupList e topN.
- quotaNickname e project não podem estar vazios ao mesmo tempo.
- tableList e topN entram em vigor apenas quando project é especificado e groupList inclui table.
groupList suporta quota, project, table, operation e code.
- groupList não pode estar vazio e indica a granularidade de exibição dos dados.
- Quando groupList inclui table, o parâmetro project deve ser especificado. Nesse caso, o sistema retorna forçosamente os dados de série temporal do Top N.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	PopResult
requestId	string	O ID da solicitação.	0bc3b4b016674434996033675e71ee
httpCode	integer	Indica se a operação de negócio é bem-sucedida. Se o valor não estiver vazio e não for 200, a operação de negócio falha.	200
errorCode	string	O código de erro.	success
errorMsg	string	A mensagem de erro.	0A3B1E82006A23A918C70905BF08AEC7
data	object	Os dados retornados.
category	string	A categoria à qual a métrica de observação pertence.	tunnel
name	string	O nome da métrica de observação.	slot_usage
period	integer	O tamanho da etapa dos dados de monitoramento.	60
metrics	array<object>	Os valores da métrica.
	array<object>	Os valores da métrica.
metric	object	As informações de metadados da métrica.
	string	As informações de metadados. A chave é o critério de agrupamento e o valor são os metadados correspondentes.	"project":"prjName"
values	array	A lista de valores da métrica.
	array	Uma matriz de comprimento 2, contendo o carimbo de data/hora e o valor, respectivamente.
	number	O timestamp e o valor da métrica.	[1745220780,1]

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "0bc3b4b016674434996033675e71ee",
  "httpCode": 200,
  "errorCode": "success",
  "errorMsg": "0A3B1E82006A23A918C70905BF08AEC7",
  "data": {
    "category": "tunnel",
    "name": "slot_usage",
    "period": 60,
    "metrics": [
      {
        "metric": {
          "key": "\"project\":\"prjName\""
        },
        "values": [
          [
            0
          ]
        ]
      }
    ]
  }
}

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.