Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Meeting/ Referencia de la API del servidor/ Panel de control/ QoS de reunión/ APIs/ Consulta de QoS de un participante

Actualización más reciente 2023-01-31 GMT+08:00

Ver PDF

Consulta de QoS de un participante

Descripción

Esta API se utiliza para consultar los datos de QoS de un participante específico en una empresa mediante audio, vídeo, uso compartido de pantalla y CPU. El período de medición es de 5 segundos.
Rol de permisos = Empresa de edición Premium/Standard + Administrador

Depuración

Puede depurar esta API en API Explorer.

Prototipo

**Tabla 1** Prototipo
Método de solicitud	GET
Dirección de solicitud	/v1/metrics/conference/participant/qos
Protocolo de transporte	HTTPS

Parámetros de solicitud

**Tabla 2** Parámetros
Parámetro	Obligatorio	Tipo	Localización	Descripción
confUUID	Sí	String	Query	Reunión de UUID. El valor contiene hasta 64 bytes.
confType	Sí	String	Query	Tipo de reunión. en línea: reunión en curso. historia: reunión histórico.
participantID	Sí	String	Query	ID de participante. El valor contiene hasta 64 bytes.
qosType	Sí	String	Query	Tipo de Qos. audio video screen: compartición de pantalla. cpu
X-Access-Token	Sí	String	Header	Token de autorización. Utilice el valor de accessToken en la respuesta a la solicitud de Autenticación de un ID de aplicación.

Códigos de estado

**Tabla 3** Códigos de estado
Código de estado de HTTP	Descripción
400	Solicitud incorrecta. Parámetros no válidos.
401	No autorizado. La autenticación no se realiza o falla.
403	Prohibido. Permisos insuficientes.
500	Excepción del servidor.

Parámetros de respuesta

**Tabla 4** Parámetros de respuesta
Parámetro	Tipo	Descripción
user	QosParticipantInfo object	Detalles del participante.
qos	QosInfo object	Dato de Qos.

**Tabla 5** Estructura de datos QoSInfo
Parámetro	Tipo	Descripción
type	String	Tipo de Qos. audio video screen: compartición de pantalla. cpu
send	QosSendReceiveInfo object	Datos QoS enviados por el participante. Este parámetro sólo es válido cuando qosType se establece en audio, vídeo o screen.
receive	QosSendReceiveInfo object	Datos de QoS recibidos por el participante. Este parámetro sólo es válido cuando qosType se establece en audio, vídeo o screen.
cpu	QosCpuInfo object	Datos de QoS de la CPU del participante. Este parámetro solo es válido cuando qosType se establece en cpu.

**Tabla 6** Estructura de datos de QosSendReceiveInfo
Parámetro	Tipo	Descripción
bitrate	Array of QosDataNoThrElement objects	Velocidad de bits, en kbit/s. No se generará ninguna alarma de umbral. Este parámetro sólo es válido cuando qosType se establece en audio, vídeo o screen.
latency	Array of QosDataElement objects	Retraso, en milisegundos. Pueden generarse alarmas umbral. Este parámetro sólo es válido cuando qosType se establece en audio, vídeo o screen.
jitter	Array of QosDataElement objects	Fluctuación, en milisegundos. Pueden generarse alarmas umbral. Este parámetro sólo es válido cuando qosType se establece en audio, vídeo o screen.
packet_loss_max	Array of QosDataElement objects	Tasa máxima de pérdida de paquetes, en porcentaje. Pueden generarse alarmas umbral. Este parámetro sólo es válido cuando qosType se establece en audio, vídeo o screen.
resolution	Array of QosDataNoThrElement objects	Resolución. No se generará ninguna alarma de umbral. Este parámetro sólo es válido cuando qosType se establece en vídeo o screen.
frame	Array of QosDataNoThrElement objects	Velocidad de fotogramas, en fps. No se generará ninguna alarma de umbral. Este parámetro sólo es válido cuando qosType se establece en vídeo o screen.

**Tabla 7** Estructura de datos de QoSCpuInfo
Parámetro	Tipo	Descripción
client_cpu_max	Array of QosDataElement objects	Uso máximo de la CPU del cliente de Huawei Cloud Meeting.
system_cpu_max	Array of QosDataElement objects	Máximo uso de CPU del sistema.

**Tabla 8** Estructura de datos de QosDataNoThrElement
Parámetro	Tipo	Descripción
time	String	Punto de tiempo de QoS (tiempo UTC). Formato: aaaa-MM-ddTHH:mm:ss.SSSZ.
value	String	Valor de Qos.

**Tabla 9** Estructura de datos QoSDataElement
Parámetro	Tipo	Descripción
time	String	Punto de tiempo de QoS (tiempo UTC). Formato: aaaa-MM-ddTHH:mm:ss.SSSZ.
value	Integer	Valor de Qos.
alarm	Boolean	Si se genera una alarma de umbral en el punto de tiempo. true: sí. false: no.
threshold	Integer	Umbral en el punto de tiempo.

Ejemplo de solicitud

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)

Ejemplo de respuesta

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 error

Si se devuelve un código de error que comienza con MBI cuando usa esta API, corrija el error siguiendo las instrucciones proporcionadas en Centro de errores de la API de Huawei Cloud.

Ejemplo 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

Tema principal: APIs

Tema anterior: Consulta de QoS de participantes en una reunión

Tema siguiente: Consulta de umbrales de alarma QoS