Consulta de terminais em páginas
Descrição
Esta API é usada por um administrador empresarial para consultar terminais em páginas.
SLA
Taxa de sucesso de solicitação: > 99,99%
Atraso na solicitação TP99: 64 ms
Depuração
Você pode depurar essa API no API Explorer.
Protótipo
|
Método de solicitação |
GET |
|---|---|
|
Endereço de solicitação |
/v1/usg/dcs/corp/device |
|
Protocolo de transporte |
HTTPS |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Localização |
Descrição |
|---|---|---|---|---|
|
offset |
Não |
Integer |
Consulta |
Deslocamento de consulta Se o valor exceder o número máximo de registros disponíveis, os registros na última página serão retornados. |
|
limit |
Não |
Integer |
Consulta |
Número de registros para consultar. Valor padrão: 10. |
|
searchKey |
Não |
String |
Consulta |
Critérios de pesquisa. Pesquisa difusa por nome e SN é suportada. |
|
model |
Não |
String |
Consulta |
Modelo do dispositivo. O valor é um tipo enumerado. Atualmente, apenas os terminais rígidos da série TE são suportados. Você pode obter os modelos de terminal usando a API em Obtenção de todos os modelos de terminal. maxLength: 128 minLength: 0 |
|
deptCode |
Não |
String |
Consulta |
ID do departamento. O valor padrão é o departamento raiz. Valor padrão: 1. maxLength: 32 minLength: 0 |
|
enableSubDept |
Não |
Boolean |
Consulta |
Se consultar subdepartamentos. Valor padrão: true. |
|
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. |
|
X-Request-Id |
Não |
String |
Cabeçalho |
ID da solicitação, que é usado para rastreamento e localização de falhas. É aconselhável usar um UUID. Se este parâmetro não for transportado, um ID de solicitação é gerado automaticamente. |
|
Accept-Language |
Não |
String |
Cabeçalho |
Idioma. Valores: zh-CN para chinês (padrão) e en-US para inglês. |
Códigos de status
|
Código de status HTTP |
Descrição |
|---|---|
|
200 |
Operação bem-sucedida. |
|
400 |
Parâmetros inválidos. |
|
401 |
A autenticação não é executada ou falha. |
|
403 |
Permissões insuficientes. |
|
500 |
Exceção do servidor. |
Parâmetros de resposta
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
count |
Integer |
Número total de registros. |
|
limit |
Integer |
Número de registros exibidos por página. Valor padrão: 10. |
|
offset |
Integer |
Número da página inicial da consulta. O valor começa em 0. |
|
data |
Array of QueryDeviceResultDTO objects |
Lista de terminais. |
Exemplo de solicitação
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)
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: 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 erro
Se um código de erro começando com MMC ou USG for retornado quando você usar essa API, corrija a falha seguindo as instruções fornecidas na Centro de erros da API da Huawei Cloud.
Exemplo de comando cURL
curl -k -i -X GET -H 'X-Access-Token: stbVbWSIgzfOQ8JnbmPIoBIR3ig8xnVScQOF' https://api.meeting.huaweicloud.com/v1/usg/dcs/corp/device
