DescribeUpBpsPeakData - ApsaraVideo Live: Central de Documentação do Alibaba Cloud

Descrição da operação

Chama a operação para consultar a largura de banda upstream de pico diário de um usuário.

Limite de QPS

O limite de consultas por segundo (QPS) para um único usuário para esta operação é 5. Se o limite for excedido, as chamadas de API serão limitadas, o que pode afetar seus negócios. Chame esta operação conforme necessário. Para mais informações, consulte Limite de QPS.

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

get

*All Resource

*

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
StartTime	string	Sim	A hora de início da extração de stream. Especifique a hora em UTC. O intervalo entre StartTime e EndTime deve ser de no máximo 30 dias.	2017-10-10T20:00:00Z
EndTime	string	Sim	A hora de término da extração de stream. Especifique a hora em UTC. O intervalo entre StartTime e EndTime deve ser de no máximo 30 dias, e EndTime deve ser posterior à hora atual.	2017-10-10T21:00:00Z
DomainSwitch	string	Não	Especifica se as estatísticas em nível de domínio devem ser ativadas. Valores válidos: on: ativa as estatísticas em nível de domínio. off: retorna dados em nível de usuário. Os dados em nível de usuário são retornados por padrão. Valores válidos: off : dados em nível de usuário. on : ativa as estatísticas em nível de domínio.	on
DomainName	string	Não	O nome de domínio acelerado.	example.com

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	As informações de largura de banda.
RequestId	string	O ID da solicitação.	16A96B9A-F203-4EC5-8E43-CB92E68F****
DescribeUpPeakTraffics	object
DescribeUpPeakTraffic	array<object>	As informações de largura de banda upstream de pico diário.
	object	As informações de largura de banda upstream de pico diário.
QueryTime	string	The queried daily time. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2017-10-10T20:10:00Z
BandWidth	string	The daily peak upstream bandwidth.	777.2727083333333
StatName	string	The name of the statistical data attribute. If DomainSwitch is set to on, the live streaming domain name of the user is displayed. If DomainSwitch is set to off or is not specified, the user ID is displayed.	push-live.aliyuncs.com
PeakTime	string	The time when the daily peak upstream bandwidth occurs. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2017-10-10T20:10:00Z

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F****",
  "DescribeUpPeakTraffics": {
    "DescribeUpPeakTraffic": [
      {
        "QueryTime": "2017-10-10T20:10:00Z",
        "BandWidth": "777.2727083333333",
        "StatName": "push-live.aliyuncs.com",
        "PeakTime": "2017-10-10T20:10:00Z"
      }
    ]
  }
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidStartTime.Malformed	The specified StartTime is invalid.
400	InvalidEndTime.Malformed	Specified EndTime is malformed.
401	IllegalOperation	%s, please check and try again later.	Operation not allowed, please check and try again.
500	InternalError	%s, please try again later.	Internal error, please try again later.
404	InvalidCaster.NotFound	%s, please check and try again later.	The guide station does not exist, please check and try again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.