Todos os produtos
Search

Este produto

    MaxCompute:QueryTunnelMetricDetail

    Central de documentação

    MaxCompute:QueryTunnelMetricDetail

    Última atualização: Oct 27, 2026

    Consulta os dados detalhados 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 oferece suporte à consulta de várias métricas do Tunnel, incluindo detalhes de uso de slot (slot_usage_detail), detalhes de taxa de transferência (throughput_detail) e resumo de taxa de transferência (throughput_summary).

    • Os parâmetros quotaNickname e project não podem estar vazios ao mesmo tempo.

    • Quando groupList contém table ou ip, o parâmetro project deve ser especificado. Se contiver ip, o parâmetro tableList também deve ser especificado.

    • orderColumn oferece suporte a maxValue, minValue, avgValue e sumValue (aplicável apenas a throughput_summary). O valor padrão é vazio, o que significa que nenhuma classificação é aplicada.

    • O valor padrão de ascOrder é false, o que indica ordem decrescente.

    • O parâmetro limit define o número máximo de resultados retornados. O valor padrão é 10 e o valor máximo é 100.

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

    list

    *Tunnel

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

    		 Nenhuma Nenhuma

    Sintaxe da solicitação

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

    Parâmetros de caminho

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    metric

    string

    Sim

    O nome da métrica de observabilidade.

    Valores válidos:

    • slot_usage_detail :

      slot_usage_detail.

    • throughput_summary :

      throughput_summary.

    • throughput_detail :

      throughput_detail.

    slot_usage_detail

    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 timestamp UNIX em segundos.

    1735534322
    endTime

    integer

    Sim

    A hora de fim do intervalo de tempo da consulta. O valor é um timestamp UNIX em segundos.

    1735536322
    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.

    quota_A
    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 vazia, 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 stream 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

    upload
    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_detail

    quota
    orderColumn

    string

    Não

    A coluna pela qual classificar os resultados.

    Valores válidos:

    • avgValue :

      avgValue.

    • minValue :

      minValue.

    • maxValue :

      maxValue.

    • sumValue :

      sumValue.

    maxValue
    ascOrder

    boolean

    Não

    Especifica se os resultados devem ser classificados em ordem crescente.

    false
    limit

    integer

    Não

    O número máximo de resultados a serem retornados. Valor padrão: 10. Valor máximo: 100.

    10
    codeList

    array

    Não

    A lista de códigos de erro.

    integer

    Não

    O código de erro, como 400 ou 500.

    403

    slot_usage_detail

    • Detalhes dos N principais usos de slot

    • Parâmetros de filtro opcionais suportados: quotaNickname, project, tableList, operationList e groupList

      • quotaNickname e project não podem estar vazios ao mesmo tempo.

      • orderColumn suporta apenas maxValue, minValue e avgValue. O valor padrão é vazio, o que significa que nenhuma classificação é aplicada.

      • O valor padrão de ascOrder é false, o que indica ordem decrescente.

      • O valor padrão de limit é 10 e o valor máximo é 100.

    • groupList suporta quota, project, table e operation.

      • groupList não pode estar vazio. Especifica a granularidade de exibição dos dados.

    throughput_detail

    • Detalhes das N principais taxas de transferência

    • Parâmetros de filtro opcionais suportados: quotaNickname, project, tableList, operationList e groupList

      • quotaNickname e project não podem estar vazios ao mesmo tempo.

      • orderColumn suporta apenas maxValue, minValue e avgValue. O valor padrão é vazio, o que significa que nenhuma classificação é aplicada.

      • O valor padrão de ascOrder é false, o que indica ordem decrescente.

      • O valor padrão de limit é 10 e o valor máximo é 100.

    • groupList suporta quota, project, table, ip e operation.

      • groupList não pode estar vazio. Especifica a granularidade de exibição dos dados.

    throughput_summary

    • Resumo da taxa de transferência

    • Parâmetros de filtro opcionais suportados: quotaNickname, project, tableList, operationList e groupList

      • quotaNickname e project não podem estar vazios ao mesmo tempo.

      • orderColumn suporta apenas sumValue. O valor padrão é vazio, o que significa que nenhuma classificação é aplicada.

      • O valor padrão de ascOrder é false, o que indica ordem decrescente.

      • O valor padrão de limit é 10 e o valor máximo é 100.

    • groupList suporta quota, project, table e operation.

      • groupList não pode estar vazio. Especifica a granularidade de exibição dos dados.

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    PopResult

    requestId

    string

    O ID da solicitação.

    0a06dd4516687375802853481ec9fd
    httpCode

    integer

    O código de status HTTP retornado.

    200
    errorCode

    string

    O código de erro.

    OBJECT_NOT_EXIST
    errorMsg

    string

    A mensagem de erro.

    plan \"***\" does not exist
    data

    object

    Os dados retornados.

    name

    string

    O nome da métrica de observabilidade.

    tableA
    metrics

    array<object>

    Os valores das métricas.

    array<object>

    Os valores das métricas.

    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"
    value

    object

    As informações do valor da métrica.

    "avgValue":"11.5"

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "requestId": "0a06dd4516687375802853481ec9fd",
  "httpCode": 200,
  "errorCode": "OBJECT_NOT_EXIST",
  "errorMsg": "plan \\\"***\\\" does not exist",
  "data": {
    "name": "tableA",
    "metrics": [
      {
        "metric": {
          "key": "\"project\":\"prjName\""
        },
        "value": {
          "test": "test",
          "test2": 1
        }
      }
    ]
  }
}

    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.