DescribeVodDomainSrcBpsData - ApsaraVideo VOD: Central de Documentação do Alibaba Cloud

Consulta os dados de largura de banda de retorno à origem de nomes de domínio acelerados.

Descrição da operação

Atualmente, o endpoint desta operação de API suporta apenas China (Shanghai).
Suporta consultas em lote. Você pode consultar dados de até 500 nomes de domínio por vez.
Se você não especificar StartTime e EndTime, esta operação de API retorna os dados das últimas 24 horas por padrão. Se você especificar StartTime e EndTime, esta operação de API retorna os dados do período especificado.

Granularidade de tempo do timestamp dos dados retornados

Se você não especificar as configurações de intervalo, a granularidade de tempo padrão do timestamp dos dados retornados, o intervalo de tempo consultável de dados históricos e o atraso dos dados variam de acordo com o intervalo de tempo especificado por StartTime e EndTime. Os detalhes são os seguintes:

Granularidade de tempo	Intervalo de tempo para uma única consulta	Intervalo de tempo de dados históricos consultáveis	Atraso dos dados
5 minutos	Intervalo de tempo para uma única consulta < 3 dias	93 dias	15 minutos
1 hora	3 dias ≤ Intervalo de tempo para uma única consulta < 31 dias	186 dias	Geralmente de 3 a 4 horas
1 dia	31 dias ≤ Intervalo de tempo para uma única consulta ≤ 366 dias	366 dias	Geralmente 4 horas, até 24 horas

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

vod:DescribeVodDomainSrcBpsData

get

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DomainName	string	Não	O nome de domínio acelerado a ser consultado. Se você não especificar este parâmetro, os dados agregados de todos os nomes de domínio acelerados serão retornados por padrão. Suporta consultas em lote. Separe vários nomes de domínio com vírgulas (,). Você pode consultar até 500 nomes de domínio por vez. Você pode fazer login no console do ApsaraVideo VOD e escolher Gerenciamento de Configuração > Configuração de Aceleração de Distribuição > Nomes de Domínio no painel de navegação à esquerda para visualizar os nomes de domínio acelerados adicionados ao ApsaraVideo VOD. Alternativamente, você pode invocar a operação de API DescribeVodUserDomains para consultar a lista de nomes de domínio acelerados.	example.com
StartTime	string	Não	A hora de início dos dados a serem recuperados. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC.	2022-04-25T16:00:00Z
EndTime	string	Não	A hora de término dos dados a serem recuperados. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Nota A hora de término deve ser posterior à hora de início.	2022-04-26T15:59:59Z
Interval	string	Não	A granularidade de tempo dos dados a serem consultados. Unidade: segundos. Valores válidos: 300, 3600 e 86400. Se você não especificar este parâmetro ou especificar um valor não suportado, o valor padrão será usado. Com base no intervalo de tempo especificado por StartTime e EndTime, as granularidades de tempo suportadas são as seguintes: Menos de 3 dias: 300 (padrão), 3600 e 86400. 3 a 31 dias (excluindo 31 dias): 3600 (padrão) e 86400. Mais de 31 dias: 86400 (padrão).	300

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
EndTime	string	A hora de término dos dados. A hora está no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e em UTC.	2022-08-23T02:02:57Z
StartTime	string	A hora de início dos dados. A hora está no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ e em UTC.	2022-07-12T16:00:00Z
RequestId	string	O ID da solicitação.	25818875-5F78-4A13-BEF6-****
DomainName	string	O nome de domínio acelerado.	sample.com
DataInterval	string	O intervalo de tempo de cada registro, que é a granularidade de tempo dos dados. Unidade: segundos.	300
SrcBpsDataPerInterval	object
DataModule	array<object>	A lista de dados de largura de banda de retorno à origem para cada intervalo de tempo.
	object
Value	string	A largura de banda total de retorno à origem. Unidade: bit/s.	0
TimeStamp	string	O timestamp UNIX do timestamp dos dados. O formato de data segue a notação ISO 8601 e usa UTC.	2022-07-12T16:00:00Z
HttpsValue	string	A largura de banda de retorno à origem HTTPS. Unidade: bit/s.	0

Exemplos

Resposta de sucesso

JSON formato

{
  "EndTime": "2022-08-23T02:02:57Z",
  "StartTime": "2022-07-12T16:00:00Z",
  "RequestId": "25818875-5F78-4A13-BEF6-****",
  "DomainName": "sample.com",
  "DataInterval": "300",
  "SrcBpsDataPerInterval": {
    "DataModule": [
      {
        "Value": "0",
        "TimeStamp": "2022-07-12T16:00:00Z",
        "HttpsValue": "0"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter	StartTime and EndTime can not be single.
400	InvalidStartTime.Malformed	Specified StartTime is malformed.	O formato da hora de início é inválido.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.	O formato da hora de término é inválido.
400	InvalidEndTime.Mismatch	Specified end time does not math the specified start time.
400	InvalidStartTime.ValueNotSupported	The specified value of parameter StartTime is not supported.
400	Abs.DomainName.Malformed	The size of DomainName is too big.
400	InvalidInterval.Malformed	Specified Interval is malformed.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.