DescribeUserBandWidthData - ENS: Central de Documentação do Alibaba Cloud

Consulta a largura de banda utilizada em um período de tempo especificado.

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

ens:DescribeUserBandWidthData

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
EnsRegionId	string	Não	O ID do nó. Você pode especificar apenas um ID de nó. Por padrão, todos os nós são consultados.	cn-taiyuan-telecom
InstanceId	string	Não	O ID da instância para a qual você deseja consultar os dados. Você pode especificar apenas um ID de instância. Por padrão, todas as instâncias são consultadas.	i-5inkeimcipxk26yqtzm4q****
StartTime	string	Sim	O início do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Se o valor dos segundos não for 00, a hora de início será automaticamente definida para o próximo minuto.	2019-05-21T10:22:00Z
EndTime	string	Sim	O fim do intervalo de tempo a ser consultado. Especifique a hora no padrão ISO 8601 no formato yyyy-MM-ddTHH:mm:ssZ. A hora deve estar em UTC. Se o valor dos segundos não for 00, a hora de início será automaticamente definida para o próximo minuto.	2019-05-21T12:22:00Z
Period	string	Sim	A precisão dos dados de monitoramento que você deseja obter. Valores válidos: 300, 1200, 3600 e 14400. Valor padrão: 300. Unidade: segundos.	300
Isp	string	Não	O provedor de serviços de Internet (ISP). Valores válidos: cmcc: China Mobile telecom: China Telecom unicom: China Unicom multiCarrier: ISP multilinha	cmcc

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Code	integer	O código de serviço retornado. 0 indica que a solicitação foi bem-sucedida.	0
MonitorData	object	Os dados de monitoramento.
BandWidthMonitorData	array<object>	Os dados de largura de banda.
	object
DownBandWidth	integer	The outbound bandwidth. Unit: bit/s.	0
InternetRX	integer	The Internet traffic to the instance. Unit: bytes.	0
InternetTX	integer	The Internet traffic from the instance. Unit: bytes.	0
TimeStamp	string	The timestamp when the monitoring data was queried. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2019-10-12T05:45:00Z
UpBandWidth	integer	The inbound bandwidth. Unit: bit/s.	0
MaxDownBandWidth	string	A largura de banda máxima de saída dentro do intervalo de tempo consultado. Unidade: bit/s.	16817468
MaxUpBandWidth	string	A largura de banda máxima de entrada dentro do intervalo de tempo consultado. Unidade: bit/s.	231008
RequestId	string	O ID da solicitação.	50373E71-7710-4620-8AAB-133CCE49451C

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": 0,
  "MonitorData": {
    "BandWidthMonitorData": [
      {
        "DownBandWidth": 0,
        "InternetRX": 0,
        "InternetTX": 0,
        "TimeStamp": "2019-10-12T05:45:00Z",
        "UpBandWidth": 0
      }
    ],
    "MaxDownBandWidth": "16817468",
    "MaxUpBandWidth": "231008"
  },
  "RequestId": "50373E71-7710-4620-8AAB-133CCE49451C"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	MissingParameter	The input parameters that is mandatory for processing this request is not supplied.
400	USERNOTFOUND	The user is not in ens-controller.	The current user has not registered with the edge node service or has not passed the user review.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.