Consulta de materiales del tablón de anuncios en páginas
Descripción
Esta API se utiliza para consultar materiales de tablones de anuncios en las páginas.
Depuración
Puede depurar esta API en Explorador de API.
Prototipo
Método de solicitud |
GET |
|---|---|
Dirección de solicitud |
/v1/usg/sss/materials |
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. Valor predeterminado: 0. |
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 de material y actualizador. |
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 el chino (predeterminado) y en-US para el inglés. |
Códigos de estado
Código de estado de HTTP |
Descripción |
|---|---|
200 |
Operación exitosa. |
400 |
Parámetros no vá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 Material objects |
Detalles del material. |
Parámetro |
Tipo |
Descripción |
|---|---|---|
filePath |
String |
URL para descargar el material de Clouddrive. |
id |
String |
ID del material. |
lastUpdatedBy |
String |
Actualizador. |
materialName |
String |
Nombre del material. |
materialResolution |
String |
Resolución de materiales. |
materialSizeStr |
String |
Tamaño del material (incluida la unidad). |
updateTime |
Long |
Hora de actualización. |
Solicitud de ejemplo
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)
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: 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 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 el Centro de errores de la API de Huawei Cloud.
Ejemplo 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
