Este conteúdo foi traduzido por máquina para sua conveniência e a Huawei Cloud não pode garantir que o conteúdo foi traduzido com precisão. Para exibir o conteúdo original, use o link no canto superior direito para mudar para a página em inglês.
Central de ajuda/ Meeting/ Referência de API do servidor/ Painel de controle/ QoS de reunião/ APIs/ Consulta de QoS de um participante
Atualizado em 2023-08-02 GMT+08:00
Ver PDF

Consulta de QoS de um participante

Descrição

  • Esta API é usada para consultar os dados de QoS de um participante específico em uma empresa por áudio, vídeo, compartilhamento de tela e CPU. O período de medição é de 5 segundos.
  • Função de permissão = edição empresarial Premium/Standard + administrador

Depuração

Você pode depurar essa API no API Explorer.

Protótipo

Tabela 1 Protótipo

Método de solicitação

GET

Endereço de solicitação

/v1/metrics/conference/participant/qos

Protocolo de transporte

HTTPS

Parâmetros de solicitação

Tabela 2 Parâmetros

Parâmetro

Obrigatório

Tipo

Localização

Descrição

confUUID

Sim

String

Consulta

UUID da reunião. O valor contém até 64 bytes.

confType

Sim

String

Consulta

Tipo de reunião.

  • online: reunião em andamento.
  • history: reunião histórica.

participantID

Sim

String

Consulta

ID do participante. O valor contém até 64 bytes.

qosType

Sim

String

Consulta

Tipo de QoS.

  • audio
  • video
  • screen: compartilhamento de tela.
  • cpu

X-Access-Token

Sim

String

Cabeçalho

Token de autorização. Use o valor de accessToken na resposta à solicitação de Autenticação de um ID de aplicação.

Códigos de status

Tabela 3 Códigos de status

Código de status HTTP

Descrição

400

Solicitação inválida. Parâmetros inválidos.

401

Não autorizado. A autenticação não é realizada ou falha.

403

Proibido. Permissões insuficientes.

500

Exceção do servidor.

Parâmetros de resposta

Tabela 4 Parâmetros de resposta

Parâmetro

Tipo

Descrição

user

QosParticipantInfo object

Detalhes do participante.

qos

QosInfo object

Dados de QoS.
Tabela 5 Estrutura de dados QoSInfo

Parâmetro

Tipo

Descrição

type

String

Tipo de QoS.

  • audio
  • video
  • screen: compartilhamento de tela.
  • cpu

send

QosSendReceiveInfo object

Dados de QoS enviados pelo participante. Este parâmetro é válido somente quando qosType é definido como audio, video ou screen.

receive

QosSendReceiveInfo object

Dados de QoS recebidos pelo participante. Este parâmetro é válido somente quando qosType é definido como audio, video ou screen.

cpu

QosCpuInfo object

Dados de QoS da CPU do participante. Esse parâmetro é válido somente quando qosType é definido como cpu.

Tabela 6 Estrutura de dados QosSendReceiveInfo

Parâmetro

Tipo

Descrição

bitrate

Array of QosDataNoThrElement objects

Taxa de bits, em kbit/s. Nenhum alarme de limite será gerado. Este parâmetro é válido somente quando qosType é definido como audio, video ou screen.

latency

Array of QosDataElement objects

Atraso, em milissegundos. Alarmes de limite podem ser gerados. Este parâmetro é válido somente quando qosType é definido como audio, video ou screen.

jitter

Array of QosDataElement objects

Tremulação, em milissegundos. Alarmes de limite podem ser gerados. Este parâmetro é válido somente quando qosType é definido como audio, video ou screen.

packet_loss_max

Array of QosDataElement objects

Taxa máxima de perda de pacotes, em porcentagem. Alarmes de limite podem ser gerados. Este parâmetro é válido somente quando qosType é definido como audio, video ou screen.

resolution

Array of QosDataNoThrElement objects

Resolução. Nenhum alarme de limite será gerado. Este parâmetro é válido somente quando qosType é definido como video ou screen.

frame

Array of QosDataNoThrElement objects

Taxa de quadros, em fps. Nenhum alarme de limite será gerado. Este parâmetro é válido somente quando qosType é definido como video ou screen.
Tabela 7 Estrutura de dados QoSCpuInfo

Parâmetro

Tipo

Descrição

client_cpu_max

