Consulta de Terminales en Páginas
Descripción
Esta API es utilizada por un administrador de empresa para consultar terminales en páginas.
SLA
Tasa de éxito de solicitudes: > 99.99%
Retraso de la petición TP99: 64 ms
Depuración
Puede depurar esta API en API Explorer.
Prototipo
|
Método de solicitud |
GET |
|---|---|
|
Dirección de solicitud |
/v1/usg/dcs/corp/device |
|
Protocolo de transporte |
HTTPS |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Localización |
Descripción |
|---|---|---|---|---|
|
offset |
No |
Integer |
Query |
Desplazamiento de consulta. Si el valor excede el número máximo de registros disponibles, se devuelven los registros de la última página. |
|
limit |
No |
Integer |
Query |
Número de registros a consultar. Valor predeterminado: 10. |
|
searchKey |
No |
String |
Query |
Criterios de búsqueda. Se admite la búsqueda difusa por nombre y SN. |
|
model |
No |
String |
Query |
Modelo del dispositivo. El valor es un tipo enumerado. Actualmente, solo se admiten terminales duros de la serie TE. Puede obtener los modelos de terminal usando la API en Obtención de todos los modelos de terminal. maxLength: 128 minLength: 0 |
|
deptCode |
No |
String |
Query |
ID del departamento. El valor predeterminado es el departamento root. Valor predeterminado: 1. maxLength: 32 minLength: 0 |
|
enableSubDept |
No |
Boolean |
Query |
Si se debe consultar a los subdepartamentos. Valor predeterminado: true. |
|
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. |
|
X-Request-Id |
No |
String |
Header |
ID de solicitud, que se utiliza para el seguimiento y la localización de fallos. Se recomienda utilizar un UUID. Si este parámetro no se incluye, se genera automáticamente un ID de solicitud. |
|
Accept-Language |
No |
String |
Header |
Idioma. Valores: zh-CN para chino (predeterminado) y en-US para inglés. |
Códigos de estado
|
Código de estado de HTTP |
Descripción |
|---|---|
|
200 |
Operación exitosa. |
|
400 |
Parámetros inválidos. |
|
401 |
La autenticación no se realiza o falla. |
|
403 |
Permisos insuficientes. |
|
500 |
Excepción del servidor. |
Parámetros de respuesta
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
count |
Integer |
Número total de registros. |
|
limit |
Integer |
Número de registros mostrados por página. Valor predeterminado: 10. |
|
offset |
Integer |
Número de la página de inicio de la consulta. El valor comienza desde 0. |
|
data |
Array of QueryDeviceResultDTO objects |
Lista de terminales. |
Ejemplo de solicitud
GET /v1/usg/dcs/corp/device Connection: keep-alive X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF Content-Type: application/json Content-Length: 119 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: 481
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: 3df9b4a1b0f8e77050d27a858add946c
{
"offset": 0,
"limit": 10,
"count": 1,
"data": [
{
"name": "test",
"type": "TE",
"model": "TE20",
"sn": "asdasfscasd",
"account": "df8bce2178294683bb83a4985fef7165",
"number": "+991118029589",
"prjCodeMode": 0,
"deptCode": "1",
"deptName": "wangyue",
"deptNamePath": "wangyue",
"phone": "+86***********",
"country": "chinaPR",
"email": "test@huawei.com",
"description": "test",
"status": 0
}
]
}
Códigos de error
Si se devuelve un código de error que comienza con MMC o USG cuando utiliza 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: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device
