Consulta de materiais do quadro de avisos em páginas
Descrição
Esta API é usada para consultar materiais do quadro de avisos em páginas.
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/sss/materials |
|
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. Valor padrão: 0. |
|
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 de material e atualizador é suportada. |
|
X-Access-Token |
Yes |
Cadeia |
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 Material objects |
Detalhes do material. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
filePath |
String |
URL para baixar o material do Clouddrive. |
|
id |
String |
ID do material. |
|
lastUpdatedBy |
String |
Atualizador. |
|
materialName |
String |
Nome do material. |
|
materialResolution |
String |
Resolução do material. |
|
materialSizeStr |
String |
Tamanho do material (incluindo a unidade). |
|
updateTime |
Long |
Hora da atualização. |
Exemplo de solicitação
GET /v1/usg/sss/materials?offset=0&limit=5&searchKey= Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE Content-Type: application/json 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: 1329
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: b4facce44898efa03629afd189da7f5f
{
"count": 1,
"data": {
"filePath": "https://mock/download-file",
"id": "835fe0052b2b4cc0ae1704fddad9e683",
"lastUpdatedBy": "",
"materialName": "test",
"materialResolution": "",
"materialSizeStr": "462.71KB",
"updateTime": "1551755880176"
},
"limit": 5,
"offset": 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 no Centro de erros da API da Huawei Cloud.
Exemplo de comando cURL
curl -k -i -X GET -H 'X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE' https://api.meeting.huaweicloud.com/v1/usg/sss/materials?offset=0&limit=5
