Todos os produtos
Search

Este produto

    ApsaraVideo Live:DescribeDomainUsageData

    Central de documentação

    ApsaraVideo Live:DescribeDomainUsageData

    Última atualização: Jul 20, 2026

    Consulta os dados de uso de um nome de domínio em uma região de cobrança específica.

    Descrição da operação

    • Esta operação suporta consultas em lote de nomes de domínio. Separe vários nomes de domínio com vírgulas (,). Você pode consultar até 100 nomes de domínio por vez. Se o parâmetro DomainName estiver vazio, os dados de todos os nomes de domínio da conta serão retornados.

    • Os dados de uso incluem três tipos: tráfego, largura de banda e solicitações, medidos em bytes, bit/s e contagem, respectivamente.

    • Se você não especificar o parâmetro Interval, poderá consultar dados do último ano, e o intervalo de tempo máximo por consulta é de 31 dias. Para um período de consulta de 1 a 3 dias, os dados são retornados com granularidade horária. Para um período de consulta superior a 3 dias, os dados são retornados com granularidade diária.

    • Quando você especifica o parâmetro Interval, o intervalo de tempo máximo suportado por consulta, o intervalo de dados históricos e o atraso dos dados são os seguintes:

    Granularidade de tempoIntervalo de tempo máximo por consultaIntervalo de dados históricosAtraso dos dados
    5 minutos3 dias93 dias15 minutos
    1 hora31 dias186 dias4 horas
    1 dia90 dias366 dias04:00 do dia seguinte

    Limite de QPS

    O limite de QPS para um único usuário nesta operação é de 10 chamadas por segundo. Se o limite for excedido, a chamada da API será limitada, o que pode afetar seus negócios. Chame esta operação adequadamente.

    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

    live:DescribeDomainUsageData

    get

    *Todos os recursos.

    *

    		 Nenhuma Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    RegionId

    string

    Não

    O ID da região.

    cn-shanghai.
    DomainName

    string

    Não

    O domínio de streaming.

    • Você pode especificar um único nome de domínio ou vários nomes de domínio. Separe vários nomes de domínio com vírgulas (,).

    • Se este parâmetro estiver vazio, os dados mesclados de todos os domínios de streaming serão retornados por padrão.

    example.com.
    StartTime

    string

    Sim

    A hora de início. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ (UTC).

    2015-12-10T20:00:00Z
    EndTime

    string

    Sim

    A hora de término. Especifique a hora no formato aaaa-MM-ddTHH:mm:ssZ (UTC).

    A hora de término deve ser posterior à hora de início, e a diferença entre a hora de término e a hora de início não pode exceder 31 dias.

    2015-12-10T21:00:00Z
    Type

    string

    Não

    O tipo de dados de uso a serem obtidos.

    Quando Field está definido como bps ou traf, valores válidos:

    • rts: Largura de banda ou tráfego RTS.

    • quic: Largura de banda ou tráfego QUIC.

    Quando Field está definido como req_traf ou req_bps, valores válidos:

    • push: Largura de banda ou tráfego de ingestão de stream.

    • push_proxy: Largura de banda ou tráfego de retransmissão.

    Valores válidos:

    • rts :

      Largura de banda ou tráfego RTS.

    • all :

      all.

    • normal :

      normal.

    • static :

      static.

    • dynamic :

      dynamic.

    • push_proxy :

      Largura de banda ou tráfego de retransmissão.

    • quic :

      Largura de banda ou tráfego QUIC.

    • push :

      Largura de banda ou tráfego de ingestão de stream.

    all.
    Field

    string

    Sim

    O tipo de dados dos dados de uso a serem consultados. Valores válidos:

    • bps: Largura de banda de reprodução.

    • traf: Tráfego.

    • req_traf: Quando Type está definido como push, indica tráfego de ingestão de stream. Quando Type está definido como push_proxy, indica tráfego de retransmissão.

    • req_bps: Quando Type está definido como push, indica largura de banda de ingestão de stream. Quando Type está definido como push_proxy, indica largura de banda de retransmissão.

    traf.
    Area

    string

    Não

    O código da região. Valores válidos:

    • CN: China continental.

    • OverSeas: Fora da China continental.

    • AP1: Ásia-Pacífico 1.

    • AP2: Ásia-Pacífico 2.

    • AP3: Ásia-Pacífico 3.

    • NA: América do Norte.

    • SA: América do Sul.

    • EU: Europa.

    • MEAA: Oriente Médio e África.

    • all: Todas as regiões.

    Nota

    Se este parâmetro não for especificado, o valor padrão é a China continental. Regiões fora da China continental: - Ásia-Pacífico 1: Hong Kong (China), Macau (China), Taiwan (China), Japão e países do Sudeste Asiático, exceto Vietnã e Indonésia. - Ásia-Pacífico 2: Indonésia, Coreia do Sul e Vietnã. - Ásia-Pacífico 3: Austrália e Nova Zelândia. América do Norte: Estados Unidos e Canadá. - América do Sul: Brasil. - Europa: Ucrânia, Reino Unido, França, Países Baixos, Espanha, Itália, Suécia e Alemanha. - Oriente Médio e África: África do Sul, Omã, Emirados Árabes Unidos e Kuwait.

    CN
    DataProtocol

    string

    Não

    O protocolo dos dados a serem obtidos. Valores válidos:

    • http: HTTP.

    • https: HTTPS.

    • quic: QUIC.

    • all (padrão): Todos os protocolos acima.

    all.
    Interval

    string

    Não

    Força a obtenção de dados na granularidade de tempo especificada, em segundos. Valores válidos: 300 (5 minutos), 3600 (1 hora) e 86400 (1 dia).

    300
    Nota

    Ao consultar dados no horário T, dados estáveis estão disponíveis no horário T+N, onde N é 2 horas.
    Exemplo: Se você consultar dados das 13h00 de 21 de dezembro, poderá obter dados estáveis das 13h00 e anteriores às 15h00 de 21 de dezembro.

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    EndTime

    string

    A hora de término. Formato: aaaa-MM-ddTHH:mm:ssZ (UTC).

    2015-12-10T21:00Z
    Type

    string

    O tipo de uso.

    all.
    StartTime

    string

    A hora de início. Formato: aaaa-MM-ddTHH:mm:ssZ (UTC).

    2015-12-10T20:00Z
    RequestId

    string

    O ID da solicitação.

    B955107D-E658-4E77-B913-E0AC3D31693E
    Area

    string

    A região de uso.

    CN
    DomainName

    string

    O domínio de streaming.

    example.com.
    DataInterval

    string

    O intervalo de tempo de cada registro. Unidade: segundos.

    300
    UsageDataPerInterval

    object

    DataModule

    array<object>

    Os dados de tráfego de cada registro.

    object

    Value

    string

    O valor de uso.

    • Se Field estiver definido como traf ou req_traf, a unidade é bytes.

    • Se Field estiver definido como bps ou req_bps, a unidade é bps.

    • Se Field estiver definido como acc, a unidade é contagens.

    423304182
    TimeStamp

    string

    A hora de início da fatia de tempo. A hora está em UTC e o formato é yyyy-MM-ddTHH:mm:ssZ.

    2015-12-10T20:00:00Z

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "EndTime": "2015-12-10T21:00Z",
  "Type": "all",
  "StartTime": "2015-12-10T20:00Z",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "Area": "CN",
  "DomainName": "example.com",
  "DataInterval": "300",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "Value": "423304182",
        "TimeStamp": "2015-12-10T20:00:00Z"
      }
    ]
  }
}

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 InvaildParameter Invalid Parameter Os parâmetros inseridos são inválidos. Verifique se os parâmetros de entrada estão completos e corretos.
    400 InvalidStartTime.Malformed Specified StartTime is malformed.
    400 InvalidEndTime.Malformed Specified EndTime is malformed.
    400 InvalidStartTime.ValueNotSupported The specified value of parameter StartTime is not supported. O parâmetro StartTime especificado não é suportado.
    400 InvalidTime.Malformed Specified Time is malformed. O intervalo entre StartTime e EndTime é inválido. Verifique a solicitação e tente novamente.
    400 InvalidParameterField The specified Field is invalid. O parâmetro Field é inválido. Verifique o parâmetro e tente novamente.
    400 InvalidParameterType The specified Type is invalid. O parâmetro Type é inválido. Verifique o parâmetro e tente novamente.
    400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. A hora de término não corresponde à hora de início. Verifique se os horários são consistentes.
    400 InvalidTimeSpan The time span exceeds the limit. O intervalo de tempo excede o limite. Consulte a documentação da API para configurar um intervalo de tempo de consulta válido.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.