Consulta de programas de tablón de anuncios
Descripción
Esta API se utiliza para consultar programas de tablones de anuncios.
Depuración
Puede depurar esta API en Explorador de API.
Prototipo
|
Método de solicitud |
GET |
|---|---|
|
Dirección de solicitud |
/v1/usg/sss/programs |
|
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 programa 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 ProgramResponseBase objects |
Detalles del programa. |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID del programa. |
|
lastUpdatedBy |
String |
Actualizador. |
|
materialSizeStr |
String |
Tamaño total de los materiales del programa (incluida la unidad). |
|
playTime |
Integer |
Duración total de la reproducción de un programa, en segundos. |
|
programName |
String |
Nombre de programa. |
|
updateTime |
Long |
Hora de actualización. |
Solicitud de ejemplo
GET /v1/usg/sss/programs?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: a4facce44898sda03629afd189da71df
{
"count": 1,
"data": {
"id": "e36e633ccaee4cd0a6ffda6b6a65473c",
"lastUpdatedBy": "",
"materialSizeStr": "462.71KB",
"playTime": 10,
"programName": "VCpBgDe4IM",
"updateTime": 1593538222443
},
"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/publications?offset=0&limit=10