Array of QosDataElement objects

Uso máximo da CPU do cliente do Huawei Cloud Meeting.

system_cpu_max

Array of QosDataElement objects

Máximo uso da CPU do sistema.
Tabela 8 Estrutura de dados QosDataNoThrElement

Parâmetro

Tipo

Descrição

time

String

Ponto de tempo de QoS (hora UTC). Formato: yyyy-MM-ddTHH:mm:ss.SSSZ.

value

String

Valor de QoS.
Tabela 9 Estrutura de dados QoSDataElement

Parâmetro

Tipo

Descrição

time

String

Ponto de tempo de QoS (hora UTC). Formato: yyyy-MM-ddTHH:mm:ss.SSSZ.

value

Integer

Valor de QoS.

alarm

Boolean

Se um alarme de limiar é gerado no ponto de tempo. true: sim. false: não.

threshold

Integer

Limite no ponto de tempo.

Exemplo de solicitação

GET /v1/metrics/conference/participant/qos?confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&participantID=kxxwoo5hmo9khlmggklawbwiwfl999bw&qosType=video
Connection: keep-alive
X-Access-Token: stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC
user-agent: WeLink-desktop
Host: api.meeting.huaweicloud.com
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Exemplo de resposta

HTTP/1.1 200
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 2450
Connection: keep-alive
Expires: 0
Pragma: No-cache
Cache-Control: no-cache
http_proxy_id: 6fba0eff9f832b463580fb06c5b0ff9c
Server: api-gateway
X-Request-Id: ac9f75ec3c97c823f128526a924532b2
{
	"user": {
		"confUUID": "a3d9a31c8af211eb8075a12479434adb",
		"conferenceID": "98909587",
		"participantID": "kxxwoo5hmo9khlmggklawbwiwfl999bw",
		"userUUID": "ff80808167ef1edf0167f339533d05a6",
		"displayName": "Shenzhen Branch",
		"deptName": "XXXXX",
		"terminalType": "PC",
		"role": "host",
		"ipAddress": "***.***.**.**",
		"country": "China",
		"province": "Sichuan",
		"city": "Chengdu",
		"appVersion": "60.15.5",
		"joinTime": 1618220940926,
		"leftTime": 1618221194202,
		"systemInfo": "android-11",
		"networkType": "wifi",
		"alarm": "YES",
		"audioAlarmSend": "YES",
		"videoAlarmSend": "NO",
		"screenAlarmSend": "NO",
		"audioAlarmRec": "YES",
		"videoAlarmRec": "YES",
		"screenAlarmRec": "NO",
		"cpuAlarm": "NO",
		"microphoneInfo": "Microphone Array (Realtek(R) Audio)",
		"speakerInfo": "Speakers/Headphones (Realtek(R) Audio)",
		"cameraInfo": "Lenovo EasyCamera",
		"dataCenter": "Region-China-2",
		"leftReason": 0
	},
	"qos": {
		"type": "video",
		"send": {
			"bitrate": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000
			}],
			"latency": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000,
				"alarm": true,
				"threshold": 700
			}],
			"jitter": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000,
				"alarm": true,
				"threshold": 700
			}],
			"packet_loss_max": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000,
				"alarm": true,
				"threshold": 700
			}],
			"resolution": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000
			}],
			"frame": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000
			}]
		},
		"receive": {
			"bitrate": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000
			}],
			"latency": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000,
				"alarm": true,
				"threshold": 700
			}],
			"jitter": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000,
				"alarm": true,
				"threshold": 700
			}],
			"packet_loss_max": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000,
				"alarm": true,
				"threshold": 700
			}],
			"resolution": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000
			}],
			"frame": [{
				"time": "2021-04-16T01:18:23.404Z",
				"value": 1000
			}]
		}
	}
}

Códigos de erro

Se um código de erro começando com MBI for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas no Centro de erros da API da Huawei Cloud.

Exemplo de comando cURL

curl -k -i -X GET -H 'X-Access-Token:stbX5ElstO5QwOwPB9KGQWUZ1DHoFrTsQjjC' -d 'confUUID=a3d9a31c8af211eb8075a12479434adb&confType=history&participantId=kxxwoo5hmo9khlmggklawbwiwfl999bw&qosType=video' https://api.meeting.huaweicloud.com/v1/metrics/conference/participant/qos

Tópico principal: APIs