Consulta de estadísticas de uso de ancho de banda
Función
Consulta de estadísticas de uso de ancho de banda
URI
GET /v1/{project_id}/waf/overviews/bandwidth/timeline
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto |
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
enterprise_project_id |
No |
String |
ID del proyecto de empresa. Se puede obtener mediante el llamado API ListEnterpriseProject de EPS. |
|
from |
Sí |
Long |
Hora de inicio (marca de tiempo de 13 dígitos en milisegundos). Este parámetro debe usarse junto con to. |
|
to |
Sí |
Long |
Hora de finalización (marca de tiempo de 13 dígitos en milisegundos). Este parámetro debe usarse junto con from. |
|
hosts |
No |
String |
Lista de nombres de dominio a consultar, que se puede obtener llamando a la API** ListHost |
|
instances |
No |
String |
Lista de instancia a consultar (solo para el modo de instanciación). |
|
group_by |
No |
String |
Dimensión de visualización. Por ejemplo, el valor es DAY si los datos se muestran por día. |
Parámetros de solicitud
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API IAM (valor de X-Subject-Token en el encabezado de respuesta). |
|
Content-Type |
Sí |
String |
Tipo de contenido Predeterminado: application/json;charset=utf8 |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
[items] |
Array of StatisticsTimelineItem objects |
Cronología de las estadísticas de seguridad |
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
key |
String |
valor clave |
|
timeline |
Array of TimeLineItem objects |
Cronología correspondiente al valor de clave |
Código de estado: 400
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error |
|
error_msg |
String |
Mensaje de código de error |
Código de estad: 401
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error |
|
error_msg |
String |
Mensaje de código de error |
Código de estado: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error |
|
error_msg |
String |
Mensaje de código de error |
Solicitudes de ejemplo
GET https://{Endpoint}/v1/{project_id}/waf/overviews/bandwidth/timeline?enterprise_project_id=0&from=1650470400196&to=1650522936196
Ejemplo de respuestas
Código de estado: 200
ok
[ {
"key" : "IN_BANDWIDTH",
"timeline" : [ {
"time" : 1650470400000,
"num" : 0
} ]
}, {
"key" : "OUT_BANDWIDTH",
"timeline" : [ {
"time" : 1650470400000,
"num" : 0
} ]
}, {
"key" : "BANDWIDTH",
"timeline" : [ {
"time" : 1650470400000,
"num" : 0
} ]
} ]
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
ok |
|
400 |
Error de solicitud. |
|
401 |
Permisos de token insuficientes. |
|
500 |
Error de servidor interno. |
Códigos de error
Consulte Códigos de error.